Custom Domains: Delete

Straightforward guide for developers on how to delete an existing custom domain using the API, including the necessary headers and the expected behavior of the response.

Endpoint

DELETE /api/domains/{domain_id}

Delete an existing custom domain by its unique identifier.

Request

HTTP Request

DELETE https://uptimekeep.com/api/domains/{domain_id}

Replace {domain_id} with the ID of the custom domain you wish to delete.

Headers

Header
Type
Description

Authorization

String

Bearer token for API authentication.

Example of a request:

curl --request DELETE \
--url 'https://uptimekeep.com/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful request will result in the deletion of the specified custom domain. Typically, a 204 No Content status code is returned, indicating that the operation was successful and no content is returned in the response body.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the custom domain ID does not exist.

Last updated