Delete allocator

DELETE /platform/infrastructure/allocators/{allocator_id}

Deletes the allocator.

Path parameters

Query parameters

  • remove_instances boolean

    Removes the instances from the deleted allocator.

    Default value is false.

Responses

  • 200

    The allocator specified by {allocator_id} was successfully deleted

    Additional properties are allowed.
  • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are allocators.delete_connected_allocator_attempt or allocators.delete_allocator_with_instances_attempt.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 404

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is allocators.allocator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /platform/infrastructure/allocators/{allocator_id} 
curl \
 -X DELETE https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}
Response examples (200) 
{}
Response examples (400) 
# Headers
x-cloud-error-codes: allocators.delete_connected_allocator_attempt

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
# Headers
x-cloud-error-codes: allocators.allocator_not_found

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