Cloudflare API | Pages › Projects › Domains › Add Domain

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Purge build cache

Workers For Platforms

Shared

Pages

pages

Projects

pages.projects

Methods

Create Project -> Envelope<

>

post/accounts/{account_id}/pages/projects

Create a new project.

Delete Project -> Envelope<unknown>

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

Delete a project by name.

Update Project -> Envelope<

>

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<

>

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

Fetch a project by name.

Get Projects -> SinglePage<

>

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... }

Deployments

pages.projects.deployments

Methods

Create Deployment -> Envelope<

>

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<

>

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

Fetch information about a deployment.

Get Deployments -> SinglePage<

>

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

Fetch a list of project deployments.

Retry Deployment -> Envelope<

>

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

Retry a previous deployment.

Rollback Deployment -> Envelope<

>

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.

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.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Parameters

account_id: string

Identifier

project_name: string

Name of the project.

Response fields

errors: Array<

>

messages: Array<

>

result: { id, certificate_authority, created_on, 6 more... }

success: false | true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME/domains \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "name": "example.com"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id",
    "certificate_authority": "google",
    "created_on": "created_on",
    "domain_id": "domain_id",
    "name": "example.com",
    "status": "initializing",
    "validation_data": {
      "error_message": "error_message",
      "method": "http",
      "status": "initializing",
      "txt_name": "txt_name",
      "txt_value": "txt_value"
    },
    "verification_data": {
      "error_message": "error_message",
      "status": "pending"
    },
    "zone_tag": "zone_tag"
  },
  "success": false
}

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.