Skip to content

Check a website for free

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/public/check
curl --request POST \  --url https://api.xovris.ai/v1/public/check \  --header 'Content-Type: application/json' \  --data '{ "url": null, "turnstileToken": null, "altcha": null, "pow": null, "embeddedOn": null }'

Open to anyone, so no Idempotency-Key is kept: nobody is signed in to keep it for, and replaying one caller’s answer to another would hand it over.

No token needed: anyone may call this.

Media typeapplication/json
object
url
turnstileToken
altcha
pow
embeddedOn

Example

{  "url": null,  "turnstileToken": null,  "altcha": null,  "pow": null,  "embeddedOn": null}

Done.

Media typeapplication/json
One of:
object
checker
required
One of:
object
options
required
One of:
object
deps
required
object
runner
required
object
location
object
id
required
string
provider
required
string
Allowed values: gcp aws private local
region
required
string
place
required
string
private
required
boolean
budgetMs
number
doors
One of:
boolean
fingerprintReader
object
dns
object
budgetMs
number
perClient
object
limit
required
number
windowMs
required
number
anonymous
object
domains
required
number
networkDomains
number
windowMs
required
number
perTarget
object
clients
required
number
windowMs
required
number
challenge
object
provider
required
string
Allowed values: turnstile
siteKey
required
string
escalateAtNetworkDomains
number
escalateFromProbe
number
proofOfWork
object
hmacKey
required
One of:
string
maxNumber
number
expiresMs
number
ownDomain
One of:
string
burst
object
limit
required
number
windowMs
required
number
perAsn
object
escalateAt
required
number
limit
required
number
windowMs
required
number
proof
One of:
object
signedIn
object
limit
required
number
windowMs
required
number
partnerDaily
number
ledger
object
maxInFlight
number
cacheMs
number
cacheEntries
number
db
required
One of:
object
pool
required
object
totalCount
required
number
idleCount
required
number
waitingCount
required
number
expiredCount
required
number
ending
required
boolean
ended
required
boolean
options
required
object
max
required
number
maxUses
required
number
allowExitOnIdle
required
boolean
maxLifetimeSeconds
required
number
idleTimeoutMillis
required
One of:
number
min
number
Promise
object
Client
object
user
string
database
string
password
string
port
number
host
string
connectionString
string
keepAlive
boolean
statement_timeout
One of:
number
ssl
One of:
boolean
enableChannelBinding
boolean
sslnegotiation
string
Allowed values: postgres direct
query_timeout
number
lock_timeout
number
keepAliveInitialDelayMillis
number
idle_in_transaction_session_timeout
number
application_name
string
fallback_application_name
string
connectionTimeoutMillis
number
types
object
options
string
client_encoding
string
pipeline
boolean
proof
One of:
object
ownOrigins
Array<string>
portProbe
null

Example

{  "checker": {},  "options": {    "deps": {      "runner": {},      "location": {        "id": "string",        "provider": "gcp",        "region": "string",        "place": "string",        "private": true      },      "budgetMs": 1    },    "doors": true,    "fingerprintReader": {      "dns": {},      "budgetMs": 1    },    "perClient": {      "limit": 1,      "windowMs": 1    },    "anonymous": {      "domains": 1,      "networkDomains": 1,      "windowMs": 1    },    "perTarget": {      "clients": 1,      "windowMs": 1    },    "challenge": {      "provider": "turnstile",      "siteKey": "string"    },    "escalateAtNetworkDomains": 1,    "escalateFromProbe": 1,    "proofOfWork": {      "hmacKey": "string",      "maxNumber": 1,      "expiresMs": 1    },    "ownDomain": "string",    "burst": {      "limit": 1,      "windowMs": 1    },    "perAsn": {      "escalateAt": 1,      "limit": 1,      "windowMs": 1    },    "proof": {},    "signedIn": {      "limit": 1,      "windowMs": 1    },    "partnerDaily": 1,    "ledger": {},    "maxInFlight": 1,    "cacheMs": 1,    "cacheEntries": 1  },  "db": {    "pool": {      "totalCount": 1,      "idleCount": 1,      "waitingCount": 1,      "expiredCount": 1,      "ending": true,      "ended": true,      "options": {        "max": 1,        "maxUses": 1,        "allowExitOnIdle": true,        "maxLifetimeSeconds": 1,        "idleTimeoutMillis": 1,        "min": 1,        "Promise": {},        "Client": {},        "user": "string",        "database": "string",        "password": "string",        "port": 1,        "host": "string",        "connectionString": "string",        "keepAlive": true,        "statement_timeout": 1,        "ssl": true,        "enableChannelBinding": true,        "sslnegotiation": "postgres",        "query_timeout": 1,        "lock_timeout": 1,        "keepAliveInitialDelayMillis": 1,        "idle_in_transaction_session_timeout": 1,        "application_name": "string",        "fallback_application_name": "string",        "connectionTimeoutMillis": 1,        "types": {},        "options": "string",        "client_encoding": "string",        "pipeline": true      }    }  },  "proof": {},  "ownOrigins": [    "string"  ],  "portProbe": null}

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

Example generated

{}

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.