Pages

Pages

Pages

Projects

Pages.Projects

Methods

list(, ): <>
get/accounts/{account_id}/pages/projects

Fetch a list of all user projects.

get(, , ):
get/accounts/{account_id}/pages/projects/{project_name}

Fetch a project by name.

create(, ):
post/accounts/{account_id}/pages/projects

Create a new project.

edit(, , ):
patch/accounts/{account_id}/pages/projects/{project_name}

Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.

delete(, , ): | null
delete/accounts/{account_id}/pages/projects/{project_name}

Delete a project by name.

purgeBuildCache(, , ): | null
post/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache

Purge all cached build artifacts for a Pages project

Domain types

Deployment{…}
Project{…}
Stage{…}

The status of the deployment.

PagesProjects

Deployments

Pages.Projects.Deployments

Methods

list(, , ): <>
get/accounts/{account_id}/pages/projects/{project_name}/deployments

Fetch a list of project deployments.

get(, , , ):
get/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}

Fetch information about a deployment.

create(, , ):
post/accounts/{account_id}/pages/projects/{project_name}/deployments

Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.

delete(, , , ): | null
delete/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}

Delete a deployment.

retry(, , , ):
post/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry

Retry a previous deployment.

rollback(, , , ):
post/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback

Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.

Pages.Projects.Deployments.History

Pages.Projects.Deployments.History.Logs

Methods

get(, , , ):
get/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs

Fetch deployment logs for a project.

Pages.Projects.Domains

Methods

list(, , ): <>
get/accounts/{account_id}/pages/projects/{project_name}/domains

Fetch a list of all domains associated with a Pages project.

get(, , , ):
get/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Fetch a single domain.

create(, , ):
post/accounts/{account_id}/pages/projects/{project_name}/domains

Add a new domain for the Pages project.

edit(, , , ):
patch/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Retry the validation status of a single domain.

delete(, , , ): | null
delete/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Delete a Pages project's domain.