Skip to main content
POST
Create environment variable

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

key
string
required

Environment variable name, unique within the workspace.

Maximum string length: 255
Pattern: ^[A-Z][A-Z0-9_]*$
value
string
required

Environment variable value.

Maximum string length: 8192
isSecret
boolean
required

When true, the value is encrypted at rest and never returned by the API.

description
string | null

Optional note about what this variable is for.

Maximum string length: 1000

Response

Create environment variable

envVar
Environment variable · object
required

Newly created environment variable.