Skip to content

See the containment of the machine a network incident reached: what it keeps, what was proved, and whether it was lifted

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.

GET
/v1/network-defence/incidents/{id}/contain
curl --request GET \  --url https://api.xovris.ai/v1/network-defence/incidents/example/contain \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
plan
required
One of:
object
keep
required
Array
full
required
digest
required
string
checkId
required
string
deviceId
required
string
machine
required
string
state
required
string
askedAt
required
One of:
string
at
required
One of:
string
outcome
required
One of:
string
passed
required
boolean
detail
required
One of:
string
applied
required
One of:
object
kept
required
proofs
required
checkId
required
string
deviceId
required
string
machine
required
string
state
required
string
askedAt
required
One of:
string
at
required
One of:
string
outcome
required
One of:
string
passed
required
boolean
detail
required
One of:
string
undone
required
One of:
object
checkId
required
string
deviceId
required
string
machine
required
string
state
required
string
askedAt
required
One of:
string
at
required
One of:
string
outcome
required
One of:
string
passed
required
boolean
detail
required
One of:
string

Example

{  "plan": {    "keep": [      null    ],    "full": null,    "digest": "string",    "checkId": "string",    "deviceId": "string",    "machine": "string",    "state": "string",    "askedAt": "string",    "at": "string",    "outcome": "string",    "passed": true,    "detail": "string"  },  "applied": {    "kept": null,    "proofs": null,    "checkId": "string",    "deviceId": "string",    "machine": "string",    "state": "string",    "askedAt": "string",    "at": "string",    "outcome": "string",    "passed": true,    "detail": "string"  },  "undone": {    "checkId": "string",    "deviceId": "string",    "machine": "string",    "state": "string",    "askedAt": "string",    "at": "string",    "outcome": "string",    "passed": true,    "detail": "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.