Skip to content

See what an Opsgenie export would bring in before importing it

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/opsgenie/plan
curl --request POST \  --url https://api.xovris.ai/v1/oncall/opsgenie/plan \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

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

Example generated

{}

Done.

Media typeapplication/json
object
plan
required
object
members
required
Array<object>
object
id
required
string
email
required
string
name
required
string
timeZone
required
One of:
string
contacts
required
Array<string>
Allowed values: push email
memberId
required
One of:
string
schedules
required
Array<object>
object
id
required
string
name
required
string
timeZone
required
string
layers
required
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
overrides
required
Array<object>
object
id
required
string
memberId
required
string
from
required
string
to
required
string
reason
required
string
policies
required
Array<object>
object
id
required
string
name
required
string
steps
required
Array<object>
object
afterMinutes
required
number
targets
required
Array
One of:
object
kind
required
string
Allowed values: schedule
scheduleId
required
string
repeats
required
number
repeatAfterMinutes
number
responseTargets
required
object
high
number
medium
number
low
number
critical
number
info
number
routes
required
Array<object>
object
id
required
string
team
required
string
name
required
string
order
required
number
matchAll
required
boolean
conditions
required
Array<object>
object
field
required
string
operation
required
string
value
required
One of:
string
not
required
boolean
target
required
One of:
object
kind
required
string
Allowed values: policy schedule
id
required
string
isDefault
required
boolean
teams
required
Array<object>
object
id
required
string
name
required
string
emails
required
Array<string>
phones
required
Array<object>
object
email
required
string
name
required
string
phone
required
string
kinds
required
Array<string>
Allowed values: voice sms
integrations
required
Array<object>
object
id
required
string
name
required
string
opsgenieType
required
string
xovris
required
One of:
string
enabled
required
boolean
heartbeats
required
Array<object>
object
name
required
string
everyMinutes
required
number
enabled
required
boolean
windows
required
Array<object>
object
id
required
string
reason
required
string
startsAt
required
string
endsAt
required
string
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
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
steps
required
number
writes
required
boolean

Example

{  "plan": {    "members": [      {        "id": "string",        "email": "string",        "name": "string",        "timeZone": "string",        "contacts": [          "push"        ],        "memberId": "string"      }    ],    "schedules": [      {        "id": "string",        "name": "string",        "timeZone": "string",        "layers": [          {            "id": "string",            "name": "string",            "members": [              "string"            ],            "startsAt": "string",            "handoff": {              "every": "week",              "count": 1            },            "restrictions": [              {                "days": [                  null                ],                "start": "string",                "end": "string"              }            ],            "endsAt": "string"          }        ],        "overrides": [          {            "id": "string",            "memberId": "string",            "from": "string",            "to": "string",            "reason": "string"          }        ]      }    ],    "policies": [      {        "id": "string",        "name": "string",        "steps": [          {            "afterMinutes": 1,            "targets": [              {                "kind": null,                "scheduleId": null              }            ]          }        ],        "repeats": 1,        "repeatAfterMinutes": 1,        "responseTargets": {          "high": 1,          "medium": 1,          "low": 1,          "critical": 1,          "info": 1        }      }    ],    "routes": [      {        "id": "string",        "team": "string",        "name": "string",        "order": 1,        "matchAll": true,        "conditions": [          {            "field": "string",            "operation": "string",            "value": "string",            "not": true          }        ],        "target": {          "kind": "policy",          "id": "string"        },        "isDefault": true      }    ],    "teams": [      {        "id": "string",        "name": "string",        "emails": [          "string"        ]      }    ],    "phones": [      {        "email": "string",        "name": "string",        "phone": "string",        "kinds": [          "voice"        ]      }    ],    "integrations": [      {        "id": "string",        "name": "string",        "opsgenieType": "string",        "xovris": "string",        "enabled": true      }    ],    "heartbeats": [      {        "name": "string",        "everyMinutes": 1,        "enabled": true      }    ],    "windows": [      {        "id": "string",        "reason": "string",        "startsAt": "string",        "endsAt": "string"      }    ],    "gaps": [      {        "kind": "heartbeat",        "id": "string",        "name": "string",        "what": "string",        "next": "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      }    }  },  "steps": 1,  "writes": true}

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.