Submit a status report for a domain

POST

/installs/{install_id}/domains/{domain_id}/check_status

Submit a status report for a domain. Returns a report_id that can be used to check the domain’s status.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

domain_id

required

string format: uuid

ID of domain

Responses

202

Accepted

object

report_id

required

string format: uuid

Example

6a6d5dbd-5cac-41d5-8f3f-14a3e8ae6f76

401

Authentication Error

object

message

required

A message regarding the error that occurred on the server

string

Example

Bad Credentials

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

403

Not authorized

object

message

required

A message regarding the error that occurred on the server

string

Example

You don't have permission to perform that action

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

404

Not found

object

message

required

A message regarding the error that occurred on the server

string

Example

Not Found

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

429

Too many requests

object

message

required

A message regarding the error that occurred on the server

string

Example

Domain status checks are rate-limited to one request every 5 seconds for each install

500

Internal server error

object

message

required

A message regarding the error that occurred on the server

string

Example

An unexpected error occurred, please try again in a few minutes

503

Service unavailable