Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Domains

A Domain is a name a project controls.

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 Domain is a name a project controls. It is verified once, before any certificate or Route uses it; verification is fail-closed. The id is the domain with dots as dashes; spec.domain_name is the name itself.

Service Sylphx Network · Resource type network.sylphx.com/Domain · Name pattern orgs/{org}/projects/{project}/domains/{domain} · 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}/domains/{domain}.
uidstringdom_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specDomainSpecDesired state. Required.
statusDomainStatusObserved 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 domain.
GETlistLists domains in a project.
POSTcreateCreates a domain. The Operation is done when the controller settles it.
PATCHupdateUpdates a domain.
DELETEdeleteDeletes a domain.
POSTverifyChecks the verification record now instead of at the next sweep.

#get

Gets a domain.

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

#list

Lists domains in a project.

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

#create

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

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/domains · scope network:write · effect write · not available yet · long-running · Request, response and examples

#update

Updates a domain.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/domains/domain · scope network:write · effect write · not available yet · long-running · Request, response and examples

#delete

Deletes a domain.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/domains/domain · scope network:write · effect destructive · not available yet · long-running · Request, response and examples

#verify

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

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