Skip to content
Console
On this page

Routes

A Route sends one exact host and path prefix to one backend.

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 Route sends one exact host and path prefix to one backend. Every destination has its own Route; a wildcard grants no authority. Overlapping (host, path prefix) pairs are refused.

Service Sylphx Network · Resource type network.sylphx.com/Route · Name pattern orgs/{org}/projects/{project}/envs/{env}/routes/{route} · 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}/routes/{route}.
uidstringrte_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specRouteSpecDesired state. Required.
statusRouteStatusObserved 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 route.
GETlistLists routes in a environment.
POSTcreateCreates a route. The Operation is done when the controller settles it.
PATCHupdateUpdates a route.
DELETEdeleteDeletes a route.

get

Gets a route.

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

list

Lists routes in a environment.

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

create

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

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

update

Updates a route.

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

delete

Deletes a route.

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