Skip to content

Import a runbook as a draft that waits for the owner's approval

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/procedures/import
curl --request POST \  --url https://api.xovris.ai/v1/procedures/import \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "name": null, "runbook": null, "source": "string" }'

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

Media typeapplication/json
object
name
runbook
source
string

Example

{  "name": null,  "runbook": null,  "source": "string"}

Done.

Media typeapplication/json
object
next
required
string
imported
required
boolean
procedureId
required
string
version
required
number
unchanged
required
boolean
state
required
string
Allowed values: candidate
diff
required
Array
One of:
object
change
required
string
Allowed values: removed added
step
required
object
title
required
string
action
string
params
object
key
additional properties
One of:
string
at
required
number
redacted
required
number
why
required
string

Example

{  "next": "string",  "imported": true,  "procedureId": "string",  "version": 1,  "unchanged": true,  "state": "candidate",  "diff": [    {      "change": "removed",      "step": {        "title": "string",        "action": "string",        "params": {}      },      "at": 1    }  ],  "redacted": 1,  "why": "string"}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
next
required
string
imported
required
boolean
procedureId
required
string
version
required
number
unchanged
required
boolean
state
required
string
Allowed values: candidate
diff
required
Array
One of:
object
change
required
string
Allowed values: removed added
step
required
object
title
required
string
action
string
params
object
key
additional properties
One of:
string
at
required
number
redacted
required
number
why
required
string

Example

{  "next": "string",  "imported": true,  "procedureId": "string",  "version": 1,  "unchanged": true,  "state": "candidate",  "diff": [    {      "change": "removed",      "step": {        "title": "string",        "action": "string",        "params": {}      },      "at": 1    }  ],  "redacted": 1,  "why": "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.