Skip to content

Read the integration programme

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/public/integration-programme
curl --request GET \  --url https://api.xovris.ai/v1/public/integration-programme

No token needed: anyone may call this.

Done.

Media typeapplication/json
object
counts
required
object
services
required
number
ready
required
number
installTested
required
number
listed
required
number
states
required
Array<object>
object
state
required
string
Allowed values: ready listed install_tested
means
required
string
count
required
number
lastRun
required
One of:
object
id
required
string
startedAt
required
string
finishedAt
required
One of:
string
trigger
required
string
installs
required
object
ran
required
number
passed
required
number
roundTrips
required
object
ran
required
number
passed
required
number
computedAt
required
string

Example

{  "counts": {    "services": 1,    "ready": 1,    "installTested": 1,    "listed": 1  },  "states": [    {      "state": "ready",      "means": "string",      "count": 1    }  ],  "lastRun": {    "id": "string",    "startedAt": "string",    "finishedAt": "string",    "trigger": "string",    "installs": {      "ran": 1,      "passed": 1    },    "roundTrips": {      "ran": 1,      "passed": 1    }  },  "computedAt": "string"}

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.