---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create an env"
description: "`access.envs.create` (POST /v1/{parent}/envs): Creates an environment."
type: reference
product: platform
summary: "Creates an environment."
updated: 2026-09-28
nav: false
---

> **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.

Creates an environment. Access assigns the id.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs`
- **Scope** `access:admin`
- **Effect** `write` — a successful call changes state.
- **Collection** [envs](/docs/api/envs)
- **Query** `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `environment` | `Environment` | The environment to create; only spec and caller-writable metadata are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Environment

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `EnvironmentSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### EnvironmentSpec

| Field | Type | What it is |
| --- | --- | --- |
| `slug` | `string` | Unique within the project, for example `production`. Required. |
| `mode` | `EnvironmentMode` | Live or test; a test key never touches a live environment. Required. One of `live`, `test`. |

## Response

| 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. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### EnvironmentSpec

| Field | Type | What it is |
| --- | --- | --- |
| `slug` | `string` | Unique within the project, for example `production`. Required. |
| `mode` | `EnvironmentMode` | Live or test; a test key never touches a live environment. Required. One of `live`, `test`. |

### EnvironmentStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"mode":"live","slug":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.access.envs.create({ environment: { spec: { mode: 'live', slug: '…' } }, parent: 'orgs/acme/projects/shop' })
```

**Rust**

```rust
let mut req = sylphx::access::CreateEnvironmentRequest::default();
req.environment = Some(sylphx::access::Environment {
    spec: Some(sylphx::access::EnvironmentSpec {
        mode: sylphx::access::EnvironmentMode::Live,
        slug: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
req.parent = "orgs/acme/projects/shop".to_string();
let response = sx.access().envs().create(req).await?;
```

**CLI**

```bash
sylphx access envs create --parent orgs/acme/projects/shop --spec.slug … --spec.mode live
```

**Terraform**

```hcl
resource "sylphx_access_environment" "environment" {
  parent = "orgs/acme/projects/shop"
  spec   = { mode = "live", slug = "…" }
}
```

**MCP**

```json
{ "method_id": "access.envs.create", "args": {"environment":{"spec":{"mode":"live","slug":"…"}},"parent":"orgs/acme/projects/shop"} }
```