Skip to content

Read what a domain runs on and every host its certificates name

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/footprint
curl --request POST \  --url https://api.xovris.ai/v1/footprint \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "domain": "string" }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
domain
string

Example

{  "domain": "string"}

Done.

Media typeapplication/json
object
domain
required
string
readAt
required
string
certificates
required
One of:
object
seen
required
number
hostnames
required
Array<string>
issuers
required
Array<object>
object
name
required
string
count
required
number
newest
required
One of:
string
source
required
string
site
required
object
reached
required
boolean
address
required
One of:
string
status
required
One of:
number
problem
required
One of:
string
findings
required
Array<object>
object
name
required
string
category
required
string
Allowed values: email dns security support hosting cdn payments framework analytics commerce
evidence
required
string
connect
required
One of:
string
plan
required
object
connections
required
Array<object>
object
connect
required
string
names
required
Array<string>
assets
required
object
website
required
boolean
emailDomain
required
boolean
units
required
number
quote
required
object
plan
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise builder
packs
required
number
packFamily
required
string
Allowed values: business people
monthly
required
number
dueNow
required
number
currency
required
string
Allowed values: USD
confirmed
required
boolean
reasons
required
Array<string>
Allowed values: interval ai errors monitors history assets
overLimit
required
Array<object>
object
unit
required
string
Allowed values: monitors error_events asset_units
limit
required
number
asked
required
number
assetUnits
required
object
asked
required
number
covered
required
One of:
number
sentence
required
string
sentence
required
string

Example

{  "domain": "string",  "readAt": "string",  "certificates": {    "seen": 1,    "hostnames": [      "string"    ],    "issuers": [      {        "name": "string",        "count": 1      }    ],    "newest": "string",    "source": "string"  },  "site": {    "reached": true,    "address": "string",    "status": 1,    "problem": "string"  },  "findings": [    {      "name": "string",      "category": "email",      "evidence": "string",      "connect": "string"    }  ],  "plan": {    "connections": [      {        "connect": "string",        "names": [          "string"        ]      }    ],    "assets": {      "website": true,      "emailDomain": true,      "units": 1    },    "quote": {      "plan": "free",      "packs": 1,      "packFamily": "business",      "monthly": 1,      "dueNow": 1,      "currency": "USD",      "confirmed": true,      "reasons": [        "interval"      ],      "overLimit": [        {          "unit": "monitors",          "limit": 1,          "asked": 1        }      ],      "assetUnits": {        "asked": 1,        "covered": 1      }    },    "sentence": "string"  },  "sentence": "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.