Skip to content

Read your plan and what you have used

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

A token that can read is enough.

Done.

Media typeapplication/json
object
plan
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise builder
entitlements
required
object
plan
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise builder
name
required
string
monitors
required
number
minCheckIntervalSeconds
required
number
routineLocations
required
number
heartbeats
required
number
statusPages
required
One of:
number
workspaceAddress
required
boolean
customDomains
required
One of:
number
browserRunsPerMonth
required
One of:
number
continuousChecks
required
number
checkHistoryDays
required
number
errorEventsPerMonth
required
number
errorRetentionDays
required
number
aiInvestigationsPerMonth
required
number
aiFixedIssuesPerMonth
required
number
reserveInvestigationsPerMonth
required
number
repairsUnderStandingPolicy
required
boolean
fixPacks
required
boolean
upgrades
required
object
everyMinute
required
One of:
string
continuous
required
One of:
string
aiChecks
required
string
Allowed values: continuous 5m 15m hourly daily rules_3m rules_5m 1m_adaptive
autonomy
required
string
Allowed values: guided you_approve safe_automatic standing_permissions security_response full_policy contracted
forecasts
required
object
expiryDates
required
boolean
devices
required
boolean
apiChangeWatch
required
boolean
devicesApp
required
boolean
siteQuality
required
boolean
exposure
required
object
people
required
boolean
business
required
boolean
scamProtection
required
boolean
homeNetwork
required
boolean
appStoreWatch
required
boolean
complianceEvidence
required
boolean
people
required
object
startersLeavers
required
boolean
accessMap
required
boolean
twoPersonRule
required
boolean
multiCompany
required
boolean
privateLibrary
required
boolean
alertChannels
required
Array<string>
Allowed values: email slack webhook
deterministicDiagnostics
required
boolean
export
required
boolean
users
required

Unlimited users – no charge per person: the value is “unlimited”.

string
integrations
required

Unlimited - no plan caps or charges per connection; metered use (monitors, error events and issues fixed) is billed as each plan states: the value is “unlimited”.

string
logs
required
object
linesPerMonth
required
number
searchableDays
required
number
retainedDays
required
number
confirmed
required
boolean
features
required
Array<object>
object
id
required

One of “checks.anything”, “alerts.channels”, “integrations.unlimited” (unlimited - no plan caps or charges per connection; metered use (monitors, error events and issues fixed) is billed as each plan states), “people.unlimited” (Unlimited users – no charge per person), “logs”, “errors”, “diagnostics”, “export”, “forecast.expiry_dates”, “digest.weekly”, “status_page”, “address.workspace”, “network.diagnosis”, “help.cobrowse”, “setup.takeover”, “checks.free_tools”, “checks.every_minute”, “checks.continuous”, “history.90_days”, “ai.investigations”, “ai.fixes”, “repairs.verified_restores”, “ai.checks.daily”, “ai.packs”, “devices.app”, “forecast.devices”, “exposure.people”, “site_quality”, “ai.checks.hourly”, “autonomy.safe_automatic”, “home_network.security”, “scam.protection”, “backups.verified”, “ai.checks.15m”, “autonomy.standing_permissions”, “people.starters_leavers”, “assets.access_map”, “changes.two_person”, “api_change_watch”, “apps.store_watch”, “sso”, “domain.own”, “ai.checks.5m”, “autonomy.security_response”, “exposure.business”, “compliance.evidence”, “ai.checks.1m_adaptive”, “autonomy.full_policy”, “accounts.multi_company”, “procedures.private_library”, “ai.checks.continuous”, “dedicated.silo”, “residency.region”.

string
first
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise
live
required
boolean
source
object
id
required
string
Allowed values: breach_source production_ai review_ladder review_ai
on
required
boolean
sources
required
object
breach_source
boolean
production_ai
boolean
review_ladder
boolean
review_ai
boolean
usage
required
object
period
required
string
monitors
required
number
errorEvents
required
number
errorEventsDropped
required
number
investigations
required
number
aiFixedIssues
required
number
aiReserveInvestigations
required
number
logLines
required
number
logLinesDropped
required
number
assets
pool
required
object
aiFixedIssues
required
number
investigations
required
number
errorEvents
required
number
logLines
required
number
allowance
required
object
unit
required
string
Allowed values: ai_fixed_issues
included
required
number
used
required
number
remaining
required
number
state
required
string
Allowed values: exhausted not_in_plan available
reserveRemaining
required
number
statement
required
string
packs
number
customerLimit
One of:
number
subscription
required
One of:
object
status
required
periodEnd
required
One of:
string
pendingPlan
required
graceUntil
required
One of:
string

Example

{  "plan": "free",  "entitlements": {    "plan": "free",    "name": "string",    "monitors": 1,    "minCheckIntervalSeconds": 1,    "routineLocations": 1,    "heartbeats": 1,    "statusPages": 1,    "workspaceAddress": true,    "customDomains": 1,    "browserRunsPerMonth": 1,    "continuousChecks": 1,    "checkHistoryDays": 1,    "errorEventsPerMonth": 1,    "errorRetentionDays": 1,    "aiInvestigationsPerMonth": 1,    "aiFixedIssuesPerMonth": 1,    "reserveInvestigationsPerMonth": 1,    "repairsUnderStandingPolicy": true,    "fixPacks": true,    "upgrades": {      "everyMinute": "string",      "continuous": "string"    },    "aiChecks": "continuous",    "autonomy": "guided",    "forecasts": {      "expiryDates": true,      "devices": true    },    "apiChangeWatch": true,    "devicesApp": true,    "siteQuality": true,    "exposure": {      "people": true,      "business": true    },    "scamProtection": true,    "homeNetwork": true,    "appStoreWatch": true,    "complianceEvidence": true,    "people": {      "startersLeavers": true,      "accessMap": true    },    "twoPersonRule": true,    "multiCompany": true,    "privateLibrary": true,    "alertChannels": [      "email"    ],    "deterministicDiagnostics": true,    "export": true,    "users": "string",    "integrations": "string",    "logs": {      "linesPerMonth": 1,      "searchableDays": 1,      "retainedDays": 1,      "confirmed": true    }  },  "features": [    {      "id": "string",      "first": "free",      "live": true,      "source": {        "id": "breach_source",        "on": true      }    }  ],  "sources": {    "breach_source": true,    "production_ai": true,    "review_ladder": true,    "review_ai": true  },  "usage": {    "period": "string",    "monitors": 1,    "errorEvents": 1,    "errorEventsDropped": 1,    "investigations": 1,    "aiFixedIssues": 1,    "aiReserveInvestigations": 1,    "logLines": 1,    "logLinesDropped": 1,    "assets": null  },  "pool": {    "aiFixedIssues": 1,    "investigations": 1,    "errorEvents": 1,    "logLines": 1  },  "allowance": {    "unit": "ai_fixed_issues",    "included": 1,    "used": 1,    "remaining": 1,    "state": "exhausted",    "reserveRemaining": 1,    "statement": "string",    "packs": 1,    "customerLimit": 1  },  "subscription": {    "status": null,    "periodEnd": "string",    "pendingPlan": null,    "graceUntil": "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.