Delete allocator

Auth

Deletes the allocator.

Path parameters

remove_instances boolean · default: false: Removes the instances from the deleted allocator.

The allocator specified by {allocator_id} was successfully deleted

application/json

Response Type: object

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)

application/json

The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X DELETE "${API_URL}/platform/infrastructure/allocators/${ALLOCATOR_ID}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec