---
title: "List of Network Link Endpoints"
method: GET
path: "/networking/v1/network-link-endpoints"
tags: ["Network Link Endpoints (networking/v1)"]
---

# List of Network Link Endpoints

`GET /networking/v1/network-link-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 network link endpoints.

## Query parameters

- `spec.display_name` string[] — Filter a collection by a string search for one or more values
- `status.phase` string[] — Filter a collection by a string search for one or more values
- `environment` string, required — Filter a collection by a string search
- `spec.network` string[] — Filter a collection by a string search for one or more values
- `spec.network_link_service` string[] — Filter a collection by a string search for one or more values
- `page_size` integer
- `page_token` string

## Response `200`

Network Link Endpoint.

- object — A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a Network Link Service (associated with another Private Link Confluent Cloud Network) at the target. It enables connectivity between the origin network and the target network. It can only be associated with a Private Link network. Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). ## The Network Link Endpoints Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.NetworkLinkEndpoint" /> ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `network_link_endpoints_per_network` | Number of network link endpoints per network |
  - `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'NetworkLinkEndpointList', 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` 'networking/v1' — APIVersion defines the schema version of this representation of a resource.
    - `kind` 'NetworkLinkEndpoint' — 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.
    - `spec` object, required — The desired state of the Network Link Endpoint
      - `display_name` string — The name of the network link endpoint
      - `description` string — The description of the network link endpoint
      - `environment` object, required — The environment to which this belongs.
        - `id` string, required — ID of the referred resource
        - `related` string, uri, required — API URL for accessing or modifying the referred object
        - `resource_name` string, uri, required — CRN reference to the referred resource
      - `network` object, required — The network 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
      - `network_link_service` object, required — The network_link_service 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
    - `status` NetworkingV1NetworkLinkEndpointStatus, required — The status of the Network Link Endpoint
      - `phase` string, required — The lifecycle phase of the network link endpoint: PROVISIONING: network link endpoint provisioning is in progress; PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; READY: network link endpoint is ready; FAILED: network link endpoint is in a failed state; DEPROVISIONING: network link endpoint deprovisioning is in progress; EXPIRED: network link endpoint request is expired, can only be deleted; DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; DISCONNECTING: network link endpoint disconnection is in progress; INACTIVE: network link endpoint is created, but not active since there are no clusters in the network;
      - `error_code` string — Error code if network link is in a failed state. May be used for programmatic error checking.
      - `error_message` string — Displayable error message if network link is in a failed state
      - `expires_at` string, date-time — The date and time when the request expires if it is not accepted by the target network admin.

## 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)