Sign in
Projects

Update project metadata and region policy

Changed on
patch/projects/{id}

Request

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

Path parameters

idstring uuid required

Project ID

Request body

namestring
all_regionsboolean

If omitted and selected_regions is also omitted, existing region policy is preserved. If selected_regions is provided without all_regions, it is treated as subset mode.

selected_regionsstring[]

Region subset for project deployments. Provide with all_regions=false.

Example request

{
  "name": "my-awesome-app-renamed",
  "selected_regions": [
    "us-east-1"
  ]
}

Response

Project updated

idstring uuid required
namestring required
status'active' | 'deleting' | 'failed' required
plan'HOBBY' | 'SUPERAGENT'

Plan name applied to the project when available.

all_regionsboolean required

Region policy for function deployment.

  • true: deploy functions to all configured platform regions
  • false: deploy only to selected_regions
selected_regionsstring[] required

Effective region set for this project (normalized and deduplicated)

last_invoked_atstring date-time

Most recent activity timestamp across project resources

logo_urlstring

Relative API path that serves the project logo when one has been uploaded. The path is versioned with a ?v= cache-busting query param that changes on each upload. Absent when the project has no logo. The logo image is stored in the project's storage folder.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "logo_url": "/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo?v=1718524800"
}

Changes

  • 23e7875e7c4cRevision changes
    • ●

      removed the optional property from the response with the status

    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the optional property to the response with the status

  • e4c43efdab33Revision changes
    • ○

      removed the FREE enum value from the response property for the response status

    • ○

      removed the PRO enum value from the response property for the response status