Skip to content

See what a GitHub connection can do and what it needs

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/connections/{id}/github
curl --request GET \  --url https://api.xovris.ai/v1/connections/example/github \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
connectionId
required
string
installation
required
One of:
object
account
required
string
repositories
required
Array<string>
installedAt
required
string
consent
required
One of:
object
repository
required
One of:
string
grantedBy
required
string
grantedAt
required
string
textVersion
required
string
consentText
required
One of:
object
version
required
string
text
required
string
pullRequest
required
One of:
object
repository
required
string
number
required
number
url
required
string
branch
required
string
base
required
string
state
required
string
Allowed values: open closed draft merged
headSha
required
string
checks
required
One of:
object
total
required
number
passed
required
number
failed
required
number
pending
required
number
readAt
required
string
changes
required
Array<object>
object
path
required
string
kind
required
string
Allowed values: created edited
why
required
string
filesRead
required
Array<string>
lockfile
required
string
Allowed values: unchanged refreshed needs_refresh
path
required
string
Allowed values: ci signup interactive
openedAt
required
string
readBackAt
required
string
mergedAt
required
One of:
string
closedAt
required
One of:
string
branchDeletedAt
required
One of:
string
next
required
string
next
required
string

Example

{  "connectionId": "string",  "installation": {    "account": "string",    "repositories": [      "string"    ],    "installedAt": "string"  },  "consent": {    "repository": "string",    "grantedBy": "string",    "grantedAt": "string",    "textVersion": "string"  },  "consentText": {    "version": "string",    "text": "string"  },  "pullRequest": {    "repository": "string",    "number": 1,    "url": "string",    "branch": "string",    "base": "string",    "state": "open",    "headSha": "string",    "checks": {      "total": 1,      "passed": 1,      "failed": 1,      "pending": 1,      "readAt": "string"    },    "changes": [      {        "path": "string",        "kind": "created",        "why": "string"      }    ],    "filesRead": [      "string"    ],    "lockfile": "unchanged",    "path": "ci",    "openedAt": "string",    "readBackAt": "string",    "mergedAt": "string",    "closedAt": "string",    "branchDeletedAt": "string",    "next": "string"  },  "next": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.