Skip to content

Stop watching a website, with an undo

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.

DELETE
/v1/assets/{id}
curl --request DELETE \  --url https://api.xovris.ai/v1/assets/example \  --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.

id
required
string

Done.

Media typeapplication/json
object
next
required
string
undo
required
object
label
required
string
method
required
string
path
required
string
setup
required
object
tenantId
required
string
now
required
string
steps
required
Array<object>
object
id
required
string
Allowed values: url domain alerts app site repair
state
required
string
Allowed values: done failed waiting skipped todo
optional
required
boolean
evidenceAt
required
One of:
string
reason
required
string
Allowed values: skipped site_chosen site_missing url_missing url_checks_running url_checks_stored app_missing app_waiting_event app_test_event_only app_event_stored app_credential_failed app_revoked alerts_untested alerts_queued alerts_provider_accepted alerts_failed domain_unproved domain_proved repair_not_granted repair_read_only repair_authorised
subjectId
required
One of:
string
ladders
required
Array<object>
object
connectionId
required
string
kind
required
string
Allowed values: email url system mcp slack vercel cloudflare sdk
label
required
string
platform
required
One of:
string
rungs
required
Array<object>
object
rung
required
string
Allowed values: connected repair_authorised telemetry_received monitoring_verified
reached
required
boolean
at
required
One of:
string
applicable
required
boolean
current
required
One of:
string
Allowed values: connected repair_authorised telemetry_received monitoring_verified
capabilities
required
Array<string>
Allowed values: watch receive_events dns_record_edit deploy_env_write post_messages
writes
boolean
health
required
string
Allowed values: revoked waiting healthy credential_failed
diagnosis
required
One of:
string
Allowed values: unknown wrong_key blocked_egress ad_blocked_browser unsupported_runtime build_token_missing token_revoked scope_missing
canary
One of:
object
outcome
required
string
status
required
One of:
number
detail
required
One of:
string
at
required
string
nextDueAt
required
One of:
string
everySeconds
required
One of:
number
buildToken
One of:
object
at
required
string
events
required
number
code
required
string
Allowed values: build_token_missing
cause
required
string
next
required
string
fix
required
object
label
required
string
method
required
string
path
required
string
body
required
object
key
additional properties
browserBlocked
One of:
object
at
required
string
envelopes
required
number
code
required
string
Allowed values: ad_blocked_browser
cause
required
string
next
required
string
environmentWarning
One of:
object
at
required
string
events
required
number
code
required
string
Allowed values: tag_disagrees_with_key production_tag_from_preview_host release_never_in_production
tagged
required
string
actual
required
One of:
string
release
required
One of:
string
host
required
One of:
string
cause
required
string
next
required
string
fix
required
One of:
object
label
required
string
method
required
string
path
required
string
body
required
object
key
additional properties
environmentMap
Array<object>
object
project
required
string
target
required
string
readBackAt
required
One of:
string
release
required
One of:
string
releasedAt
required
One of:
string
url
required
One of:
string
coverage
required
Array<object>
object
assetId
required
string
label
required
string
tiers
required
Array<object>
object
tier
required
string
Allowed values: browser outside_in backend infrastructure write_access
state
required
string
Allowed values: unknown stale covered not_monitored
lastAt
required
One of:
string
ageSeconds
required
One of:
number
delivery
required
Array<object>
object
channel
required
string
Allowed values: email slack
latest
required
One of:
object
id
required
string
channel
required
string
Allowed values: email slack
state
required
string
Allowed values: failed queued accepted delivered bounced
requestedAt
required
string
providerReportedAt
required
One of:
string
providerReference
required
One of:
string
failure
required
One of:
object
code
required
string
message
required
string
fallbackOf
required
One of:
string
delay
One of:
object
type
required
string
at
required
string
until
required
One of:
string
provider
required
string
fallback
required
One of:
object
id
required
string
channel
required
string
Allowed values: email slack
state
required
string
Allowed values: failed queued accepted delivered bounced
requestedAt
required
string
providerReportedAt
required
One of:
string
providerReference
required
One of:
string
failure
required
One of:
object
code
required
string
message
required
string
fallbackOf
required
One of:
string
delay
One of:
object
type
required
string
at
required
string
until
required
One of:
string
provider
required
string
alertEmail
required
One of:
string
next
required
One of:
string
Allowed values: url domain alerts app site repair
complete
required
boolean
removalId
required
string
assetId
required
string
hostname
required
string
url
required
string
checksPaused
required
number
incidentsClosed
required
number
incidentsOpen
required
number
removed
required
boolean

Example

{  "next": "string",  "undo": {    "label": "string",    "method": "string",    "path": "string"  },  "setup": {    "tenantId": "string",    "now": "string",    "steps": [      {        "id": "url",        "state": "done",        "optional": true,        "evidenceAt": "string",        "reason": "skipped",        "subjectId": "string"      }    ],    "ladders": [      {        "connectionId": "string",        "kind": "email",        "label": "string",        "platform": "string",        "rungs": [          {            "rung": "connected",            "reached": true,            "at": "string",            "applicable": true          }        ],        "current": "connected",        "capabilities": [          "watch"        ],        "writes": true,        "health": "revoked",        "diagnosis": "unknown",        "canary": {          "outcome": "string",          "status": 1,          "detail": "string",          "at": "string",          "nextDueAt": "string",          "everySeconds": 1        },        "buildToken": {          "at": "string",          "events": 1,          "code": "build_token_missing",          "cause": "string",          "next": "string",          "fix": {            "label": "string",            "method": "string",            "path": "string",            "body": {}          }        },        "browserBlocked": {          "at": "string",          "envelopes": 1,          "code": "ad_blocked_browser",          "cause": "string",          "next": "string"        },        "environmentWarning": {          "at": "string",          "events": 1,          "code": "tag_disagrees_with_key",          "tagged": "string",          "actual": "string",          "release": "string",          "host": "string",          "cause": "string",          "next": "string",          "fix": {            "label": "string",            "method": "string",            "path": "string",            "body": {}          }        },        "environmentMap": [          {            "project": "string",            "target": "string",            "readBackAt": "string",            "release": "string",            "releasedAt": "string",            "url": "string"          }        ]      }    ],    "coverage": [      {        "assetId": "string",        "label": "string",        "tiers": [          {            "tier": "browser",            "state": "unknown",            "lastAt": "string",            "ageSeconds": 1          }        ]      }    ],    "delivery": [      {        "channel": "email",        "latest": {          "id": "string",          "channel": "email",          "state": "failed",          "requestedAt": "string",          "providerReportedAt": "string",          "providerReference": "string",          "failure": {            "code": "string",            "message": "string"          },          "fallbackOf": "string",          "delay": {            "type": "string",            "at": "string",            "until": null,            "provider": "string"          }        },        "fallback": {          "id": "string",          "channel": "email",          "state": "failed",          "requestedAt": "string",          "providerReportedAt": "string",          "providerReference": "string",          "failure": {            "code": "string",            "message": "string"          },          "fallbackOf": "string",          "delay": {            "type": "string",            "at": "string",            "until": null,            "provider": "string"          }        }      }    ],    "alertEmail": "string",    "next": "url",    "complete": true  },  "removalId": "string",  "assetId": "string",  "hostname": "string",  "url": "string",  "checksPaused": 1,  "incidentsClosed": 1,  "incidentsOpen": 1,  "removed": 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.