Skip to content

Read the grants, standing permissions, kill switches and approvals in force

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

A token that can read is enough.

Done.

Media typeapplication/json
object
waiting
required
number
grants
required
Array<object>
object
id
required
string
provider
required
string
Allowed values: cloudflare route53
grantKind
required
string
Allowed values: oauth zone_token cloud_role
zoneIds
required
Array<string>
scopes
required
Array<string>
capability
required
string
Allowed values: can_repair watch_only
missingScopes
required
Array<string>
standingPolicies
required
Array<object>
object
id
required
actionClass
required
zoneId
required
notifyOnUse
required
createdAt
required
One of:
string
killSwitches
required
Array<object>
object
scope
required
string
actionClass
required
One of:
string
engaged
required
boolean
actor
required
string
reason
required
string
at
required
One of:
string
killSwitchHistory
required
Array<object>
object
scope
required
actionClass
required
engaged
required
actor
required
reason
required
at
required
One of:
string
changeWindows
required
Array<object>
object
id
required
kind
required
zoneId
required
startsAt
required
One of:
string
endsAt
required
One of:
string
reason
required
approvals
required
Array<object>
object
id
required
kind
required
subjectId
required
status
required
createdAt
required
One of:
string
title
required
One of:
string
runs
required
Array<object>
object
id
required
string
incidentId
required
string
actionId
required
string
state
required
string
outcome
required
One of:
string
title
required
string
statusLine
required
string
verification
required
One of:
Array<object>
object
state
string
createdAt
required
One of:
string
updatedAt
required
One of:
string
held
required
Array<object>
object
id
required
string
incidentId
required
string
actionId
required
string
state
required
string
outcome
required
One of:
string
title
required
string
statusLine
required
string
verification
required
One of:
Array<object>
object
state
string
createdAt
required
One of:
string
updatedAt
required
One of:
string

Example

{  "waiting": 1,  "grants": [    {      "id": "string",      "provider": "cloudflare",      "grantKind": "oauth",      "zoneIds": [        "string"      ],      "scopes": [        "string"      ],      "capability": "can_repair",      "missingScopes": [        "string"      ]    }  ],  "standingPolicies": [    {      "id": null,      "actionClass": null,      "zoneId": null,      "notifyOnUse": null,      "createdAt": "string"    }  ],  "killSwitches": [    {      "scope": "string",      "actionClass": "string",      "engaged": true,      "actor": "string",      "reason": "string",      "at": "string"    }  ],  "killSwitchHistory": [    {      "scope": null,      "actionClass": null,      "engaged": null,      "actor": null,      "reason": null,      "at": "string"    }  ],  "changeWindows": [    {      "id": null,      "kind": null,      "zoneId": null,      "startsAt": "string",      "endsAt": "string",      "reason": null    }  ],  "approvals": [    {      "id": null,      "kind": null,      "subjectId": null,      "status": null,      "createdAt": "string",      "title": "string"    }  ],  "runs": [    {      "id": "string",      "incidentId": "string",      "actionId": "string",      "state": "string",      "outcome": "string",      "title": "string",      "statusLine": "string",      "verification": [        {          "state": "string"        }      ],      "createdAt": "string",      "updatedAt": "string"    }  ],  "held": [    {      "id": "string",      "incidentId": "string",      "actionId": "string",      "state": "string",      "outcome": "string",      "title": "string",      "statusLine": "string",      "verification": [        {          "state": "string"        }      ],      "createdAt": "string",      "updatedAt": "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.