---
title: "List of Endpoints"
method: GET
path: "/endpoint/v1/endpoints"
tags: ["Endpoints (endpoint/v1)"]
---

# List of Endpoints

`GET /endpoint/v1/endpoints`

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

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

## Query parameters

- `cloud` string — Filter a collection by a string search
- `region` string — Filter a collection by a string search
- `service` string, required — Filter a collection by a string search
- `is_private` boolean — Filter for whether this value is true or false.
- `environment` string, required — Filter a collection by a string search
- `resource` string — Filter a collection by a string search
- `page_size` integer
- `page_token` string

## Response `200`

Endpoint.

- object — An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource via a specific networking solution for a given Confluent Cloud environment. This API provides a list of Confluent Cloud endpoints filtered by service, cloud provider, region, etc. Related guides: * [Resource Overview in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/resource-overview.html). * [Manage Networking on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). ## The Endpoints Model <SchemaDefinition schemaRef="#/components/schemas/endpoint.v1.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.
  - `metadata` object, required — ListMeta describes metadata that resource collections may have
    - `first` string, uri, nullable — A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported.
    - `last` string, uri, nullable — A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported.
    - `prev` string, uri, nullable — A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported.
    - `next` string, uri, nullable — A link to the next page of results. If a response does not contain a next link, then there is no more data available.
    - `total_size` integer — Number of records in the full result set. This response may be paginated and have a smaller number of records.
  - `data` object[], required — A data property that contains an array of resource items. Each entry in the array is a separate resource.
    - `api_version` 'endpoint/v1' — APIVersion defines the schema version of this representation of a resource.
    - `kind` 'Endpoint' — Kind defines the object this REST resource represents.
    - `id` string, required — 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").
    - `metadata` object, required — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
      - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
      - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
      - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
      - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
      - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
    - `cloud` string, required — The cloud service provider.
    - `region` string, required — The cloud service provider region in which the resource is located.
    - `service` string, required — The Confluent Cloud service.
    - `is_private` boolean, required — Whether the endpoint is private (true) or public (false).
    - `connection_type` string, required — The network connection type.
    - `endpoint` string, required — The endpoint URL or address.
    - `endpoint_type` string, required — The endpoint type enum values: * `REST` - REST API endpoint for HTTP/HTTPS access, used by Kafka/Flink/Schema Registry services. * `BOOTSTRAP` - Kafka native protocol bootstrap servers for direct client connections, used by Kafka only. * `LANGUAGE_SERVICE` - Flink language service endpoint for SQL/Table API, used by Flink only.
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `resource` object — The resource associated with the endpoint. The resource can be one of Kafka Cluster ID (example: lkc-12345), or Schema Registry Cluster ID (example: lsrc-12345). May be null or omitted if not associated with a resource.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `gateway` object — The gateway to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `access_point` object — The access_point to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)