Api Domain API
Get all API domains
| Path | Method | Protected |
|---|---|---|
/v1/api/domains | GET | Yes |
Returns a list of API domains for the given project.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| project-id | string | Yes | - |
Example Response JSON
[
{
"projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
"domainName": "string",
"nameServers": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z"
}
]Create or update an API domain
| Path | Method | Protected |
|---|---|---|
/v1/api/domains | PUT | Yes |
Example Request JSON
{
"projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
"domainName": "string"
}Example Response JSON
{
"projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
"domainName": "string",
"nameServers": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z"
}Delete an API domain
| Path | Method | Protected |
|---|---|---|
/v1/api/domains | DELETE | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| project-id | string | Yes | - |
| domain | string | Yes | - |
Example Response JSON
"string"Api Domain API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | {"errors":["string"]} | |
| 401 | {"error":"string"} | |
| 403 | {"error":"string"} | |
| 404 | {"error":"string"} | |
| 409 | {"error":"string"} | |
| 500 | {"error":"string","workerError":{"cause":"string","stderr":"string"}} |