API Reference

Pages

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deployments

Get deployments

client.pages.projects.deployments.list(stringprojectName, DeploymentListParams { account_id, env, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<Deployment { id, aliases, build_config, 15 more } >

GET/accounts/{account_id}/pages/projects/{project_name}/deployments

Get deployment info

client.pages.projects.deployments.get(stringdeploymentID, DeploymentGetParams { account_id, project_name } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 15 more }

GET/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}

Create deployment

client.pages.projects.deployments.create(stringprojectName, DeploymentCreateParams { account_id, _headers, _redirects, 11 more } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 15 more }

POST/accounts/{account_id}/pages/projects/{project_name}/deployments

Delete deployment

client.pages.projects.deployments.delete(stringdeploymentID, DeploymentDeleteParams { account_id, project_name, force } params, RequestOptionsoptions?): DeploymentDeleteResponse | null

DELETE/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}

Retry deployment

client.pages.projects.deployments.retry(stringdeploymentID, DeploymentRetryParams { account_id, project_name } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 15 more }

POST/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry

Rollback deployment

client.pages.projects.deployments.rollback(stringdeploymentID, DeploymentRollbackParams { account_id, project_name } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 15 more }

POST/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback

ModelsExpand Collapse

DeploymentDeleteResponse = unknown

DeploymentsHistory

DeploymentsHistoryLogs

Get deployment logs

client.pages.projects.deployments.history.logs.get(stringdeploymentID, LogGetParams { account_id, project_name } params, RequestOptionsoptions?): LogGetResponse { data, includes_container_logs, total }

GET/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs

ModelsExpand Collapse

LogGetResponse { data, includes_container_logs, total }

data: Array<Data>

line: string

ts: string

includes_container_logs: boolean

total: number

DeploymentsTails

Create deployment tail

client.pages.projects.deployments.tails.create(stringdeploymentID, TailCreateParams { account_id, project_name, filters } params, RequestOptionsoptions?): TailCreateResponse { id, url }

POST/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails

Delete deployment tail

client.pages.projects.deployments.tails.delete(stringtailID, TailDeleteParams { account_id, project_name, deployment_id } params, RequestOptionsoptions?): TailDeleteResponse | null

DELETE/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails/{tail_id}

ModelsExpand Collapse

TailCreateResponse { id, url }

A tail session for streaming logs from a Pages deployment.

id: string

Identifier of the tail session.

url?: string

Optional WebSocket URL to connect to for receiving tail events, when returned by the tail service.

TailDeleteResponse = unknown