Skip to content

Point a domain you own at this workspace and get the records to add

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/workspace/domains
curl --request POST \  --url https://api.xovris.ai/v1/workspace/domains \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "hostname": null, "host": null, "surface": null }'

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
hostname
host
surface

Example

{  "hostname": null,  "host": null,  "surface": null}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
xovris
required
object
writes
required
boolean
door
required
One of:
object
label
required
string
method
required
string
Allowed values: GET POST PUT PATCH
path
required
string
body
object
key
additional properties
zone
required
One of:
string
manual
required
string
decisionId
required
string
state
string
preview
required
object
hostname
required
string
surface
required
string
records
required
Array<object>
object
name
required
string
type
required
string
content
required
string
why
required
string
caa
required
writtenBy
required
string

Example

{  "xovris": {    "writes": true,    "door": {      "label": "string",      "method": "GET",      "path": "string",      "body": {}    },    "zone": "string",    "manual": "string"  },  "decisionId": "string",  "state": "string",  "preview": {    "hostname": "string",    "surface": "string",    "records": [      {        "name": "string",        "type": "string",        "content": "string",        "why": "string"      }    ],    "caa": null,    "writtenBy": "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.