Skip to content

Tell Xovris a kind of network event is expected, so it stops raising incidents for 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/network-defence/suppressions
curl --request POST \  --url https://api.xovris.ai/v1/network-defence/suppressions \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "signatureKey": null, "src": null, "dest": null, "reason": null, "until": null }'

Send an Idempotency-Key: a repeat with the same key never acts twice and is marked Idempotent-Replayed, answering this call’s own repeat (a secret shown once is not shown again).

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
signatureKey
src
dest
reason
until

Example

{  "signatureKey": null,  "src": null,  "dest": null,  "reason": null,  "until": null}

Done.

Media typeapplication/json
object
replayed
required
boolean

Example

{  "replayed": true}

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

Media typeapplication/json
object
id
required
string
suppressedIncidents
required
number
decisionId
string
undo
required
object
method
required
string
path
required
string
next
required
string

Example

{  "id": "string",  "suppressedIncidents": 1,  "decisionId": "string",  "undo": {    "method": "string",    "path": "string"  },  "next": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.