Frontends

Get frontend details

Changed on Oct 7, 2026

get/projects/{id}/frontends/{frontendId}

Request

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

Path parameters

idstring uuid required

Project ID

frontendIdstring uuid required

Frontend ID

Response

Successful response

variable_scope'all' | 'shared' | 'scoped'

All preserves access to all project variables. Shared includes the project frontend shared-variable list. Scoped includes only explicitly declared variables in builds and runtime. Omission preserves the stored selection.

declared_variablesstring[]

Names selected when variable_scope is scoped. Missing declared values reject deployment. Omission preserves the stored list; an empty list clears it.

idstring uuid required

project_idstring uuid required

namestring required

framework'nextjs' required

app_rootstring

Optional relative POSIX path from the uploaded archive root to the Next.js app that is deployed.

status'provisioning' | 'active' | 'degraded' | 'failed' | 'deleting' required

Frontend lifecycle status. degraded means the regional runtime remains available but edge synchronization exhausted its immediate retries; Volcano retries edge recovery without rebuilding the frontend, and stops once a new deployment is queued or the retry budget runs out, leaving the frontend degraded until the next redeploy. A redeploy that fails over a serving frontend stays active on the previous deployment, so failed means no deployment is serving.

provisioning_started_atstring date-time

Timestamp when the current provisioning phase started

deployed_regionsstring[] required

current_deployment_idstring uuid

Identifier of the latest frontend deployment operation

pending_deployment_idstring uuid

Newest queued deployment that will run after the current operation

site_urlstring

custom_domainstring

Active custom domain hostname when configured

Current custom domain lifecycle status

last_invoked_atstring date-time

created_atstring date-time required

updated_atstring date-time required

Changes

Oct 7, 202623e7875e7c4c Revision changes
- ○
  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 required property to the response with the status
Sep 19, 20263a6f365f3f35 Revision changes
- ▲
  added the new path request parameter frontendId
- ▲
  added the new path request parameter id
- ▲
  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
- ▲
  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
- ▲
  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 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 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
- ○
  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

Operation history (4 revisions)