Sign in
Switchover Endpoints (switchover/v1)

List of Switchover Endpoints

Changed on

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

Retrieve a sorted, filtered, paginated list of all switchover endpoints.

get/switchover/v1/switchover-endpoints

Request

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

Query parameters

switchover_pairstring

Filter a collection by a string search

Filter the results by the associated SwitchoverPair ID.

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.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Switchover Endpoint.

api_version'switchover/v1' required

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

kind'SwitchoverEndpointList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "pagination": {
      "page_size": 10,
      "total_size": 23
    }
  },
  "data": [
    {
      "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