Skip to content

Read your monthly security score and the fixes that raise it most

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/security/posture
curl --request GET \  --url https://api.xovris.ai/v1/security/posture \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
planned
required
One of:
number
plannedFixes
required
number
history
required
Array<object>
object
month
required
string
score
required
One of:
number
parts
required
Array<object>
object
id
required
string
Allowed values: dns incidents exposure software essentials
score
required
One of:
number
measured
required
boolean
readAt
required
string
change
required
One of:
object
from
required
One of:
number
fromMonth
required
string
by
required
number
topFixes
required
Array
One of:
object
id
required
string
part
required
string
Allowed values: dns incidents exposure software essentials
title
required
string
gain
required
number
action
required
One of:
object
method
required
string
Allowed values: POST
path
required
string
body
required
object
key
additional properties
next
required
string
href
string
facts
required
object
stops
required
Array<object>
object
words
required
string
attack
required
string
notice
required
One of:
object
who
required
string
what
required
string
disruption
required
number
Allowed values: 0 2 1
needs
required
Array<string>
steps
required
Array<string>
setAside
required
Array<object>
object
state
required
object
fixId
required
string
status
required
string
Allowed values: planned risk_accepted resolved_other_way
reason
required
One of:
string
note
required
One of:
string
tags
required
Array<string>
by
required
string
at
required
string
id
required
string
part
required
string
Allowed values: dns incidents exposure software essentials
title
required
string
gain
required
number
action
required
One of:
object
method
required
string
Allowed values: POST
path
required
string
body
required
object
key
additional properties
next
required
string
href
string
facts
required
object
stops
required
Array<object>
object
words
required
string
attack
required
string
notice
required
One of:
object
who
required
string
what
required
string
disruption
required
number
Allowed values: 0 2 1
needs
required
Array<string>
steps
required
Array<string>
statesLive
required
boolean
score
required
One of:
number
areas
required
object
read
required
number
of
required
number
openIncidents
required
Array<object>
object
id
required
string
title
required
string
severity
required
string
href
required
string
parts
required
Array<object>
object
id
required
string
Allowed values: dns incidents exposure software essentials
name
required
string
weight
required
number
measured
required
boolean
score
required
One of:
number
open
required
number
detail
required
string
achievable
required
One of:
number
sentence
required
string
readAt
required
string

Example

{  "planned": 1,  "plannedFixes": 1,  "history": [    {      "month": "string",      "score": 1,      "parts": [        {          "id": "dns",          "score": 1,          "measured": true        }      ],      "readAt": "string"    }  ],  "change": {    "from": 1,    "fromMonth": "string",    "by": 1  },  "topFixes": [    {      "id": "string",      "part": "dns",      "title": "string",      "gain": 1,      "action": {        "method": "POST",        "path": "string",        "body": {}      },      "next": "string",      "href": "string",      "facts": {        "stops": [          {            "words": "string",            "attack": "string"          }        ],        "notice": {          "who": "string",          "what": "string"        },        "disruption": 0,        "needs": [          "string"        ],        "steps": [          "string"        ]      }    }  ],  "setAside": [    {      "state": {        "fixId": "string",        "status": "planned",        "reason": "string",        "note": "string",        "tags": [          "string"        ],        "by": "string",        "at": "string"      },      "id": "string",      "part": "dns",      "title": "string",      "gain": 1,      "action": {        "method": "POST",        "path": "string",        "body": {}      },      "next": "string",      "href": "string",      "facts": {        "stops": [          {            "words": "string",            "attack": "string"          }        ],        "notice": {          "who": "string",          "what": "string"        },        "disruption": 0,        "needs": [          "string"        ],        "steps": [          "string"        ]      }    }  ],  "statesLive": true,  "score": 1,  "areas": {    "read": 1,    "of": 1  },  "openIncidents": [    {      "id": "string",      "title": "string",      "severity": "string",      "href": "string"    }  ],  "parts": [    {      "id": "dns",      "name": "string",      "weight": 1,      "measured": true,      "score": 1,      "open": 1,      "detail": "string"    }  ],  "achievable": 1,  "sentence": "string",  "readAt": "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.