arkyn

v3.0.1-beta.72

Delete domain

This feature allows you to remove an existing domain from the system.

Route

bash

DELETE /domain/:domainId

Authentication

This route requires authentication. A valid Bearer token must be included in the Authorization header of the request. The token must be obtained through the user authentication route.

bash

Authorization: Bearer <your-token-here>

Description

To delete a domain, you must provide the domainId as a parameter in the URL. The user must be the owner of the TrafficSource to which the domain belongs. Deleting a domain may affect associated log records.

Route Parameters

| Parameter | Type | Description | Required | | :--------- | :----- | :------------------------------ | :------- | | domainId | string | ID of the domain to be deleted. | Yes |

Success Response

Code: 204 No Content
Content: No content is returned in the response body.

Error Responses

  • Code: 400 Bad Request
    • Reason: The provided domainId is invalid.
    • Reason: Authentication token missing.
  • Code: 401 Unauthorized
    • Reason: The requester is not authenticated.
    • Reason: The provided token is invalid.
  • Code: 403 Forbidden
    • Reason: The requester does not have permission to delete this domain.
  • Code: 404 Not Found
    • Reason: No domain was found with the provided domainId.
    • Reason: No traffic source was found with the trafficSourceId belonging to the domain.
  • Code: 500 Internal Server Error
    • Reason: An unexpected server error occurred.
On this page