Skip to content

Read your Cyber Essentials readiness

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

A token that can read is enough.

Done.

Media typeapplication/json
object
version
required
string
readAt
required
One of:
string
readiness
required
object
version
required
string
ready
required
boolean
met
required
number
notMet
required
number
unknown
required
number
autoFails
required
Array<string>
summary
required
string
requirements
required
Array<object>
object
control
required
string
Allowed values: firewalls secure_configuration security_update_management user_access_control malware_protection
id
required
string
says
required
string
state
required
string
Allowed values: unknown met not_met
findings
required
Array<string>
fix
required
One of:
string
autoFail
required
boolean
frameworks
required
Array<object>
object
framework
required
string
Allowed values: iso27001 soc2 nis2 ce_plus dora pci_dss
name
required
string
controls
required
Array<object>
object
state
required
string
Allowed values: unknown met not_met
blocking
required
Array<string>
control
required
string
title
required
string
from
required
Array<string>
met
required
number
notMet
required
number
unknown
required
number
outside
required
Array<string>
summary
required
string
read
required
object
firewalls
required
number
devices
required
number
accounts
required
number
plan
required
One of:
object
on
required
boolean
empty
required
One of:
object
message
required
string
next
required
string

Example

{  "version": "string",  "readAt": "string",  "readiness": {    "version": "string",    "ready": true,    "met": 1,    "notMet": 1,    "unknown": 1,    "autoFails": [      "string"    ],    "summary": "string"  },  "requirements": [    {      "control": "firewalls",      "id": "string",      "says": "string",      "state": "unknown",      "findings": [        "string"      ],      "fix": "string",      "autoFail": true    }  ],  "frameworks": [    {      "framework": "iso27001",      "name": "string",      "controls": [        {          "state": "unknown",          "blocking": [            "string"          ],          "control": "string",          "title": "string",          "from": [            "string"          ]        }      ],      "met": 1,      "notMet": 1,      "unknown": 1,      "outside": [        "string"      ],      "summary": "string"    }  ],  "read": {    "firewalls": 1,    "devices": 1,    "accounts": 1  },  "plan": {    "on": true  },  "empty": {    "message": "string",    "next": "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.