Sign in
Switchover Endpoints (switchover/v1)

Delete a Switchover Endpoint

Changed on

Early Access Request Access To Switchover API (Kafka Disaster Recovery)

Make a request to delete a switchover endpoint.

delete/switchover/v1/switchover-endpoints/{id}

Request

  • Base URL: https://api.confluent.cloud
  • URL: https://api.confluent.cloud/switchover/v1/switchover-endpoints/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP basic

Path parameters

idstring required

The unique identifier for the switchover endpoint.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the environment with this ID. The bare-ID form of environment_crn; it is the standard Confluent collection filter, passed as the ?environment= query parameter.

Response

The switchover endpoint deletion has been accepted; it transitions to DEPROVISIONING while it is removed asynchronously.

api_version'switchover/v1'

APIVersion defines the schema version of this representation of a resource.

kind'SwitchoverEndpoint'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/switchover/v1/switchover-endpoints/se-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/switchover-endpoint=se-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "environment_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000",
    "parent_resource_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000/switchover-pair=sw-00000",
    "display_name": "prod-kafka-dr-endpoint",
    "target": "west-platt",
    "endpoints": [
      {
        "name": "west-platt",
        "hostname": "lkc-west-platt.us-west-2.aws.private.confluent.cloud",
        "cloud": "aws",
        "region": "us-west-2",
        "connection_type": "PRIVATE_LINK",
        "endpoint_filter": {
          "type": "private",
          "network_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000/network=n-abc123",
          "access_point_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000/gateway=gw-456xyz/access-point=ap-west-xyz"
        }
      }
    ]
  },
  "status": {
    "phase": "READY",
    "conditions": [
      {
        "type": "ResourceProvisioningComplete",
        "status": "True",
        "reason": "Reconciled",
        "message": "The endpoint is ready."
      }
    ]
  }
}

Changes