Skip to content

Have Xovris write the next mail authentication record

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

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

Example generated

{}

Done.

Media typeapplication/json
One of:
object
next
required
string
shown
Array<string>
metFrom
Array<object>
object
sender
required
string
found
required
Array<string>
steps
required
Array<object>
object
action
required
string
Allowed values: dns.record.add dns.record.update
purpose
required
string
Allowed values: verification dkim spf dmarc
name
required
string
type
required
string
Allowed values: CNAME TXT
content
required
string
recordId
string
expectedContent
string
why
required
string
needs
required
Array<object>
object
sender
required
string
what
required
string
docs
required
string
problems
required
Array<string>
already
required
Array<string>
authorise
Array<object>
object
host
required
string
name
required
string
wildcard
required
string
content
required
string
Allowed values: v=DMARC1
why
required
string
reports
Array<object>
object
host
required
string
record
required
string
authorised
required
One of:
boolean
zone
required
string

Example

{  "next": "string",  "shown": [    "string"  ],  "metFrom": [    {      "sender": "string",      "found": [        "string"      ]    }  ],  "steps": [    {      "action": "dns.record.add",      "purpose": "verification",      "name": "string",      "type": "CNAME",      "content": "string",      "recordId": "string",      "expectedContent": "string",      "why": "string"    }  ],  "needs": [    {      "sender": "string",      "what": "string",      "docs": "string"    }  ],  "problems": [    "string"  ],  "already": [    "string"  ],  "authorise": [    {      "host": "string",      "name": "string",      "wildcard": "string",      "content": "v=DMARC1",      "why": "string"    }  ],  "reports": [    {      "host": "string",      "record": "string",      "authorised": true    }  ],  "zone": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object
runId
required
string
incidentId
required
string
step
required
object
action
required
string
Allowed values: dns.record.add dns.record.update
purpose
required
string
Allowed values: verification dkim spf dmarc
name
required
string
type
required
string
Allowed values: CNAME TXT
content
required
string
recordId
string
expectedContent
string
why
required
string
remaining
required
number
needs
required
Array<object>
object
sender
required
string
what
required
string
docs
required
string
next
required
string

Example

{  "runId": "string",  "incidentId": "string",  "step": {    "action": "dns.record.add",    "purpose": "verification",    "name": "string",    "type": "CNAME",    "content": "string",    "recordId": "string",    "expectedContent": "string",    "why": "string"  },  "remaining": 1,  "needs": [    {      "sender": "string",      "what": "string",      "docs": "string"    }  ],  "next": "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.