Custom Domain

You can configure a status page to use your own domain, such as status.example.com - once applied you will need to make some DNS changes your end to get things working.

Endpoint

https://api.sorryapp.com/v1/pages/:page_id/custom_domain

Objects

These are the attributes which represent the object, most of which can be posted too and received in response to the available methods.

Properties

Name
type
Description
The type of DNS record you need to create.
Name
from
Description
Where the DNS record should point from.
Name
to
Description
Where the DNS record should point to.
Name
created_at
Description
The date/time the record was created.
Name
updated_at
Description
The date/time the record was last updated.

POST/v1/pages/:page_id/custom_domain

Create a custom domain

This endpoint allows you to add a custom domain to a single status page.

Required attributes

Name
domain
Type
string
Description
The sub-domain to use for the status page

Request

POST

/v1/pages/12ab34cd/custom_domain

curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/custom_domain \
-d domain="status.acme.com" \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "type": "CNAME",
    "from": "status.acme.com",
    "to": "12ab34cd.sorryapp.com",
    "created_at": "2025-01-21 14:39:21 +0000",
    "updated_at": "2025-01-21 14:39:21 +0000"
}
}

GET/v1/pages/:page_id/custom_domain

Retrieve custom domain

This endpoint displays the current custom domain configured for a single status page.

Request

GET

/v1/pages/12ab34cd/custom_domain

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/custom_domain \
-H "Authorization: {token}"

Response

{
"response": {
    "type": "CNAME",
    "from": "status.acme.com",
    "to": "12ab34cd.sorryapp.com",
    "created_at": "2025-01-21 14:39:21 +0000",
    "updated_at": "2025-01-21 14:39:21 +0000"
}
}

DELETE/v1/pages/:page_id/custom_domain

Delete a page

This endpoint allows you to delete the custom domain.

Request

DELETE

/v1/pages/12ab34cd/custom_domain

curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd/custom_domain \
-H "Authorization: Bearer {token}"