Sign in
Projects

Export project configuration

Changed on

Exports the project's current user-facing configuration as a declarative manifest. Returns JSON by default. Request the canonical volcano-config.yaml rendering with Accept: application/yaml or ?format=yaml; the YAML is returned verbatim as the raw response body (Content-Type: application/yaml) and is meant to be saved as-is. Variable values and write-only secrets (SMTP password, OAuth client secrets, TLS material) are omitted from the export; shared_variables and frontend_shared_variables contain names only; the YAML rendering adds a header comment describing how to set them via CLI environment interpolation.

get/projects/{id}/config

Request

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

Path parameters

idstring uuid required

Project ID

Query parameters

format'json' | 'yaml'

Response format override. Takes precedence over the Accept header.

Response

Current project configuration. JSON by default; when YAML is requested the body is the canonical volcano-config.yaml document served verbatim with Content-Type: application/yaml.

version1 required

Manifest schema version. Must be 1.

shared_variablesstring[]

Replace the complete shared function-variable list with existing names, without changing variable values. Omission keeps membership unchanged; an empty list clears it.

frontend_shared_variablesstring[]

Replace the complete shared frontend-variable list with existing names. Frontends with variable_scope shared receive this list. Omission keeps membership unchanged; an empty list clears it.

Changes

  • 09b595274deaRevision changes
    • ○

      added the optional property to the response with the status

  • 23e7875e7c4cRevision changes
    • ●

      added the new 17 enum value to the // response property for the response status

    • ●

      added the new 18 enum value to the // response property for the response status

    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      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

    • ○

      response property functions/items/public deprecated