Cloudflare API | Pages › Projects

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME \
    -X DELETE \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {},
  "success": false
}

Update Project -> Envelope<

Project

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.

Get Project -> Envelope<

Project

get/accounts/{account_id}/pages/projects/{project_name}

Fetch a project by name.

Get Projects -> SinglePage<

Deployment

get/accounts/{account_id}/pages/projects

Fetch a list of all user projects.

Purge Build Cache -> Envelope<unknown>

post/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache

Purge all cached build artifacts for a Pages project

Domain types

Deployment = { id, aliases, build_config, 13 more... }

Project = { id, build_config, canonical_deployment, 8 more... }

Stage = { ended_on, name, started_on, 1 more... }

Pages Projects

Deployments

pages.projects.deployments

Methods

Create Deployment -> Envelope<

Deployment

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 Deployment -> Envelope<unknown>

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

Delete a deployment.

Get Deployment Info -> Envelope<

Deployment

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

Fetch information about a deployment.

Get Deployments -> SinglePage<

Deployment

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

Fetch a list of project deployments.

Retry Deployment -> Envelope<

Deployment

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

Retry a previous deployment.

Rollback Deployment -> Envelope<

Deployment

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

Pages Projects Deployments History

Logs

pages.projects.deployments.history.logs

Methods

Get Deployment Logs -> Envelope<{ data, includes_container_logs, total }>

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

Fetch deployment logs for a project.

Pages Projects

Domains

pages.projects.domains

Methods

Add Domain -> Envelope<{ id, certificate_authority, created_on, 6 more... }>

post/accounts/{account_id}/pages/projects/{project_name}/domains

Add a new domain for the Pages project.

Delete Domain -> Envelope<unknown>

delete/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Delete a Pages project's domain.

Patch Domain -> Envelope<{ id, certificate_authority, created_on, 6 more... }>

patch/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Retry the validation status of a single domain.

Get Domain -> Envelope<{ id, certificate_authority, created_on, 6 more... }>

get/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Fetch a single domain.

Get Domains -> SinglePage<{ id, certificate_authority, created_on, 6 more... }>

get/accounts/{account_id}/pages/projects/{project_name}/domains

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