Variables

Create or update a variable

Changed on

Creates a project-level environment variable and triggers asynchronous propagation to deployed functions and frontends in the project's configured regions.

post/projects/{id}/variables

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/variables
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

sharedboolean

Include this name in the project's shared function variables. Omission preserves existing membership; new variables default to true for legacy clients. Send false explicitly to create a non-shared variable.

namestring required

Project variable name. Function runtime names such as AWS_REGION are reserved and return 400; see the environment variables guide for the full list.

valuestring required

Response

Variable created

sharedboolean

Include this name in the project's shared function variables. Omission preserves existing membership; new variables default to true for legacy clients. Send false explicitly to create a non-shared variable.

frontend_sharedboolean

Whether this name is in the project's shared frontend-variable list.

idstring uuid required
project_idstring uuid required
namestring required
valuestring required
status'provisioning' | 'active' | 'failed'

Latest project variable propagation status, when a sync has run.

current_sync_idstring uuid

Identifier of the latest variable propagation sync.

provisioning_started_atstring date-time

Timestamp when the current variable propagation phase started.

deploy_source'git' | 'cli' | 'web' | 'api' | 'system' | 'unknown'

What initiated the latest variable propagation sync, when one has run.

created_atstring date-time required
updated_atstring date-time required

Changes

    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the optional property to the response with the status

    • ▲

      added the new path request parameter id

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the new optional request property

    • ○

      added the non-success response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status