Sign in
Variables

Get variable by name

Changed on

Returns a project-level environment variable used by deployed functions and frontends.

get/projects/{id}/variables/{name}

Request

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

Path parameters

idstring uuid required

Project ID

namestring required

Variable name. Function runtime names such as AWS_REGION are reserved and cannot be updated.

Response

Successful response

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

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the optional property to the response with the status

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      added the new path request parameter name

    • ▲

      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 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