Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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.comdoes 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
Not available yet. Sylphx Hosting is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/previews/{preview}. |
uid | string | prv_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | PreviewSpec | Desired state. Required. |
status | PreviewStatus | Observed 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a preview. |
GET | list | Lists previews in a environment. |
POST | create | Creates a preview. The Operation is done when the controller settles it. |
DELETE | delete | Deletes 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