Skip to content

Read, set beside Xovris and import your PagerDuty on-call set-up - with the read-only access PagerDuty's approval grants, or a read-only key

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/import/pagerduty
curl --request POST \  --url https://api.xovris.ai/v1/oncall/import/pagerduty \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "mode": "string", "bundle": null, "opsgenie": { "apiKey": "string", "region": "string" }, "pagerduty": { "apiKey": "string", "region": "string", "grant": "string" }, "splunk": { "apiId": "string", "apiKey": "string" }, "days": 1, "undo": true, "acceptDifferences": true }'

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
mode
string
bundle
opsgenie
object
apiKey
string
region
string
pagerduty
object
apiKey
string
region
string
grant
string
splunk
object
apiId
string
apiKey
string
days
number
undo
boolean
acceptDifferences
boolean

Example

{  "mode": "string",  "bundle": null,  "opsgenie": {    "apiKey": "string",    "region": "string"  },  "pagerduty": {    "apiKey": "string",    "region": "string",    "grant": "string"  },  "splunk": {    "apiId": "string",    "apiKey": "string"  },  "days": 1,  "undo": true,  "acceptDifferences": true}

Done.

Media typeapplication/json
object

Example generated

{}

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

Media typeapplication/json
object
routes
required
Array<string>
windows
required
Array<string>
teams
required
Array<object>
object
name
required
string
members
required
number
notYetMembers
required
Array<string>
pingers
required
One of:
object
moved
required
Array
said
required
One of:
string
phones
required
Array<object>
object
name
required
string
phone
required
string
kinds
required
Array<string>
texted
required
boolean
why
required
One of:
string
heartbeats
required
Array<object>
object
name
required
string
id
required
string
slug
required
string
pingUrl
required
string
everyMinutes
required
number
paused
required
boolean
integrations
required
Array<object>
object
id
required
string
tool
required
string
toolName
required
string
webhookUrl
required
One of:
string
emailAddress
required
One of:
string
secret
required
One of:
string
paused
required
boolean
name
required
string
opsgenieType
required
string
opsgenieId
required
string
counts
required
object
heartbeat
required
object
found
required
number
carried
required
number
user
required
object
found
required
number
carried
required
number
maintenance
required
object
found
required
number
carried
required
number
integration
required
object
found
required
number
carried
required
number
escalation
required
object
found
required
number
carried
required
number
schedule
required
object
found
required
number
carried
required
number
override
required
object
found
required
number
carried
required
number
team
required
object
found
required
number
carried
required
number
rotation
required
object
found
required
number
carried
required
number
routing
required
object
found
required
number
carried
required
number
notification
required
object
found
required
number
carried
required
number
gaps
required
Array<object>
object
kind
required
string
Allowed values: heartbeat user maintenance integration escalation schedule override team rotation routing notification
id
required
string
name
required
string
what
required
string
next
required
string
notApplied
required
object
routes
required
Array<object>
object
name
required
string
why
required
string
next
required
string
heartbeats
required
Array<object>
object
name
required
string
why
required
string
next
required
string
integrations
required
One of:
Array<object>
object
name
required
string
why
required
string
next
required
string
windows
required
Array<object>
object
name
required
string
next
required
string
undo
required
object
method
required
string
path
required
string
next
required
string
importId
required
string
schedules
required
number
policies
required
number
overrides
required
number
membersMatched
required
number
membersByEmail
required
Array<string>
readBack
required
Array<object>
object
scheduleId
required
string
opsgenieId
required
string
name
required
string
layers
required
number
overrides
required
number
xovrisNow
required
One of:
string
why
required
string
opsgenieNow
required
One of:
Array<string>
agrees
required
One of:
boolean
uncoveredMinutesNext7Days
required
number
policiesReadBack
required
Array<object>
object
policyId
required
string
opsgenieId
required
string
name
required
string
steps
required
number
repeats
required
number
matches
required
boolean
mode
required
string
source
required
string
Allowed values: api bundle
region
required
One of:
string
Allowed values: us eu

Example

{  "routes": [    "string"  ],  "windows": [    "string"  ],  "teams": [    {      "name": "string",      "members": 1,      "notYetMembers": [        "string"      ]    }  ],  "pingers": {    "moved": [      null    ],    "said": "string"  },  "phones": [    {      "name": "string",      "phone": "string",      "kinds": [        "string"      ],      "texted": true,      "why": "string"    }  ],  "heartbeats": [    {      "name": "string",      "id": "string",      "slug": "string",      "pingUrl": "string",      "everyMinutes": 1,      "paused": true    }  ],  "integrations": [    {      "id": "string",      "tool": "string",      "toolName": "string",      "webhookUrl": "string",      "emailAddress": "string",      "secret": "string",      "paused": true,      "name": "string",      "opsgenieType": "string",      "opsgenieId": "string"    }  ],  "counts": {    "heartbeat": {      "found": 1,      "carried": 1    },    "user": {      "found": 1,      "carried": 1    },    "maintenance": {      "found": 1,      "carried": 1    },    "integration": {      "found": 1,      "carried": 1    },    "escalation": {      "found": 1,      "carried": 1    },    "schedule": {      "found": 1,      "carried": 1    },    "override": {      "found": 1,      "carried": 1    },    "team": {      "found": 1,      "carried": 1    },    "rotation": {      "found": 1,      "carried": 1    },    "routing": {      "found": 1,      "carried": 1    },    "notification": {      "found": 1,      "carried": 1    }  },  "gaps": [    {      "kind": "heartbeat",      "id": "string",      "name": "string",      "what": "string",      "next": "string"    }  ],  "notApplied": {    "routes": [      {        "name": "string",        "why": "string",        "next": "string"      }    ],    "heartbeats": [      {        "name": "string",        "why": "string",        "next": "string"      }    ],    "integrations": [      {        "name": "string",        "why": "string",        "next": "string"      }    ],    "windows": [      {        "name": "string",        "next": "string"      }    ]  },  "undo": {    "method": "string",    "path": "string"  },  "next": "string",  "importId": "string",  "schedules": 1,  "policies": 1,  "overrides": 1,  "membersMatched": 1,  "membersByEmail": [    "string"  ],  "readBack": [    {      "scheduleId": "string",      "opsgenieId": "string",      "name": "string",      "layers": 1,      "overrides": 1,      "xovrisNow": "string",      "why": "string",      "opsgenieNow": [        "string"      ],      "agrees": true,      "uncoveredMinutesNext7Days": 1    }  ],  "policiesReadBack": [    {      "policyId": "string",      "opsgenieId": "string",      "name": "string",      "steps": 1,      "repeats": 1,      "matches": true    }  ],  "mode": "string",  "source": "api",  "region": "us"}

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.