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.
const url = 'https://api.xovris.ai/v1/security/posture';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/security/posture \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.