Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx network private_links

Every sylphx network private_links command: its argument, its flags and a run line.

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.

The private_links commands of Sylphx Network, as the CLI spells them: the same calls as the private_links API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

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

#get

Gets a private link.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx network private-links get orgs/acme/projects/shop/envs/production/private_links/private-link

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link · scope network:read · effect read · Request, response and examples

#list

Lists private links in a environment.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx network private-links list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links · scope network:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels, filterable fields, and Ready.
--order-bystringAIP-132 ordering over filterable fields.

#create

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

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell
sylphx network private-links create --parent orgs/acme/projects/shop/envs/production --spec.service … --spec.region …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links · scope network:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.servicestringThe Hosting Service exposed. Required.
--spec.regionstringThe region of the link. Required.
--spec.allowed-consumersstringThe customer network accounts allowed to connect. Required. Repeat the flag for each value.
--dry-runboolValidate and print the result without writing (validate_only).
--no-waitboolReturn the call at once instead of waiting for it to finish.

#update

Updates a private link.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx network private-links update orgs/acme/projects/shop/envs/production/private_links/private-link

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link · scope network:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.allowed-consumersstringThe customer network accounts allowed to connect. Required. Repeat the flag for each value.
--allow-missingboolCreate the Resource when it does not exist (declarative upsert).
--dry-runboolValidate and print the result without writing (validate_only).
--no-waitboolReturn the call at once instead of waiting for it to finish.

#delete

Deletes a private link.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx network private-links delete orgs/acme/projects/shop/envs/production/private_links/private-link --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links/private-link · scope network:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the Resource does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--no-waitboolReturn the call at once instead of waiting for it to finish.
--yesboolDo not ask before this destructive call.