Skip to content

Plan a block for a network incident as a dry run, with its expiry and undo

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/incidents/{id}/prevent
curl --request POST \  --url https://api.xovris.ai/v1/network-defence/incidents/example/prevent \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "point": null, "connectionId": null, "deviceId": null, "address": "string", "expiresInMinutes": null, "apply": null, "planId": null, "planDigest": "string" }'

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.

id
required
string
Media typeapplication/json
object
point
connectionId
deviceId
address
string
expiresInMinutes
apply
planId
planDigest
string

Example

{  "point": null,  "connectionId": null,  "deviceId": null,  "address": "string",  "expiresInMinutes": null,  "apply": null,  "planId": null,  "planDigest": "string"}

Done.

Media typeapplication/json
One of:
object
replayed
required
boolean

Example

{  "replayed": true}

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

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object
next
string
machine
object
id
required
string
name
required
string
id
required
string
state
required
string
dryRun
required
boolean
decisionId
string
plan
required
object
actionId
required
string
Allowed values: ids.rule.drop ids.address.block
undoActionId
required
string
Allowed values: ids.rule.remove ids.address.unblock
point
required
string
Allowed values: system host suricata fortigate paloalto
address
required
string
connectionId
string
changes
required
string
apply
required
object
rule
string
steps
Array<object>
object
method
required
string
Allowed values: GET POST PUT PATCH DELETE
path
required
string
body
required
check
object
kind
required
string
Allowed values: fix.host.block
input
required
object
key
additional properties
readBack
required
object
steps
Array<object>
object
method
required
string
Allowed values: GET POST PUT PATCH DELETE
path
required
string
body
required
expect
required
string
undo
required
object
rule
string
steps
Array<object>
object
method
required
string
Allowed values: GET POST PUT PATCH DELETE
path
required
string
body
required
check
object
kind
required
string
Allowed values: fix.host.block
input
required
object
key
additional properties
expiresAt
required
string
digest
required
string
carryOn
required
One of:
object
id
required
string
kind
required
string
subject
required
string
state
required
string
Allowed values: done in_progress
waitingFor
required
string
Allowed values: provider admin research person retry runner catalogue dns_connection dns_write sender
doing
required
string
manual
required
string
next
required
string
fix
required
One of:
object
label
required
string
method
required
string
Allowed values: GET POST PUT PATCH
path
required
string
body
object
key
additional properties
attempts
required
number
seen
required
number
nextCheckAt
required
One of:
string
lastReason
required
One of:
string
proof
required
One of:
object
key
additional properties
createdAt
required
string
doneAt
required
One of:
string

Example

{  "next": "string",  "machine": {    "id": "string",    "name": "string"  },  "id": "string",  "state": "string",  "dryRun": true,  "decisionId": "string",  "plan": {    "actionId": "ids.rule.drop",    "undoActionId": "ids.rule.remove",    "point": "system",    "address": "string",    "connectionId": "string",    "changes": "string",    "apply": {      "rule": "string",      "steps": [        {          "method": "GET",          "path": "string",          "body": null        }      ],      "check": {        "kind": "fix.host.block",        "input": {}      }    },    "readBack": {      "steps": [        {          "method": "GET",          "path": "string",          "body": null        }      ],      "expect": "string"    },    "undo": {      "rule": "string",      "steps": [        {          "method": "GET",          "path": "string",          "body": null        }      ],      "check": {        "kind": "fix.host.block",        "input": {}      }    },    "expiresAt": "string",    "digest": "string"  },  "carryOn": {    "id": "string",    "kind": "string",    "subject": "string",    "state": "done",    "waitingFor": "provider",    "doing": "string",    "manual": "string",    "next": "string",    "fix": {      "label": "string",      "method": "GET",      "path": "string",      "body": {}    },    "attempts": 1,    "seen": 1,    "nextCheckAt": "string",    "lastReason": "string",    "proof": {},    "createdAt": "string",    "doneAt": "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.