IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Delete allocator

edit

Delete allocator

edit

Deletes the allocator.

Request

edit

DELETE /api/v1/platform/infrastructure/allocators/{allocator_id}

Path parameters

edit

Name	Type	Required	Description
`allocator_id`	`string`	Y	The allocator identifier.

Query parameters

edit

Name	Type	Required	Description
`remove_instances`	`boolean`; default: `false`	N	Removes the instances from the deleted allocator.

Responses

edit

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

Request example

edit

curl -XDELETE https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Search allocators Get allocator »