---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Private links"
description: "The `private_links` collection of Sylphx Network: A PrivateLink lets a customer network reach a Service without the public internet."
type: reference
product: network
summary: "A PrivateLink lets a customer network reach a Service without the public internet."
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A PrivateLink lets a customer network reach a Service without the public internet. Established links keep carrying traffic while the control plane is impaired; only changes wait.

**Service** Sylphx Network · **Resource type** `network.sylphx.com/PrivateLink` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/private_links/{private_link}` · **Shape** `spec_status`

**Not available yet.** Sylphx Network is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/private_links/{private_link}`. |
| `uid` | `string` | `plk_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `PrivateLinkSpec` | Desired state. Required. |
| `status` | `PrivateLinkStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/private_links#get) | Gets a private link. |
| `GET` | [`list`](/docs/api/private_links#list) | Lists private links in a environment. |
| `POST` | [`create`](/docs/api/private_links#create) | Creates a private link. The Operation is done when the controller settles it. |
| `PATCH` | [`update`](/docs/api/private_links#update) | Updates a private link. |
| `DELETE` | [`delete`](/docs/api/private_links#delete) | Deletes a private link. |

## get

Gets a private link.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link` · scope `network:read` · effect `read` · not available yet · [Request, response and examples](/docs/api/private_links/get)

## list

Lists private links in a environment.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links` · scope `network:read` · effect `read` · not available yet · paginated · [Request, response and examples](/docs/api/private_links/list)

## create

Creates a private link. The Operation is done when the controller settles it.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links` · scope `network:write` · effect `write` · not available yet · long-running · [Request, response and examples](/docs/api/private_links/create)

## update

Updates a private link.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link` · scope `network:write` · effect `write` · not available yet · long-running · [Request, response and examples](/docs/api/private_links/update)

## delete

Deletes a private link.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link` · scope `network:write` · effect `destructive` · not available yet · long-running · [Request, response and examples](/docs/api/private_links/delete)