Skip to content
GitHub

Link a GitHub App installation to the caller's organization. GitHub is asked first; an installation stays with the organization that linked it.

POST
/api/v1/git/installations
curl --request POST \
  --url https://example.com/api/v1/git/installations \
  --header 'Content-Type: application/json' \
  --data '{ "installationId": 1 }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
installationId
required

The id GitHub shows after the App is installed.

integer format: int64
Examplegenerated
{
  "installationId": 1
}

Responses

Section titled “Responses”

201

Section titled “201”
Media typeapplication/json
object
installationId
required
integer format: int64
account
required

The GitHub user or organization the App is installed on.

string
suspended
required
boolean
Examplegenerated
{
  "installationId": 1,
  "account": "example",
  "suspended": true
}

403

Section titled “403”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

409

Section titled “409”

Linked to another organization

Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

422

Section titled “422”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

503

Section titled “503”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}