Skip to content

Read what a connection lets Xovris do

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}/capabilities
curl --request GET \  --url https://api.xovris.ai/v1/connections/example/capabilities \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
repairs
required
Array<object>
object
enabled
required
boolean
missing
required
Array<string>
reason
required
string
Allowed values: ok revoked stale not_connected missing_scope
next
required
string
repairClass
required
string
title
required
string
acted
required
One of:
Array<object>
object
runId
required
string
incidentId
required
string
incidentTitle
required
One of:
string
actionId
required
string
state
required
string
outcome
required
One of:
string
at
required
string
stops
required
One of:
object
automations
required
Array<object>
object
id
required
string
actionClass
required
string
zone
required
One of:
string
since
required
string
checks
required
Array<object>
object
id
required
string
name
required
One of:
string
target
required
string
fixes
required
Array<object>
object
repairClass
required
string
title
required
string
connectionId
required
string
provider
required
string
Allowed values: github slack vercel cloudflare
badges
required
Array<object>
object
capability
required
string
Allowed values: watch receive_events dns_record_edit deploy_env_write post_messages
label
required
string
scopes
required
Array<string>
on
required
Array<string>
read
required
Array<object>
object
scope
required
string
label
required
string
known
required
boolean
write
required
Array<object>
object
scope
required
string
label
required
string
known
required
boolean
extraReach
required
Array<object>
object
id
required
string
name
required
string
introspectedAt
required
string
stale
required
boolean
revoked
required
boolean

Example

{  "repairs": [    {      "enabled": true,      "missing": [        "string"      ],      "reason": "ok",      "next": "string",      "repairClass": "string",      "title": "string"    }  ],  "acted": [    {      "runId": "string",      "incidentId": "string",      "incidentTitle": "string",      "actionId": "string",      "state": "string",      "outcome": "string",      "at": "string"    }  ],  "stops": {    "automations": [      {        "id": "string",        "actionClass": "string",        "zone": "string",        "since": "string"      }    ],    "checks": [      {        "id": "string",        "name": "string",        "target": "string"      }    ],    "fixes": [      {        "repairClass": "string",        "title": "string"      }    ]  },  "connectionId": "string",  "provider": "github",  "badges": [    {      "capability": "watch",      "label": "string",      "scopes": [        "string"      ],      "on": [        "string"      ]    }  ],  "read": [    {      "scope": "string",      "label": "string",      "known": true    }  ],  "write": [    {      "scope": "string",      "label": "string",      "known": true    }  ],  "extraReach": [    {      "id": "string",      "name": "string"    }  ],  "introspectedAt": "string",  "stale": true,  "revoked": true}

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.