Skip to content

Read each automation rule's runs, rates and median time over a range

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

A token that can read is enough.

Done.

Media typeapplication/json
object
range
required
object
hours
required
number
since
required
string
until
required
string
buckets
required
number
rules
required
Array<object>
object
actionClass
required
string
title
required
One of:
string
policy
required
One of:
object
id
required
string
zoneId
required
One of:
string
notifyOnUse
required
boolean
createdAt
required
string
buckets
required
Array<number>
failedBuckets
required
Array<number>
before
required
object
runs
required
number
finished
required
number
succeeded
required
number
proved
required
number
failed
required
number
medianMs
required
One of:
number
recent
required
Array<object>
object
id
required
string
incidentId
required
string
title
required
string
state
required
string
outcome
required
One of:
string
at
required
string
held
required
object
runs
required
number
waitedMs
required
number
proved
required
number
runs
required
number
finished
required
number
succeeded
required
number
proved
required
number
failed
required
number

Example

{  "range": {    "hours": 1,    "since": "string",    "until": "string",    "buckets": 1  },  "rules": [    {      "actionClass": "string",      "title": "string",      "policy": {        "id": "string",        "zoneId": "string",        "notifyOnUse": true,        "createdAt": "string"      },      "buckets": [        1      ],      "failedBuckets": [        1      ],      "before": {        "runs": 1,        "finished": 1,        "succeeded": 1,        "proved": 1,        "failed": 1      },      "medianMs": 1,      "recent": [        {          "id": "string",          "incidentId": "string",          "title": "string",          "state": "string",          "outcome": "string",          "at": "string"        }      ],      "held": {        "runs": 1,        "waitedMs": 1,        "proved": 1      },      "runs": 1,      "finished": 1,      "succeeded": 1,      "proved": 1,      "failed": 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.