Upsert an env entry

PUT

/v1/env/{name}

curl --request PUT \
  --url 'https://example.com/v1/env/example?envName=example&scopeKind=tenant' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope": { "kind": "tenant", "tenantId": "example" }, "envName": "example", "name": "example", "value": "example", "tags": { "additionalProperty": "example" }, "ifRevision": 1 }'

• Same-origin — path relative to the deployment root.

Requires the env:write capability. Every write bumps revision; optional ifRevision guards against concurrent updates (409 env-write-conflict).

Authorizations

• bearerAuth

Parameters

Path Parameters

name

required

string

>= 1 characters

Env entry name (opaque string within the tenant + envName).

Query Parameters

envName

required

Per-environment slug. [a-z][a-z0-9-]{0,62} — RFC-1035-like label.

string

/^[a-z][a-z0-9-]{0,62}$/

[a-z][a-z0-9-]{0,62}. Required on every env + secrets route.

scopeKind

required

Discriminator for the ?scopeKind + ?scopeId + ?inherit triplet. Tenant carries no id (implicit from session); org/project require scopeId.

string

Allowed values: tenant org project

Required on every env + secrets route. Tenant carries no scopeId; org / project require scopeId.

scopeId

string

>= 1 characters

Required IF scopeKind is org or project. MUST be absent if scopeKind=tenant (tenant is implicit from the session). Malformed combinations return 400 scope-invalid.

Header Parameters

Idempotency-Key

string

>= 1 characters

Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).

Request Body^required

Media typeapplication/json

object

scope

One of:

object

object

kind

required

string

Allowed values: tenant

tenantId

required

string

object

object

kind

required

string

Allowed values: org

tenantId

required

string

orgId

required

string

object

object

kind

required

string

Allowed values: project

tenantId

required

string

projectId

required

string

envName

Per-environment slug. [a-z][a-z0-9-]{0,62} — RFC-1035-like label.

string

/^[a-z][a-z0-9-]{0,62}$/

name

string

>= 1 characters

value

required

string

tags

object

key

additional properties

string

ifRevision

integer

Responses

200

Env record.

Media typeapplication/json

object

scope

required

One of:

object

object

kind

required

string

Allowed values: tenant

tenantId

required

string

object

object

kind

required

string

Allowed values: org

tenantId

required

string

orgId

required

string

object

object

kind

required

string

Allowed values: project

tenantId

required

string

projectId

required

string

envName

required

Per-environment slug. [a-z][a-z0-9-]{0,62} — RFC-1035-like label.

string

/^[a-z][a-z0-9-]{0,62}$/

name

required

string

value

required

string

revision

required

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

tags

object

key

additional properties

string

Example

{
  "scope": {
    "kind": "tenant"
  }
}

400

Malformed request body.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Bearer token missing env:write capability.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

409

ifRevision mismatch (env-write-conflict).

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

500

Server error (unmapped domain code or framework crash).

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}