Projects
A Project groups environments and the Resources in them.
A Project groups environments and the Resources in them.
Service Sylphx Access · Resource type access.sylphx.com/Project · Name pattern orgs/{org}/projects/{project} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}. |
uid | string | prj_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ProjectSpec | Desired state. Required. |
status | ProjectStatus | 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 project. |
GET | list | Lists projects in an org. Filter by spec.declared_key to resolve a declared project, then list its envs and Hosting services by resource name. Results default to 50 per page (maximum 1000), ordered by slug then name. Non-empty order_by is refused until custom ordering is supported. |
POST | create | Creates a project. Access assigns the id. |
PATCH | update | Updates a project. |
DELETE | delete | Deletes a project. |
get
Gets a project.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:read · effect read · Request, response and examples
list
Lists projects in an org. Filter by spec.declared_key to resolve a declared project, then list its envs and Hosting services by resource name. Results default to 50 per page (maximum 1000), ordered by slug then name. Non-empty order_by is refused until custom ordering is supported.
GET https://api.sylphx.com/v1/orgs/acme/projects · scope access:read · effect read · paginated · Request, response and examples
create
Creates a project. Access assigns the id.
POST https://api.sylphx.com/v1/orgs/acme/projects · scope access:admin · effect write · Request, response and examples
update
Updates a project.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect write · Request, response and examples
delete
Deletes a project.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect destructive · Request, response and examples