Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx network domains

Every sylphx network domains 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 domains commands of Sylphx Network, as the CLI spells them: the same calls as the domains 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 domain.

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

CLI

Shell
sylphx network domains get orgs/acme/projects/shop/domains/domain

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

#list

Lists domains in a project.

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

CLI

Shell
sylphx network domains list orgs/acme/projects/shop

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/domains · 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 domain. 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 domains create --parent orgs/acme/projects/shop --spec.domain-name …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/domains · 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.domain-namestringThe fully qualified name, for example example.com. Wildcards are refused. Required.
--spec.verification-methodenumHow control is proven; default TXT. One of txt, cname.
--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 domain.

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

CLI

Shell
sylphx network domains update orgs/acme/projects/shop/domains/domain

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/domains/domain · 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.verification-methodenumHow control is proven; default TXT. One of txt, cname.
--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 domain.

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

CLI

Shell
sylphx network domains delete orgs/acme/projects/shop/domains/domain --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/domains/domain · 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.

#verify

Checks the verification record now instead of at the next sweep.

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

CLI

Shell
sylphx network domains verify orgs/acme/projects/shop/domains/domain

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/domains/domain:verify · scope network:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--no-waitboolReturn the call at once instead of waiting for it to finish.