Skip to content

Save an on-call schedule

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/oncall/schedules
curl --request POST \  --url https://api.xovris.ai/v1/oncall/schedules \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "id": "string", "name": "string", "timeZone": "string", "layers": [ { "id": "string", "name": "string", "members": [ "string" ], "startsAt": "string", "handoff": { "every": "week", "count": 1 }, "restrictions": [ { "days": [ 1 ], "start": "string", "end": "string" } ], "endsAt": "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
id
string
name
string
timeZone
string
layers
Array<object>
object
id
required
string
name
required
string
members
required
Array<string>
startsAt
required
string
handoff
required
One of:
object
every
required
string
Allowed values: week day
count
number
restrictions
Array<object>
object
days
required
Array<number>
start
required
string
end
required
string
endsAt
One of:
string

Example

{  "id": "string",  "name": "string",  "timeZone": "string",  "layers": [    {      "id": "string",      "name": "string",      "members": [        "string"      ],      "startsAt": "string",      "handoff": {        "every": "week",        "count": 1      },      "restrictions": [        {          "days": [            1          ],          "start": "string",          "end": "string"        }      ],      "endsAt": "string"    }  ]}

Done.

Media typeapplication/json
object

Example generated

{}

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

Media typeapplication/json
object
id
required
string

Example

{  "id": "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.