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, 14 more } >

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

Get deployment info

client.pages.projects.deployments.get(stringprojectName, stringdeploymentId, DeploymentGetParams { account_id } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 14 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, 14 more }

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

Delete deployment

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

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

Retry deployment

client.pages.projects.deployments.retry(stringprojectName, stringdeploymentId, DeploymentRetryParams { account_id } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 14 more }

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

Rollback deployment

client.pages.projects.deployments.rollback(stringprojectName, stringdeploymentId, DeploymentRollbackParams { account_id } params, RequestOptionsoptions?): Deployment { id, aliases, build_config, 14 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(stringprojectName, stringdeploymentId, LogGetParams { account_id } 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