Skip to content

Xovris signs in to the workspace's mail server 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/mail-server/check
curl --request POST \  --url https://api.xovris.ai/v1/alerts/mail-server/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
ok
required
boolean
server
required
object
host
required
string
port
required
number
security
required
string
Allowed values: tls starttls
username
required
One of:
string
from
required
string
hasPassword
required
boolean
verifiedAt
required
One of:
string
lastSentAt
required
One of:
string
lastError
required
One of:
string
lastErrorAt
required
One of:
string
state
required
string
facts
required
object
provider
required
string
optIn
required
string
region
required
string
charging
required
string

Example

{  "ok": true,  "server": {    "host": "string",    "port": 1,    "security": "tls",    "username": "string",    "from": "string",    "hasPassword": true,    "verifiedAt": "string",    "lastSentAt": "string",    "lastError": "string",    "lastErrorAt": "string",    "state": "string"  },  "facts": {    "provider": "string",    "optIn": "string",    "region": "string",    "charging": "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.