Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Egress identities

An EgressIdentity is a declared, stable address set per region that a project's outbound traffic leaves from, so third parties can allowlist…

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.

An EgressIdentity is a declared, stable address set per region that a project's outbound traffic leaves from, so third parties can allowlist it. Traffic never leaves under an undeclared address: when the identity cannot serve, selected traffic is dropped.

Service Sylphx Network · Resource type network.sylphx.com/EgressIdentity · Name pattern orgs/{org}/projects/{project}/egress_identities/{egress_identity} · 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}/egress_identities/{egress_identity}.
uidstringegr_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specEgressIdentitySpecDesired state. Required.
statusEgressIdentityStatusObserved 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 an egress identity.
GETlistLists egress identitys in a project.
POSTcreateCreates an egress identity. The Operation is done when the controller settles it.
PATCHupdateUpdates an egress identity.
DELETEdeleteDeletes an egress identity.

#get

Gets an egress identity.

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

#list

Lists egress identitys in a project.

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

#create

Creates an egress identity. The Operation is done when the controller settles it.

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

#update

Updates an egress identity.

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

#delete

Deletes an egress identity.

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