Skip to content

Have Xovris patch a device

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/vulnerabilities/devices/{id}/patch
curl --request POST \  --url https://api.xovris.ai/v1/vulnerabilities/devices/example/patch \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "idempotencyKey": "string", "goFirst": null }'

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
idempotencyKey
string
goFirst

Example

{  "idempotencyKey": "string",  "goFirst": null}

Done.

Media typeapplication/json
One of:
object
runId
required
string
state
required
string
again
required
boolean
to
required
string
ring
required
string
Allowed values: critical pilot broad
action
required
object
kind
required
string
Allowed values: fix.software.upgrade fix.firmware.upgrade fix.os.update
mode
required
string
Allowed values: automatic guided
door
required
string
Allowed values: browser vendor-api management-protocol device-manager os-updater device-standard
ladder
required
Array<object>
object
door
required
string
Allowed values: browser vendor-api management-protocol device-manager os-updater device-standard
via
required
string
runs
required
boolean
before
required
string
apply
required
string
readBack
required
string
rollback
required
string

Example

{  "runId": "string",  "state": "string",  "again": true,  "to": "string",  "ring": "critical",  "action": {    "kind": "fix.software.upgrade",    "mode": "automatic",    "door": "browser",    "ladder": [      {        "door": "browser",        "via": "string",        "runs": true      }    ],    "before": "string",    "apply": "string",    "readBack": "string",    "rollback": "string"  }}

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
runId
required
string
state
required
string
again
required
boolean
to
required
string
ring
required
string
Allowed values: critical pilot broad
action
required
object
kind
required
string
Allowed values: fix.software.upgrade fix.firmware.upgrade fix.os.update
mode
required
string
Allowed values: automatic guided
door
required
string
Allowed values: browser vendor-api management-protocol device-manager os-updater device-standard
ladder
required
Array<object>
object
door
required
string
Allowed values: browser vendor-api management-protocol device-manager os-updater device-standard
via
required
string
runs
required
boolean
before
required
string
apply
required
string
readBack
required
string
rollback
required
string

Example

{  "runId": "string",  "state": "string",  "again": true,  "to": "string",  "ring": "critical",  "action": {    "kind": "fix.software.upgrade",    "mode": "automatic",    "door": "browser",    "ladder": [      {        "door": "browser",        "via": "string",        "runs": true      }    ],    "before": "string",    "apply": "string",    "readBack": "string",    "rollback": "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.