Delete cluster Run in API Explorer

DELETE /v1/clusters/{id}
Auth0

Delete a Redpanda Cluster. Returns a long-running operation. See Use the Control Plane API for more information. Call GET /v1/operations/{id} to check operation state.

Path parameters

  • id string Required

Responses

  • 202 application/json

    Accepted

    Hide response attribute Show response attribute object
    • operation object

      Operation describes a long running operation

      Hide operation attributes Show operation attributes object
      • error object

        Describes errors

        Hide error attributes Show error attributes object
        • code string(int32)

          RPC status code, as described here.

          Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

        • details array[object]

          A list of messages that carries the error details.

          Details of the error.

          Details of the error.

          One of:
          BadRequest object ErrorInfo object QuotaFailure object Help object
        • message string

          Detailed error message. No compatibility guarantees are given for the text contained in this message.

      • finished_at string(date-time)

        Timestamp when the operation has finished.

      • id string

        ID of the operation.

      • metadata object

        Metadata of the long-running Operation. Contains in-progress information.

        One of:
        CreateNetworkMetadata object object-1 object CreateClusterMetadata object UpdateClusterMetadata object DeleteClusterMetadata object
      • resource_id string | null

      • response object

        Response of the long-running Operation.

        One of:
        CreateClusterResponse object UpdateClusterResponse object object-1 object CreateNetworkResponse object object-1 object
      • started_at string(date-time)

        Timestamp when the operation has started.

      • state string

        describes if the operation has finished, or is still in progress. Only if done is true, either error or result become available.

        Values are STATE_IN_PROGRESS, STATE_COMPLETED, or STATE_FAILED.

      • type string

        Values are TYPE_CREATE_CLUSTER, TYPE_UPDATE_CLUSTER, TYPE_DELETE_CLUSTER, TYPE_CREATE_NETWORK, TYPE_DELETE_NETWORK, TYPE_CREATE_SERVERLESS_CLUSTER, TYPE_DELETE_SERVERLESS_CLUSTER, TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES, or TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES.
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
      BadRequest object ErrorInfo object QuotaFailure object Help object
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.
  • 500 application/json

    Internal Server Error. Please reach out to support.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
      BadRequest object ErrorInfo object QuotaFailure object Help object
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.
DELETE /v1/clusters/{id} 
curl \
 --request DELETE 'https://api.redpanda.com/v1/clusters/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (202) 
{
  "operation": {
    "id": "cjd4vu1c4vs5ugb02itg",
    "type": "TYPE_DELETE_CLUSTER",
    "state": "STATE_IN_PROGRESS",
    "metadata": {
      "@type": "type.googleapis.com/redpanda.api.controlplane.v1.DeleteClusterMetadata",
      "required_action": ""
    },
    "started_at": null,
    "finished_at": null,
    "resource_id": "cjd3r21c4vs870t0ku30"
  }
}
Response examples (404) 
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (500) 
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}