Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Private links

A PrivateLink lets a customer network reach a Service without the public internet.

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/private_links/{private_link}.
uidstringplk_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specPrivateLinkSpecDesired state. Required.
statusPrivateLinkStatusObserved 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.

MethodCallWhat it does
GETgetGets a private link.
GETlistLists private links in a environment.
POSTcreateCreates a private link. The Operation is done when the controller settles it.
PATCHupdateUpdates a private link.
DELETEdeleteDeletes 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

#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

#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

#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

#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