Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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.comdoes 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
sylphx network private-links get orgs/acme/projects/shop/envs/production/private_links/private-linkGET 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
sylphx network private-links list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/private_links · scope network:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels, filterable fields, and Ready. |
--order-by | string | AIP-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
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
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.service | string | The Hosting Service exposed. Required. |
--spec.region | string | The region of the link. Required. |
--spec.allowed-consumers | string | The customer network accounts allowed to connect. Required. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return 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
sylphx network private-links update orgs/acme/projects/shop/envs/production/private_links/private-linkPATCH 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
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.allowed-consumers | string | The customer network accounts allowed to connect. Required. Repeat the flag for each value. |
--allow-missing | bool | Create the Resource when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return 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
sylphx network private-links delete orgs/acme/projects/shop/envs/production/private_links/private-link --yesDELETE 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
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the Resource does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
--yes | bool | Do not ask before this destructive call. |