Sign in
Endpoints (endpoint/v1)

List of Endpoints

General Availability

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

get/endpoint/v1/endpoints

Query parameters

cloudstring

Filter a collection by a string search

Filter the results by exact match for cloud.

regionstring

Filter a collection by a string search

Filter the results by exact match for region.

servicestring required

Filter a collection by a string search

Filter the results by exact match for service.

is_privateboolean

Filter for whether this value is true or false.

Filter the results by whether the endpoint is private (true) or public (false). If not specified, returns both private and public endpoints.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

resourcestring

Filter a collection by a string search

Filter the results by exact match for resource.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Endpoint.

api_version'endpoint/v1' required

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

kind'EndpointList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/endpoint/v1/endpoints",
    "last": "https://api.confluent.cloud/endpoint/v1/endpoints?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/endpoint/v1/endpoints?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/endpoint/v1/endpoints?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/endpoint/v1/endpoints/e-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/endpoint=e-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"
      },
      "cloud": "AWS",
      "region": "us-west-2",
      "service": "KAFKA",
      "is_private": true,
      "connection_type": "PRIVATE_LINK",
      "endpoint": "https://lkc-abc123-ap12345.us-west-2.aws.accesspoint.glb.confluent.cloud:443",
      "environment": {
        "id": "env-00000",
        "related": "https://api.confluent.cloud/v2/environments/env-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
      },
      "resource": {
        "id": "lkc-abc123",
        "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-abc123",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-abc123"
      },
      "gateway": {
        "id": "gw-00000",
        "related": "https://api.confluent.cloud/networking/v1/gateways/gw-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000"
      },
      "access_point": {
        "id": "ap-00000",
        "related": "https://api.confluent.cloud/networking/v1/access-points/ap-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/access-point=ap-00000"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.