Skip to main content
POST
Preview GitHub installation

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Scopes

openid

OpenID Connect identity.

profile

Name and profile claims.

email

Email address.

offline_access

Refresh token.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

code
string
required

The OAuth code GitHub handed back after an install started on GitHub.

Required string length: 1 - 512
installationId
integer
required

The installation_id GitHub handed back with it.

Required range: x <= 9007199254740991

Response

Preview GitHub installation

installation
Installation · object
required

The installation the caller owns the account of. Linking it takes its ID within 15 minutes, by the same caller.