Skip to content
Console
On this page

Previews

A Preview is a pull request's own deployment of a Service, built and torn down by the same Git flow.

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 Preview is a pull request's own deployment of a Service, built and torn down by the same Git flow.

Service Sylphx Hosting · Resource type hosting.sylphx.com/Preview · Name pattern orgs/{org}/projects/{project}/envs/{env}/previews/{preview} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/previews/{preview}.
uidstringprv_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specPreviewSpecDesired state. Required.
statusPreviewStatusObserved 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 preview.
GETlistLists previews in a environment.
POSTcreateCreates a preview. The Operation is done when the controller settles it.
DELETEdeleteDeletes a preview.

get

Gets a preview.

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

list

Lists previews in a environment.

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

create

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

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

delete

Deletes a preview.

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