Skip to content

Choose what happens next on an incident

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.

POST
/v1/incidents/{id}/choice
curl --request POST \  --url https://api.xovris.ai/v1/incidents/example/choice \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "choice": null, "from": null, "packageDigest": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object
choice
from
packageDigest

Example

{  "choice": null,  "from": null,  "packageDigest": null}

Done.

Media typeapplication/json
object
level
object
needed
required
string
Allowed values: observe propose approve automatic
have
required
string
Allowed values: observe propose approve automatic
raise
required
object
method
required
string
Allowed values: PUT
path
required
string
Allowed values: /v1/access/level
body
required
object
level
required
string
Allowed values: observe propose approve automatic
connection
string
setting
string
choice
required
string
Allowed values: fix_it call_me show_first handle_it
effective
required
string
Allowed values: running awaiting_approval stood_down not_available
why
required
string
next
required
string
decisionId
required
string
timelineSeq
required
number

Example

{  "level": {    "needed": "observe",    "have": "observe",    "raise": {      "method": "PUT",      "path": "/v1/access/level",      "body": {        "level": "observe",        "connection": "string"      }    }  },  "setting": "string",  "choice": "fix_it",  "effective": "running",  "why": "string",  "next": "string",  "decisionId": "string",  "timelineSeq": 1}

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.