Delete allocatoredit
Deletes the allocator.
Requestedit
DELETE /api/v1/platform/infrastructure/allocators/{allocator_id}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The allocator identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Removes the instances from the deleted allocator. |
Responsesedit
-
200 -
(
EmptyResponse) The allocator specified by {allocator_id} was successfully deleted -
400 -
(
BasicFailedReply) * The allocator specified by {allocator_id} could not be deleted. (code:allocators.delete_connected_allocator_attempt) * The allocator specified by {allocator_id} could not be deleted. (code:allocators.delete_allocator_with_instances_attempt)Headers
-
x-cloud-error-codes(string; allowed values: [allocators.delete_connected_allocator_attempt,allocators.delete_allocator_with_instances_attempt]) - The error codes associated with the response
-
-
404 -
(
BasicFailedReply) The allocator specified by {allocator_id} cannot be found. (code:allocators.allocator_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [allocators.allocator_not_found]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XDELETE {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id} \
-H "Authorization: ApiKey $ECE_API_KEY"