Skip to content

Xovris reads the sending domain's records again

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/alerts/sending-domain/check
curl --request POST \  --url https://api.xovris.ai/v1/alerts/sending-domain/check \  --header 'Authorization: Bearer <token>'

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

Done.

Media typeapplication/json
object
domain
required
string
providerVerified
required
boolean
dmarc
required
One of:
string
checkedAt
required
One of:
string
sendingSince
required
One of:
string
sendingFrom
required
One of:
object
alerts
required
string
status
required
string
checks
required
Array<object>
object
why
required
string
kind
required
string
Allowed values: dkim spf dmarc
kept
required
One of:
string
found
required
Array<string>
ok
required
boolean
needed
required
boolean
written
required
boolean
name
required
string
type
required
string
Allowed values: CNAME TXT
value
required
string
state
required
string
said
required
string
ok
required
boolean

Example

{  "domain": "string",  "providerVerified": true,  "dmarc": "string",  "checkedAt": "string",  "sendingSince": "string",  "sendingFrom": {    "alerts": "string",    "status": "string"  },  "checks": [    {      "why": "string",      "kind": "dkim",      "kept": "string",      "found": [        "string"      ],      "ok": true,      "needed": true,      "written": true,      "name": "string",      "type": "CNAME",      "value": "string"    }  ],  "state": "string",  "said": "string",  "ok": true}

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.