Skip to main content
PATCH
Update 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"

Path Parameters

uuid
string<uuid>
required

Environment variable identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

value
string

New value. Omit to keep the stored value, which is how a secret is left untouched.

Maximum string length: 8192
isSecret
boolean

Whether the value is encrypted at rest. Flipping this re-writes the stored value.

description
string | null

Optional note about what this variable is for.

Maximum string length: 1000

Response

Update environment variable

envVar
Environment variable · object
required

Updated environment variable.