---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Envs"
description: "The `envs` collection of Sylphx Access: An Environment is a deployment target inside a Project (production, preview, dev,...)."
type: reference
product: platform
summary: "An Environment is a deployment target inside a Project (production, preview, dev,...)."
updated: 2026-09-28
order: 900
---

> **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 Environment is a deployment target inside a Project (production, preview, dev,...). Its mode decides which keys may touch it.

**Service** Sylphx Access · **Resource type** `access.sylphx.com/Environment` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}`. |
| `uid` | `string` | `env_<cell><ulid>`; equals the name segment. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `EnvironmentSpec` | Desired state. Required. |
| `status` | `EnvironmentStatus` | 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`](/docs/api/envs#get) | Gets an environment. |
| `GET` | [`list`](/docs/api/envs#list) | Lists environments in a project. |
| `POST` | [`create`](/docs/api/envs#create) | Creates an environment. Access assigns the id. |
| `PATCH` | [`update`](/docs/api/envs#update) | Updates an environment. |
| `DELETE` | [`delete`](/docs/api/envs#delete) | Deletes an environment. |

## get

Gets an environment.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production` · scope `access:read` · effect `read` · [Request, response and examples](/docs/api/envs/get)

## list

Lists environments in a project.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs` · scope `access:read` · effect `read` · paginated · [Request, response and examples](/docs/api/envs/list)

## create

Creates an environment. Access assigns the id.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs` · scope `access:admin` · effect `write` · [Request, response and examples](/docs/api/envs/create)

## update

Updates an environment.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production` · scope `access:admin` · effect `write` · [Request, response and examples](/docs/api/envs/update)

## delete

Deletes an environment.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production` · scope `access:admin` · effect `destructive` · [Request, response and examples](/docs/api/envs/delete)