Replace environment variables

PUT

/api/apps/{id}/environments/{envId}/variables

curl --request PUT \
  --url https://opfield.example.com/api/apps/550e8400-e29b-41d4-a716-446655440000/environments/550e8400-e29b-41d4-a716-446655440000/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "variables": [ { "key": "example", "value": "example" } ] }'

• Your Opfield instance

Environment variables and secrets every container, deployment and Compose project of the environment receives on its next create, recreate, deploy or apply (nothing restarts on save). Precedence, lowest first: image ENV, environment variables, environment secrets, the workload own environment, the workload own secrets. Keys match ^[A-Za-z_][A-Za-z0-9_]*$, at most 200 per environment, values up to 32 KiB; a key is either a variable or a secret. Secrets are write-only: only keys and update times are returned. pendingWorkloads lists the workloads that still run older values ({kind: container|deployment|compose, id, nodeId, name}; containers by name) so a client can recreate or redeploy them one at a time; a container recreate is queued on its node, follow its taskId with GET …/workload-tasks/{taskId}. Needs apps:env:manage on the environment. The body is the full set of variables (secrets are not touched).

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

envId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

variables

required

Array<object>

<= 200 items

object

key

required

string

>= 1 characters <= 255 characters

value

required

string

Example^generated

{
  "variables": [
    {
      "key": "example",
      "value": "example"
    }
  ]
}

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}