Placeholder
Overview
| Description | Method | Endpoint |
|---|---|---|
| Create placeholder | POST |
/hosting/api/client/{clientId}/domain/{domainId}/placeholder |
| Overwrite all placeholders (bulk) | PUT |
/hosting/api/client/{clientId}/domain/{domainId}/placeholder |
| Read all placeholders | GET |
/hosting/api/client/{clientId}/domain/{domainId}/placeholder |
| read-placeholder | GET |
/hosting/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName} |
| update-placeholder | PUT |
/hosting/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName} |
| Remove placeholder | DELETE |
/hosting/api/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName} |
Create placeholder
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder
Method:POST
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the client account
Payload:Placeholder
Response:
201- Resource successfully created- Placeholder
400- Invalid or missing properties
Overwrite all placeholders (bulk)
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder
Method:PUT
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the client account
Payload:Placeholder[]
Response:
201- Resource(s) successfully created- Placeholder[]
400- Invalid or missing properties
Read all placeholders
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder
Method:GET
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the client account
Response:
200- Success- Placeholder[]
Read placeholder
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName}
Method:GET
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the customer account{placeholderName}: string - The name of the resource to be handled
Response:
200- Success- Placeholder
404- Resource not found
Update placeholder
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName}
Method:PUT
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the customer account{placeholderName}: string - The name of the resource to be handled
Payload:Placeholder
Response:
200- Success- Placeholder
400- Invalid or missing properties404- Resource not found
Remove placeholder
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/placeholder/{placeholderName}
Method:DELETE
Query:
{clientId}: string - The ID of a CCM19 client account{domainId}: string - The ID of a domain that exists in the customer account{placeholderName}: string - The name of the resource to be handled
Response:
204- Resource successfully deleted404- Resource not found