API Reference

Pages

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Projects

List Cloudflare Pages projects

client.Pages.Projects.List(ctx, params) (*V4PagePaginationArray[Project], error)

GET/accounts/{account_id}/pages/projects

Get a Cloudflare Pages project

client.Pages.Projects.Get(ctx, projectName, query) (*Project, error)

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

Get upload token

client.Pages.Projects.GetUploadToken(ctx, projectName, query) (*ProjectGetUploadTokenResponse, error)

GET/accounts/{account_id}/pages/projects/{project_name}/upload-token

Create a Cloudflare Pages project

client.Pages.Projects.New(ctx, params) (*Project, error)

POST/accounts/{account_id}/pages/projects

Update a Cloudflare Pages project

client.Pages.Projects.Edit(ctx, projectName, params) (*Project, error)

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

Delete a Cloudflare Pages project

client.Pages.Projects.Delete(ctx, projectName, body) (*ProjectDeleteResponse, error)

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

Purge the Pages build cache

client.Pages.Projects.PurgeBuildCache(ctx, projectName, body) (*ProjectPurgeBuildCacheResponse, error)

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

ModelsExpand Collapse

type Deployment struct{…}

ID string

Id of the deployment.

Aliases []string

A list of alias URLs pointing to this deployment.

BuildConfig DeploymentBuildConfig

Configs for the project build process.

WebAnalyticsTag string

The classifying tag for analytics.

WebAnalyticsToken string

The auth token for analytics.

BuildCaching boolOptional

Enable build caching for the project.

BuildCommand stringOptional

Command used to build project.

DestinationDir stringOptional

Assets output directory of the build.

RootDir stringOptional

Directory to run the command.

CreatedOn Time

When the deployment was created.

formatdate-time

DeploymentTrigger DeploymentDeploymentTrigger

Info about what caused the deployment.

Metadata DeploymentDeploymentTriggerMetadata

Additional info about the trigger.

Branch string

Where the trigger happened.

CommitDirty bool

Whether the deployment trigger commit was dirty.

CommitHash string

Hash of the deployment trigger commit.

CommitMessage string

Message of the deployment trigger commit.

Type DeploymentDeploymentTriggerType

What caused the deployment.

One of the following:

const DeploymentDeploymentTriggerTypeGitHubPush DeploymentDeploymentTriggerType = "github:push"

const DeploymentDeploymentTriggerTypeADHoc DeploymentDeploymentTriggerType = "ad_hoc"

const DeploymentDeploymentTriggerTypeDeployHook DeploymentDeploymentTriggerType = "deploy_hook"

EnvVars map[string, DeploymentEnvVar]

Environment variables used for builds and Pages Functions.

One of the following:

type DeploymentEnvVarsPagesPlainTextEnvVar struct{…}

A plaintext environment variable.

Type DeploymentEnvVarsPagesPlainTextEnvVarType

Value string

Environment variable value.

type DeploymentEnvVarsPagesSecretTextEnvVar struct{…}

An encrypted environment variable.

Type DeploymentEnvVarsPagesSecretTextEnvVarType

Value string

Secret value.

Environment DeploymentEnvironment

Type of deploy.

One of the following:

const DeploymentEnvironmentPreview DeploymentEnvironment = "preview"

const DeploymentEnvironmentProduction DeploymentEnvironment = "production"

IsSkipped bool

Whether the deployment was skipped.

LatestStage Stage

The status of the deployment.

ModifiedOn Time

When the deployment was last modified.

formatdate-time

ProjectID string

Id of the project.

ProjectName string

Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens.

ShortID string

Short Id (8 character) of the deployment.

Source DeploymentSource

Configs for the project source control.

Config DeploymentSourceConfig

DeprecatedDeploymentsEnabled bool

Use production_deployments_enabled and preview_deployment_setting for more granular control.

Whether to enable automatic deployments when pushing to the source repository. When disabled, no deployments (production or preview) will be triggered automatically.

Owner string

The owner of the repository.

OwnerID string

The owner ID of the repository.

PathExcludes []string

A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported.

PathIncludes []string

A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported.

PrCommentsEnabled bool

Whether to enable PR comments.

PreviewBranchExcludes []string

A list of branches that should not trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.

PreviewBranchIncludes []string

A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.

PreviewDeploymentSetting DeploymentSourceConfigPreviewDeploymentSetting

Controls whether commits to preview branches trigger a preview deployment.

One of the following:

const DeploymentSourceConfigPreviewDeploymentSettingAll DeploymentSourceConfigPreviewDeploymentSetting = "all"

const DeploymentSourceConfigPreviewDeploymentSettingNone DeploymentSourceConfigPreviewDeploymentSetting = "none"

const DeploymentSourceConfigPreviewDeploymentSettingCustom DeploymentSourceConfigPreviewDeploymentSetting = "custom"

ProductionBranch string

The production branch of the repository.

ProductionDeploymentsEnabled bool

Whether to trigger a production deployment on commits to the production branch.

RepoID string

The ID of the repository.

RepoName string

The name of the repository.

Type DeploymentSourceType

The source control management provider.

One of the following:

const DeploymentSourceTypeGitHub DeploymentSourceType = "github"

const DeploymentSourceTypeGitlab DeploymentSourceType = "gitlab"

Stages []Stage

List of past stages.

EndedOn Time

When the stage ended.

formatdate-time

Name StageName

The current build stage.

One of the following:

const StageNameQueued StageName = "queued"

const StageNameInitialize StageName = "initialize"

const StageNameCloneRepo StageName = "clone_repo"

const StageNameBuild StageName = "build"

const StageNameDeploy StageName = "deploy"

StartedOn Time

When the stage started.

formatdate-time

Status StageStatus

State of the current stage.

One of the following:

const StageStatusSuccess StageStatus = "success"

const StageStatusIdle StageStatus = "idle"

const StageStatusActive StageStatus = "active"

const StageStatusFailure StageStatus = "failure"

const StageStatusCanceled StageStatus = "canceled"

const StageStatusSkipped StageStatus = "skipped"

URL string

The live URL to view this deployment.

SkipReason DeploymentSkipReasonOptional

Why the deployment was skipped.

One of the following:

const DeploymentSkipReasonCommitMessage DeploymentSkipReason = "commit_message"

const DeploymentSkipReasonPreviewDeploymentsDisabled DeploymentSkipReason = "preview_deployments_disabled"

const DeploymentSkipReasonProductionDeploymentsDisabled DeploymentSkipReason = "production_deployments_disabled"

const DeploymentSkipReasonPathConfig DeploymentSkipReason = "path_config"

const DeploymentSkipReasonBranchConfig DeploymentSkipReason = "branch_config"

const DeploymentSkipReasonPagesToWorkersConversion DeploymentSkipReason = "pages_to_workers_conversion"

const DeploymentSkipReasonSupersededQueuedBuild DeploymentSkipReason = "superseded_queued_build"

UsesFunctions boolOptional

Whether the deployment uses functions.

type Project struct{…}

ID string

ID of the project.

CanonicalDeployment Deployment

Most recent production deployment of the project.

CreatedOn Time

When the project was created.

formatdate-time

DeploymentConfigs ProjectDeploymentConfigs

Configs for deployments in a project.

Preview ProjectDeploymentConfigsPreview

Configs for preview deploys.

AlwaysUseLatestCompatibilityDate bool

Whether to always use the latest compatibility date for Pages Functions.

BuildImageMajorVersion int64

The major version of the build image to use for Pages Functions.

CompatibilityDate string

Compatibility date used for Pages Functions.

CompatibilityFlags []string

Compatibility flags used for Pages Functions.

EnvVars map[string, ProjectDeploymentConfigsPreviewEnvVar]

Environment variables used for builds and Pages Functions.

One of the following:

type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct{…}

A plaintext environment variable.

Type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType

Value string

Environment variable value.

type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct{…}

An encrypted environment variable.

Type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType

Value string

Secret value.

FailOpen bool

Whether to fail open when the deployment config cannot be applied.

DeprecatedUsageModel ProjectDeploymentConfigsPreviewUsageModel

All new projects now use the Standard usage model.

The usage model for Pages Functions.

One of the following:

const ProjectDeploymentConfigsPreviewUsageModelStandard ProjectDeploymentConfigsPreviewUsageModel = "standard"

const ProjectDeploymentConfigsPreviewUsageModelBundled ProjectDeploymentConfigsPreviewUsageModel = "bundled"

const ProjectDeploymentConfigsPreviewUsageModelUnbound ProjectDeploymentConfigsPreviewUsageModel = "unbound"

AIBindings map[string, ProjectDeploymentConfigsPreviewAIBinding]Optional

Constellation bindings used for Pages Functions.

ProjectID string

AnalyticsEngineDatasets map[string, ProjectDeploymentConfigsPreviewAnalyticsEngineDataset]Optional

Analytics Engine bindings used for Pages Functions.

Dataset string

Name of the dataset.

Browsers map[string, ProjectDeploymentConfigsPreviewBrowser]Optional

Browser bindings used for Pages Functions.

D1Databases map[string, ProjectDeploymentConfigsPreviewD1Database]Optional

D1 databases used for Pages Functions.

ID string

UUID of the D1 database.

DurableObjectNamespaces map[string, ProjectDeploymentConfigsPreviewDurableObjectNamespace]Optional

Durable Object namespaces used for Pages Functions.

NamespaceID string

ID of the Durable Object namespace.

HyperdriveBindings map[string, ProjectDeploymentConfigsPreviewHyperdriveBinding]Optional

Hyperdrive bindings used for Pages Functions.

ID string

KVNamespaces map[string, ProjectDeploymentConfigsPreviewKVNamespace]Optional

KV namespaces used for Pages Functions.

NamespaceID string

ID of the KV namespace.

Limits ProjectDeploymentConfigsPreviewLimitsOptional

Limits for Pages Functions.

CPUMs int64

CPU time limit in milliseconds.

MTLSCertificates map[string, ProjectDeploymentConfigsPreviewMTLSCertificate]Optional

mTLS bindings used for Pages Functions.

CertificateID string

Placement ProjectDeploymentConfigsPreviewPlacementOptional

Placement setting used for Pages Functions.

Mode string

Placement mode.

QueueProducers map[string, ProjectDeploymentConfigsPreviewQueueProducer]Optional

Queue Producer bindings used for Pages Functions.

Name string

Name of the Queue.

R2Buckets map[string, ProjectDeploymentConfigsPreviewR2Bucket]Optional

R2 buckets used for Pages Functions.

Name string

Name of the R2 bucket.

Jurisdiction stringOptional

Jurisdiction of the R2 bucket.

Services map[string, ProjectDeploymentConfigsPreviewService]Optional

Services used for Pages Functions.

Environment string

The Service environment.

Service string

The Service name.

Entrypoint stringOptional

The entrypoint to bind to.

VectorizeBindings map[string, ProjectDeploymentConfigsPreviewVectorizeBinding]Optional

Vectorize bindings used for Pages Functions.

IndexName string

WranglerConfigHash stringOptional

Hash of the Wrangler configuration used for the deployment.

Production ProjectDeploymentConfigsProduction

Configs for production deploys.

AlwaysUseLatestCompatibilityDate bool

Whether to always use the latest compatibility date for Pages Functions.

BuildImageMajorVersion int64

The major version of the build image to use for Pages Functions.

CompatibilityDate string

Compatibility date used for Pages Functions.

CompatibilityFlags []string

Compatibility flags used for Pages Functions.

EnvVars map[string, ProjectDeploymentConfigsProductionEnvVar]

Environment variables used for builds and Pages Functions.

One of the following:

type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct{…}

A plaintext environment variable.

Type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType

Value string

Environment variable value.

type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct{…}

An encrypted environment variable.

Type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType

Value string

Secret value.

FailOpen bool

Whether to fail open when the deployment config cannot be applied.

DeprecatedUsageModel ProjectDeploymentConfigsProductionUsageModel

All new projects now use the Standard usage model.

The usage model for Pages Functions.

One of the following:

const ProjectDeploymentConfigsProductionUsageModelStandard ProjectDeploymentConfigsProductionUsageModel = "standard"

const ProjectDeploymentConfigsProductionUsageModelBundled ProjectDeploymentConfigsProductionUsageModel = "bundled"

const ProjectDeploymentConfigsProductionUsageModelUnbound ProjectDeploymentConfigsProductionUsageModel = "unbound"

AIBindings map[string, ProjectDeploymentConfigsProductionAIBinding]Optional

Constellation bindings used for Pages Functions.

ProjectID string

AnalyticsEngineDatasets map[string, ProjectDeploymentConfigsProductionAnalyticsEngineDataset]Optional

Analytics Engine bindings used for Pages Functions.

Dataset string

Name of the dataset.

Browsers map[string, ProjectDeploymentConfigsProductionBrowser]Optional

Browser bindings used for Pages Functions.

D1Databases map[string, ProjectDeploymentConfigsProductionD1Database]Optional

D1 databases used for Pages Functions.

ID string

UUID of the D1 database.

DurableObjectNamespaces map[string, ProjectDeploymentConfigsProductionDurableObjectNamespace]Optional

Durable Object namespaces used for Pages Functions.

NamespaceID string

ID of the Durable Object namespace.

HyperdriveBindings map[string, ProjectDeploymentConfigsProductionHyperdriveBinding]Optional

Hyperdrive bindings used for Pages Functions.

ID string

KVNamespaces map[string, ProjectDeploymentConfigsProductionKVNamespace]Optional

KV namespaces used for Pages Functions.

NamespaceID string

ID of the KV namespace.

Limits ProjectDeploymentConfigsProductionLimitsOptional

Limits for Pages Functions.

CPUMs int64

CPU time limit in milliseconds.

MTLSCertificates map[string, ProjectDeploymentConfigsProductionMTLSCertificate]Optional

mTLS bindings used for Pages Functions.

CertificateID string

Placement ProjectDeploymentConfigsProductionPlacementOptional

Placement setting used for Pages Functions.

Mode string

Placement mode.

QueueProducers map[string, ProjectDeploymentConfigsProductionQueueProducer]Optional

Queue Producer bindings used for Pages Functions.

Name string

Name of the Queue.

R2Buckets map[string, ProjectDeploymentConfigsProductionR2Bucket]Optional

R2 buckets used for Pages Functions.

Name string

Name of the R2 bucket.

Jurisdiction stringOptional

Jurisdiction of the R2 bucket.

Services map[string, ProjectDeploymentConfigsProductionService]Optional

Services used for Pages Functions.

Environment string

The Service environment.

Service string

The Service name.

Entrypoint stringOptional

The entrypoint to bind to.

VectorizeBindings map[string, ProjectDeploymentConfigsProductionVectorizeBinding]Optional

Vectorize bindings used for Pages Functions.

IndexName string

WranglerConfigHash stringOptional

Hash of the Wrangler configuration used for the deployment.

Framework string

Framework the project is using.

FrameworkVersion string

Version of the framework the project is using.

LatestDeployment Deployment

Most recent deployment of the project.

Name string

Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens.

PreviewScriptName string

Name of the preview script.

ProductionBranch string

Production branch of the project. Used to identify production deployments.

ProductionScriptName string

Name of the production script.

UsesFunctions bool

Whether the project uses functions.

BuildConfig ProjectBuildConfigOptional

Configs for the project build process.

WebAnalyticsTag string

The classifying tag for analytics.

WebAnalyticsToken string

The auth token for analytics.

BuildCaching boolOptional

Enable build caching for the project.

BuildCommand stringOptional

Command used to build project.

DestinationDir stringOptional

Assets output directory of the build.

RootDir stringOptional

Directory to run the command.

Domains []stringOptional

A list of associated custom domains for the project.

Source ProjectSourceOptional

Configs for the project source control.

Config ProjectSourceConfig

DeprecatedDeploymentsEnabled bool

Use production_deployments_enabled and preview_deployment_setting for more granular control.

Whether to enable automatic deployments when pushing to the source repository. When disabled, no deployments (production or preview) will be triggered automatically.

Owner string

The owner of the repository.

OwnerID string

The owner ID of the repository.

PathExcludes []string

A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported.

PathIncludes []string

A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported.

PrCommentsEnabled bool

Whether to enable PR comments.

PreviewBranchExcludes []string

A list of branches that should not trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.

PreviewBranchIncludes []string

A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom.

PreviewDeploymentSetting ProjectSourceConfigPreviewDeploymentSetting

Controls whether commits to preview branches trigger a preview deployment.

One of the following:

const ProjectSourceConfigPreviewDeploymentSettingAll ProjectSourceConfigPreviewDeploymentSetting = "all"

const ProjectSourceConfigPreviewDeploymentSettingNone ProjectSourceConfigPreviewDeploymentSetting = "none"

const ProjectSourceConfigPreviewDeploymentSettingCustom ProjectSourceConfigPreviewDeploymentSetting = "custom"

ProductionBranch string

The production branch of the repository.

ProductionDeploymentsEnabled bool

Whether to trigger a production deployment on commits to the production branch.

RepoID string

The ID of the repository.

RepoName string

The name of the repository.

Type ProjectSourceType

The source control management provider.

One of the following:

const ProjectSourceTypeGitHub ProjectSourceType = "github"

const ProjectSourceTypeGitlab ProjectSourceType = "gitlab"

Subdomain stringOptional

The Cloudflare subdomain associated with the project.

type Stage struct{…}

The status of the deployment.

EndedOn Time

When the stage ended.

formatdate-time

Name StageName

The current build stage.

One of the following:

const StageNameQueued StageName = "queued"

const StageNameInitialize StageName = "initialize"

const StageNameCloneRepo StageName = "clone_repo"

const StageNameBuild StageName = "build"

const StageNameDeploy StageName = "deploy"

StartedOn Time

When the stage started.

formatdate-time

Status StageStatus

State of the current stage.

One of the following:

const StageStatusSuccess StageStatus = "success"

const StageStatusIdle StageStatus = "idle"

const StageStatusActive StageStatus = "active"

const StageStatusFailure StageStatus = "failure"

const StageStatusCanceled StageStatus = "canceled"

const StageStatusSkipped StageStatus = "skipped"

ProjectsDeployments

List Pages deployments

client.Pages.Projects.Deployments.List(ctx, projectName, params) (*V4PagePaginationArray[Deployment], error)

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

Get a Pages deployment

client.Pages.Projects.Deployments.Get(ctx, projectName, deploymentID, query) (*Deployment, error)

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

Create a Pages deployment

client.Pages.Projects.Deployments.New(ctx, projectName, params) (*Deployment, error)

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

Delete a Pages deployment

client.Pages.Projects.Deployments.Delete(ctx, projectName, deploymentID, params) (*ProjectDeploymentDeleteResponse, error)

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

Retry a Pages deployment

client.Pages.Projects.Deployments.Retry(ctx, projectName, deploymentID, body) (*Deployment, error)

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

Roll back a Pages deployment

client.Pages.Projects.Deployments.Rollback(ctx, projectName, deploymentID, body) (*Deployment, error)

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

ProjectsDeploymentsHistory

ProjectsDeploymentsHistoryLogs

Get Pages deployment logs

client.Pages.Projects.Deployments.History.Logs.Get(ctx, projectName, deploymentID, query) (*ProjectDeploymentHistoryLogGetResponse, error)

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

ProjectsDeploymentsTails

Create deployment tail

client.Pages.Projects.Deployments.Tails.New(ctx, projectName, deploymentID, params) (*ProjectDeploymentTailNewResponse, error)

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

Delete deployment tail

client.Pages.Projects.Deployments.Tails.Delete(ctx, projectName, deploymentID, tailID, body) (*ProjectDeploymentTailDeleteResponse, error)

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

ProjectsDomains

List Pages custom domains

client.Pages.Projects.Domains.List(ctx, projectName, query) (*SinglePage[ProjectDomainListResponse], error)

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

Get a Pages custom domain

client.Pages.Projects.Domains.Get(ctx, projectName, domainName, query) (*ProjectDomainGetResponse, error)

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

Add a Pages custom domain

client.Pages.Projects.Domains.New(ctx, projectName, params) (*ProjectDomainNewResponse, error)

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

Retry custom domain validation

client.Pages.Projects.Domains.Edit(ctx, projectName, domainName, body) (*ProjectDomainEditResponse, error)

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

Delete a Pages custom domain

client.Pages.Projects.Domains.Delete(ctx, projectName, domainName, body) (*ProjectDomainDeleteResponse, error)

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