---
title: "Read a Network Link Service"
method: GET
path: "/networking/v1/network-link-services/{id}"
tags: ["Network Link Services (networking/v1)"]
---

# Read a Network Link Service

`GET /networking/v1/network-link-services/{id}`

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

Make a request to read a network link service.

## Path parameters

- `id` string, required

## Query parameters

- `environment` string, required — Filter a collection by a string search

## Response `200`

Network Link Service.

- object — Network Link Service is associated with a Private Link Confluent Cloud Network. It enables connectivity from other Private Link Confluent Cloud Networks based on the configured accept policies. Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). ## The Network Link Services Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.NetworkLinkService" /> ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `network_link_service_per_network` | Number of network link services per network |
  - `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'NetworkLinkService', required — 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 — 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 Service
    - `display_name` string — The name of the network link service
    - `description` string — The description of the network link service
    - `accept` NetworkingV1NetworkLinkServiceAcceptPolicy — List of environments/networks from which connections can be accepted on this network link service.
      - `environments` string[] — List of environments from which connections can be accepted. All networks win the list of environment will be allowed.
      - `networks` string[] — List of networks from which connections can be accepted.
    - `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
  - `status` NetworkingV1NetworkLinkServiceStatus, required — The status of the Network Link Service
    - `phase` string, required — The lifecycle phase of the network link service: READY: network link service is ready;
    - `error_code` string — Error code if network link service is in a failed state. May be used for programmatic error checking.
    - `error_message` string — Displayable error message if network link service is in a failed state

## 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
- `404` — Not Found
- `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)