POST Whitelisting Domain
Overview
The following table contains important information about the POST method for adding a whitelisting domain.
| POST Whitelisting Domain | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/whitelisting-domains |
| Headers | Authorization |
| Parameters | projectId |
| Body | domain |
The description of the URL parameters is as follows:
| projectId Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
{
"domain": "string"
}
Information about the fields that appear on the request body are displayed in the table below.
| Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| domain | Yes | string | The domain to be whitelisted. |
Response
{
"id": 0,
"domain": "string",
"insertDate": "2025-04-02T07:56:37.780Z",
"active": true
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| id | integer | The unique identifier of the whitelisting domain. |
| domain | string | The whitelisting domain. |
| insertDate | string (DateTime) | The date and time when the domain was inserted. |
| active | bool | Indicates if the domain is active. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed