Skip to content

Hand over a DKIM record from a mail service Xovris has no door into yet, and see the change it allows

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/keys
curl --request POST \  --url https://api.xovris.ai/v1/mail/keys \  --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
object
zones
required
Array<object>
object
zone
required
string
findings
required
Array<object>
object
next
required
Array<object>
object
id
required
string
Allowed values: spf.missing spf.multiple spf.open_all spf.no_all spf.lookups spf.void_lookups spf.ptr spf.syntax spf.provider_missing dmarc.missing dmarc.multiple dmarc.syntax dmarc.monitoring dmarc.not_rejecting dmarc.partial dmarc.subdomains_open dmarc.no_reports dmarc.report_unauthorised dmarc.obsolete_tags dmarc.testing dmarc.reports_undeliverable dkim.missing dkim.revoked dkim.weak_key dkim.testing mta_sts.missing tls_rpt.missing bimi.not_enforced parked.open mx.missing mx.wrong
subject
required
One of:
string
words
required
string
fix
required
string
held
string
needs
object
who
required
string
what
required
string
connect
string
Allowed values: resend postmark sendgrid mailgun
hand
string
Allowed values: dkim
waits
string
id
required
string
Allowed values: spf.missing spf.multiple spf.open_all spf.no_all spf.lookups spf.void_lookups spf.ptr spf.syntax spf.provider_missing dmarc.missing dmarc.multiple dmarc.syntax dmarc.monitoring dmarc.not_rejecting dmarc.partial dmarc.subdomains_open dmarc.no_reports dmarc.report_unauthorised dmarc.obsolete_tags dmarc.testing dmarc.reports_undeliverable dkim.missing dkim.revoked dkim.weak_key dkim.testing mta_sts.missing tls_rpt.missing bimi.not_enforced parked.open mx.missing mx.wrong
subject
required
One of:
string
severity
required
string
Allowed values: high medium low
words
required
string
standard
required
string
fix
required
string
repair
required
string
Allowed values: person held writes waits
change
required
Array<object>
object
op
required
string
Allowed values: removed published rewritten
name
required
string
type
required
string
before
required
One of:
string
after
required
One of:
string
because
required
string
leaves
required
One of:
string
ready
required
number
unread
required
number
next
required
string
zone
required
string
selector
required
string
kept
required
boolean

Example

{  "zones": [    {      "zone": "string",      "findings": [        {          "next": [            {              "id": "spf.missing",              "subject": "string",              "words": "string",              "fix": "string"            }          ],          "held": "string",          "needs": {            "who": "string",            "what": "string",            "connect": "resend",            "hand": "dkim"          },          "waits": "string",          "id": "spf.missing",          "subject": "string",          "severity": "high",          "words": "string",          "standard": "string",          "fix": "string",          "repair": "person",          "change": [            {              "op": "removed",              "name": "string",              "type": "string",              "before": "string",              "after": "string"            }          ],          "because": "string",          "leaves": "string"        }      ]    }  ],  "ready": 1,  "unread": 1,  "next": "string",  "zone": "string",  "selector": "string",  "kept": 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.