Skip to main content
POST
Verify GitHub installation

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
projectId
string
required
Minimum string length: 1
repositoryOwner
string
required
Minimum string length: 1
repositoryName
string
required
Minimum string length: 1

Response

Verification result

isInstalled
boolean
required
installationId
number | null
required
repositoryExists
boolean | null
required
repositoryPrivate
boolean | null
required
permissions
object | null
required

The permissions the installation currently grants.

hasRequiredPermissions
boolean
required
missingPermissions
string[]
required

Permissions that must be granted before the link will work.

message
string
required

A human-readable summary to show the user.

settingsUrl
string

Where to adjust the installation, when one exists.

installationUrl
string

Where to install the App, when it is not installed yet.