---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a secret binding"
description: "`secrets.secret_bindings.create` (POST /v1/{parent}/secret_bindings): Creates a secret binding."
type: reference
product: platform
summary: "Creates a secret binding."
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 a secret binding.

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

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment to create in. Required. |
| `secret_binding` | `SecretBinding` | The secret binding to create; only spec and caller-writable metadata are read. Required. |
| `secret_binding_id` | `string` | The id of the new secret binding, `^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$`; the server assigns one when empty. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### SecretBinding

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/secret_bindings/{secret_binding}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SecretBindingSpec` | 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. |

### SecretBindingSpec

| Field | Type | What it is |
| --- | --- | --- |
| `secret` | `string` | The Secret to deliver, in the same environment. Required. |
| `version` | `string` | A pinned version; unset delivers the Secret's latest enabled version. |
| `workload` | `string` | The name of the Resource that consumes the value, for example a Hosting service. Required. |
| `env_var` | `EnvVarDelivery` | As an environment variable. One of the `delivery` group. |
| `file` | `FileDelivery` | As a file. One of the `delivery` group. |
| `egress` | `EgressInjection` | By egress injection into outgoing requests. One of the `delivery` group. |

### EnvVarDelivery

| Field | Type | What it is |
| --- | --- | --- |
| `variable` | `string` | The variable name, for example `DATABASE_PASSWORD`. Required. |

### FileDelivery

| Field | Type | What it is |
| --- | --- | --- |
| `path` | `string` | The absolute path, for example `/run/secrets/tls.key`. Required. |

### EgressInjection

| Field | Type | What it is |
| --- | --- | --- |
| `hosts` | `string[]` | The hosts the value may be sent to, for example `api.example.com`. Required. |
| `header` | `string` | The request header to set, for example `Authorization`. Required. |
| `header_template` | `string` | The header value, with `{value}` standing for the Secret, for example `Bearer {value}`; default `{value}`. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/secret_bindings/{secret_binding}`. |
| `uid` | `string` | `scb_<cell><ulid>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SecretBindingSpec` | Desired state. Required. |
| `status` | `SecretBindingStatus` | 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. |

### SecretBindingSpec

| Field | Type | What it is |
| --- | --- | --- |
| `secret` | `string` | The Secret to deliver, in the same environment. Required. |
| `version` | `string` | A pinned version; unset delivers the Secret's latest enabled version. |
| `workload` | `string` | The name of the Resource that consumes the value, for example a Hosting service. Required. |
| `env_var` | `EnvVarDelivery` | As an environment variable. One of the `delivery` group. |
| `file` | `FileDelivery` | As a file. One of the `delivery` group. |
| `egress` | `EgressInjection` | By egress injection into outgoing requests. One of the `delivery` group. |

### SecretBindingStatus

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

### EnvVarDelivery

| Field | Type | What it is |
| --- | --- | --- |
| `variable` | `string` | The variable name, for example `DATABASE_PASSWORD`. Required. |

### FileDelivery

| Field | Type | What it is |
| --- | --- | --- |
| `path` | `string` | The absolute path, for example `/run/secrets/tls.key`. Required. |

### EgressInjection

| Field | Type | What it is |
| --- | --- | --- |
| `hosts` | `string[]` | The hosts the value may be sent to, for example `api.example.com`. Required. |
| `header` | `string` | The request header to set, for example `Authorization`. Required. |
| `header_template` | `string` | The header value, with `{value}` standing for the Secret, for example `Bearer {value}`; default `{value}`. |

### 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/production/secret_bindings" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"secret":"…","workload":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.secrets.secretBindings.create({ parent: 'orgs/acme/projects/shop/envs/production', secretBinding: { spec: { secret: '…', workload: '…' } } })
```

**Rust**

```rust
let mut req = sylphx::secrets::CreateSecretBindingRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.secret_binding = Some(sylphx::secrets::SecretBinding {
    spec: Some(sylphx::secrets::SecretBindingSpec {
        secret: "…".to_string(),
        workload: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
let response = sx.secrets().secret_bindings().create(req).await?;
```

**CLI**

```bash
sylphx secrets secret-bindings create --parent orgs/acme/projects/shop/envs/production --spec.secret … --spec.workload …
```

**Terraform**

```hcl
resource "sylphx_secrets_secret_binding" "secret_binding" {
  secret_binding_id = "secret_binding"
  parent            = "orgs/acme/projects/shop/envs/production"
  spec              = { secret = "…", workload = "…" }
}
```

**MCP**

```json
{ "method_id": "secrets.secret_bindings.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","secret_binding":{"spec":{"secret":"…","workload":"…"}}} }
```