Sign in
Projects

Apply project configuration

Changed on

Validates and applies a declarative configuration manifest to the project, reconciling each declared section and returning a per-resource report. Omitted sections are untouched. Declared collection keys (variables, buckets[].policies, auth.providers.oauth, auth.email.templates, functions[].schedulers) are fully synced: resources absent from the manifest are deleted. Functions, frontends, databases, and buckets are never created or deleted; manifest entries for resources that do not exist are skipped and reported in skipped, and existing resources missing from a declared section are reported in missing. Validation failures (including plan-gate violations) return 422 and nothing is applied. Set dry_run=true to get the projected report without applying changes. Applies are serialized per project; a concurrent apply returns 409.

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

dry_runboolean

Validate and report projected actions without applying changes.

Request body

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.

Response

Apply report. Individual entries may still carry action: error for apply-phase failures (summary.errors > 0); already-applied changes are not rolled back.

dry_runboolean

True when the request was a dry run and no changes were made.

Changes

  • 09b595274deaRevision changes
    • ●

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

    • ●

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

    • ○

      added the new optional request property

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the new optional request property

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      added the new optional request property //

    • ○

      request property // deprecated

    • ○

      added the new 17 enum value to the request property //

    • ○

      added the new 18 enum value to the request property //