A newer version is available. For the latest information, see the
current release documentation.
Delete allocator
editDelete allocator
editDeletes the allocator.
Request
editDELETE /api/v1/platform/infrastructure/allocators/{allocator_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The allocator identifier. |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Removes the instances from the deleted allocator. |
Responses
edit-
200 -
The allocator specified by {allocator_id} was successfully deleted
-
400 -
-
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
-
The allocator specified by {allocator_id} could not be deleted. (code:
-
404 -
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 -
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
-
Request example
editcurl -XDELETE https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id} \
-H "Authorization: ApiKey $ECE_API_KEY"