--- title: List Cloudflare Pages projects --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Pages](https://developers.cloudflare.com/api/python/resources/pages) [Projects](https://developers.cloudflare.com/api/python/resources/pages/subresources/projects) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Cloudflare Pages projects pages.projects.list(ProjectListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Project]()] GET/accounts/{account\_id}/pages/projects List the Cloudflare Pages projects in an account. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
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
##### Accepted Permissions (at least one required) `Pages Read``Pages Write` ##### ParametersExpand Collapse account\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) page: Optional\[int] Page number of results to return. [Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: Optional\[int] Number of results to return per page. [Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Project: … id: str ID of the project. Link to this property
canonical\_deployment: Optional\[Deployment] Most recent production deployment of the project. id: str Id of the deployment. Link to this property aliases: Optional\[List\[str]] A list of alias URLs pointing to this deployment. Link to this property
build\_config: BuildConfig Configs for the project build process. web\_analytics\_tag: Optional\[str] The classifying tag for analytics. Link to this property web\_analytics\_token: Optional\[str] The auth token for analytics. Link to this property build\_caching: Optional\[bool] Enable build caching for the project. Link to this property build\_command: Optional\[str] Command used to build project. Link to this property destination\_dir: Optional\[str] Assets output directory of the build. Link to this property root\_dir: Optional\[str] Directory to run the command. Link to this property
Link to this property created\_on: datetime When the deployment was created. formatdate-time Link to this property
deployment\_trigger: DeploymentTrigger Info about what caused the deployment.
metadata: DeploymentTriggerMetadata Additional info about the trigger. branch: str Where the trigger happened. Link to this property commit\_dirty: bool Whether the deployment trigger commit was dirty. Link to this property commit\_hash: str Hash of the deployment trigger commit. Link to this property commit\_message: str Message of the deployment trigger commit. Link to this property
Link to this property
type: Literal\["github:push", "ad\_hoc", "deploy\_hook"] What caused the deployment. One of the following: "github:push" Link to this property "ad\_hoc" Link to this property "deploy\_hook" Link to this property
Link to this property
Link to this property
env\_vars: Optional\[Dict\[str, Optional\[EnvVars]]] Environment variables used for builds and Pages Functions. One of the following:
class EnvVarsPagesPlainTextEnvVar: … A plaintext environment variable. type: Literal\["plain\_text"] Link to this property value: str Environment variable value. Link to this property
Link to this property
class EnvVarsPagesSecretTextEnvVar: … An encrypted environment variable. type: Literal\["secret\_text"] Link to this property value: str Secret value. Link to this property
Link to this property
Link to this property
environment: Literal\["preview", "production"] Type of deploy. One of the following: "preview" Link to this property "production" Link to this property
Link to this property is\_skipped: bool Whether the deployment was skipped. Link to this property
latest\_stage: Stage The status of the deployment. ended\_on: Optional\[datetime] When the stage ended. formatdate-time Link to this property
name: Literal\["queued", "initialize", "clone\_repo", 2 more] The current build stage. One of the following: "queued" Link to this property "initialize" Link to this property "clone\_repo" Link to this property "build" Link to this property "deploy" Link to this property
Link to this property started\_on: Optional\[datetime] When the stage started. formatdate-time Link to this property
status: Literal\["success", "idle", "active", 3 more] State of the current stage. One of the following: "success" Link to this property "idle" Link to this property "active" Link to this property "failure" Link to this property "canceled" Link to this property "skipped" Link to this property
Link to this property
Link to this property modified\_on: datetime When the deployment was last modified. formatdate-time Link to this property project\_id: str Id of the project. Link to this property project\_name: str Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens. Link to this property short\_id: str Short Id (8 character) of the deployment. Link to this property
source: Source Configs for the project source control.
config: SourceConfig Deprecateddeployments\_enabled: 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. Link to this property owner: str The owner of the repository. Link to this property owner\_id: str The owner ID of the repository. Link to this property path\_excludes: List\[str] A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported. Link to this property path\_includes: List\[str] A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported. Link to this property pr\_comments\_enabled: bool Whether to enable PR comments. Link to this property preview\_branch\_excludes: List\[str] 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. Link to this property preview\_branch\_includes: List\[str] A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom. Link to this property
preview\_deployment\_setting: Literal\["all", "none", "custom"] Controls whether commits to preview branches trigger a preview deployment. One of the following: "all" Link to this property "none" Link to this property "custom" Link to this property
Link to this property production\_branch: str The production branch of the repository. Link to this property production\_deployments\_enabled: bool Whether to trigger a production deployment on commits to the production branch. Link to this property repo\_id: str The ID of the repository. Link to this property repo\_name: str The name of the repository. Link to this property
Link to this property
type: Literal\["github", "gitlab"] The source control management provider. One of the following: "github" Link to this property "gitlab" Link to this property
Link to this property
Link to this property
stages: List\[Stage] List of past stages. ended\_on: Optional\[datetime] When the stage ended. formatdate-time Link to this property
name: Literal\["queued", "initialize", "clone\_repo", 2 more] The current build stage. One of the following: "queued" Link to this property "initialize" Link to this property "clone\_repo" Link to this property "build" Link to this property "deploy" Link to this property
Link to this property started\_on: Optional\[datetime] When the stage started. formatdate-time Link to this property
status: Literal\["success", "idle", "active", 3 more] State of the current stage. One of the following: "success" Link to this property "idle" Link to this property "active" Link to this property "failure" Link to this property "canceled" Link to this property "skipped" Link to this property
Link to this property
Link to this property url: str The live URL to view this deployment. Link to this property
skip\_reason: Optional\[Literal\["commit\_message", "preview\_deployments\_disabled", "production\_deployments\_disabled", 4 more]] Why the deployment was skipped. One of the following: "commit\_message" Link to this property "preview\_deployments\_disabled" Link to this property "production\_deployments\_disabled" Link to this property "path\_config" Link to this property "branch\_config" Link to this property "pages\_to\_workers\_conversion" Link to this property "superseded\_queued\_build" Link to this property
Link to this property uses\_functions: Optional\[bool] Whether the deployment uses functions. Link to this property
Link to this property created\_on: datetime When the project was created. formatdate-time Link to this property
deployment\_configs: DeploymentConfigs Configs for deployments in a project.
preview: DeploymentConfigsPreview Configs for preview deploys. always\_use\_latest\_compatibility\_date: bool Whether to always use the latest compatibility date for Pages Functions. Link to this property build\_image\_major\_version: int The major version of the build image to use for Pages Functions. Link to this property compatibility\_date: str Compatibility date used for Pages Functions. Link to this property compatibility\_flags: List\[str] Compatibility flags used for Pages Functions. Link to this property
env\_vars: Optional\[Dict\[str, Optional\[DeploymentConfigsPreviewEnvVars]]] Environment variables used for builds and Pages Functions. One of the following:
class DeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar: … A plaintext environment variable. type: Literal\["plain\_text"] Link to this property value: str Environment variable value. Link to this property
Link to this property
class DeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar: … An encrypted environment variable. type: Literal\["secret\_text"] Link to this property value: str Secret value. Link to this property
Link to this property
Link to this property fail\_open: bool Whether to fail open when the deployment config cannot be applied. Link to this property
Deprecatedusage\_model: Literal\["standard", "bundled", "unbound"] All new projects now use the Standard usage model. The usage model for Pages Functions. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
ai\_bindings: Optional\[Dict\[str, DeploymentConfigsPreviewAIBindings]] Constellation bindings used for Pages Functions. project\_id: str Link to this property
Link to this property
analytics\_engine\_datasets: Optional\[Dict\[str, DeploymentConfigsPreviewAnalyticsEngineDatasets]] Analytics Engine bindings used for Pages Functions. dataset: str Name of the dataset. Link to this property
Link to this property browsers: Optional\[Dict\[str, Optional\[DeploymentConfigsPreviewBrowsers]]] Browser bindings used for Pages Functions. Link to this property
d1\_databases: Optional\[Dict\[str, DeploymentConfigsPreviewD1Databases]] D1 databases used for Pages Functions. id: str UUID of the D1 database. Link to this property
Link to this property
durable\_object\_namespaces: Optional\[Dict\[str, DeploymentConfigsPreviewDurableObjectNamespaces]] Durable Object namespaces used for Pages Functions. namespace\_id: str ID of the Durable Object namespace. Link to this property
Link to this property
hyperdrive\_bindings: Optional\[Dict\[str, DeploymentConfigsPreviewHyperdriveBindings]] Hyperdrive bindings used for Pages Functions. id: str Link to this property
Link to this property
kv\_namespaces: Optional\[Dict\[str, DeploymentConfigsPreviewKVNamespaces]] KV namespaces used for Pages Functions. namespace\_id: str ID of the KV namespace. Link to this property
Link to this property
limits: Optional\[DeploymentConfigsPreviewLimits] Limits for Pages Functions. cpu\_ms: int CPU time limit in milliseconds. Link to this property
Link to this property
mtls\_certificates: Optional\[Dict\[str, DeploymentConfigsPreviewMTLSCertificates]] mTLS bindings used for Pages Functions. certificate\_id: str Link to this property
Link to this property
placement: Optional\[DeploymentConfigsPreviewPlacement] Placement setting used for Pages Functions. mode: str Placement mode. Link to this property
Link to this property
queue\_producers: Optional\[Dict\[str, DeploymentConfigsPreviewQueueProducers]] Queue Producer bindings used for Pages Functions. name: str Name of the Queue. Link to this property
Link to this property
r2\_buckets: Optional\[Dict\[str, DeploymentConfigsPreviewR2Buckets]] R2 buckets used for Pages Functions. name: str Name of the R2 bucket. Link to this property jurisdiction: Optional\[str] Jurisdiction of the R2 bucket. Link to this property
Link to this property
services: Optional\[Dict\[str, DeploymentConfigsPreviewServices]] Services used for Pages Functions. environment: str The Service environment. Link to this property service: str The Service name. Link to this property entrypoint: Optional\[str] The entrypoint to bind to. Link to this property
Link to this property
vectorize\_bindings: Optional\[Dict\[str, DeploymentConfigsPreviewVectorizeBindings]] Vectorize bindings used for Pages Functions. index\_name: str Link to this property
Link to this property wrangler\_config\_hash: Optional\[str] Hash of the Wrangler configuration used for the deployment. Link to this property
Link to this property
production: DeploymentConfigsProduction Configs for production deploys. always\_use\_latest\_compatibility\_date: bool Whether to always use the latest compatibility date for Pages Functions. Link to this property build\_image\_major\_version: int The major version of the build image to use for Pages Functions. Link to this property compatibility\_date: str Compatibility date used for Pages Functions. Link to this property compatibility\_flags: List\[str] Compatibility flags used for Pages Functions. Link to this property
env\_vars: Optional\[Dict\[str, Optional\[DeploymentConfigsProductionEnvVars]]] Environment variables used for builds and Pages Functions. One of the following:
class DeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar: … A plaintext environment variable. type: Literal\["plain\_text"] Link to this property value: str Environment variable value. Link to this property
Link to this property
class DeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar: … An encrypted environment variable. type: Literal\["secret\_text"] Link to this property value: str Secret value. Link to this property
Link to this property
Link to this property fail\_open: bool Whether to fail open when the deployment config cannot be applied. Link to this property
Deprecatedusage\_model: Literal\["standard", "bundled", "unbound"] All new projects now use the Standard usage model. The usage model for Pages Functions. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
ai\_bindings: Optional\[Dict\[str, DeploymentConfigsProductionAIBindings]] Constellation bindings used for Pages Functions. project\_id: str Link to this property
Link to this property
analytics\_engine\_datasets: Optional\[Dict\[str, DeploymentConfigsProductionAnalyticsEngineDatasets]] Analytics Engine bindings used for Pages Functions. dataset: str Name of the dataset. Link to this property
Link to this property browsers: Optional\[Dict\[str, Optional\[DeploymentConfigsProductionBrowsers]]] Browser bindings used for Pages Functions. Link to this property
d1\_databases: Optional\[Dict\[str, DeploymentConfigsProductionD1Databases]] D1 databases used for Pages Functions. id: str UUID of the D1 database. Link to this property
Link to this property
durable\_object\_namespaces: Optional\[Dict\[str, DeploymentConfigsProductionDurableObjectNamespaces]] Durable Object namespaces used for Pages Functions. namespace\_id: str ID of the Durable Object namespace. Link to this property
Link to this property
hyperdrive\_bindings: Optional\[Dict\[str, DeploymentConfigsProductionHyperdriveBindings]] Hyperdrive bindings used for Pages Functions. id: str Link to this property
Link to this property
kv\_namespaces: Optional\[Dict\[str, DeploymentConfigsProductionKVNamespaces]] KV namespaces used for Pages Functions. namespace\_id: str ID of the KV namespace. Link to this property
Link to this property
limits: Optional\[DeploymentConfigsProductionLimits] Limits for Pages Functions. cpu\_ms: int CPU time limit in milliseconds. Link to this property
Link to this property
mtls\_certificates: Optional\[Dict\[str, DeploymentConfigsProductionMTLSCertificates]] mTLS bindings used for Pages Functions. certificate\_id: str Link to this property
Link to this property
placement: Optional\[DeploymentConfigsProductionPlacement] Placement setting used for Pages Functions. mode: str Placement mode. Link to this property
Link to this property
queue\_producers: Optional\[Dict\[str, DeploymentConfigsProductionQueueProducers]] Queue Producer bindings used for Pages Functions. name: str Name of the Queue. Link to this property
Link to this property
r2\_buckets: Optional\[Dict\[str, DeploymentConfigsProductionR2Buckets]] R2 buckets used for Pages Functions. name: str Name of the R2 bucket. Link to this property jurisdiction: Optional\[str] Jurisdiction of the R2 bucket. Link to this property
Link to this property
services: Optional\[Dict\[str, DeploymentConfigsProductionServices]] Services used for Pages Functions. environment: str The Service environment. Link to this property service: str The Service name. Link to this property entrypoint: Optional\[str] The entrypoint to bind to. Link to this property
Link to this property
vectorize\_bindings: Optional\[Dict\[str, DeploymentConfigsProductionVectorizeBindings]] Vectorize bindings used for Pages Functions. index\_name: str Link to this property
Link to this property wrangler\_config\_hash: Optional\[str] Hash of the Wrangler configuration used for the deployment. Link to this property
Link to this property
Link to this property framework: str Framework the project is using. Link to this property framework\_version: str Version of the framework the project is using. Link to this property
latest\_deployment: Optional\[Deployment] Most recent deployment of the project. id: str Id of the deployment. Link to this property aliases: Optional\[List\[str]] A list of alias URLs pointing to this deployment. Link to this property
build\_config: BuildConfig Configs for the project build process. web\_analytics\_tag: Optional\[str] The classifying tag for analytics. Link to this property web\_analytics\_token: Optional\[str] The auth token for analytics. Link to this property build\_caching: Optional\[bool] Enable build caching for the project. Link to this property build\_command: Optional\[str] Command used to build project. Link to this property destination\_dir: Optional\[str] Assets output directory of the build. Link to this property root\_dir: Optional\[str] Directory to run the command. Link to this property
Link to this property created\_on: datetime When the deployment was created. formatdate-time Link to this property
deployment\_trigger: DeploymentTrigger Info about what caused the deployment.
metadata: DeploymentTriggerMetadata Additional info about the trigger. branch: str Where the trigger happened. Link to this property commit\_dirty: bool Whether the deployment trigger commit was dirty. Link to this property commit\_hash: str Hash of the deployment trigger commit. Link to this property commit\_message: str Message of the deployment trigger commit. Link to this property
Link to this property
type: Literal\["github:push", "ad\_hoc", "deploy\_hook"] What caused the deployment. One of the following: "github:push" Link to this property "ad\_hoc" Link to this property "deploy\_hook" Link to this property
Link to this property
Link to this property
env\_vars: Optional\[Dict\[str, Optional\[EnvVars]]] Environment variables used for builds and Pages Functions. One of the following:
class EnvVarsPagesPlainTextEnvVar: … A plaintext environment variable. type: Literal\["plain\_text"] Link to this property value: str Environment variable value. Link to this property
Link to this property
class EnvVarsPagesSecretTextEnvVar: … An encrypted environment variable. type: Literal\["secret\_text"] Link to this property value: str Secret value. Link to this property
Link to this property
Link to this property
environment: Literal\["preview", "production"] Type of deploy. One of the following: "preview" Link to this property "production" Link to this property
Link to this property is\_skipped: bool Whether the deployment was skipped. Link to this property
latest\_stage: Stage The status of the deployment. ended\_on: Optional\[datetime] When the stage ended. formatdate-time Link to this property
name: Literal\["queued", "initialize", "clone\_repo", 2 more] The current build stage. One of the following: "queued" Link to this property "initialize" Link to this property "clone\_repo" Link to this property "build" Link to this property "deploy" Link to this property
Link to this property started\_on: Optional\[datetime] When the stage started. formatdate-time Link to this property
status: Literal\["success", "idle", "active", 3 more] State of the current stage. One of the following: "success" Link to this property "idle" Link to this property "active" Link to this property "failure" Link to this property "canceled" Link to this property "skipped" Link to this property
Link to this property
Link to this property modified\_on: datetime When the deployment was last modified. formatdate-time Link to this property project\_id: str Id of the project. Link to this property project\_name: str Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens. Link to this property short\_id: str Short Id (8 character) of the deployment. Link to this property
source: Source Configs for the project source control.
config: SourceConfig Deprecateddeployments\_enabled: 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. Link to this property owner: str The owner of the repository. Link to this property owner\_id: str The owner ID of the repository. Link to this property path\_excludes: List\[str] A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported. Link to this property path\_includes: List\[str] A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported. Link to this property pr\_comments\_enabled: bool Whether to enable PR comments. Link to this property preview\_branch\_excludes: List\[str] 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. Link to this property preview\_branch\_includes: List\[str] A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom. Link to this property
preview\_deployment\_setting: Literal\["all", "none", "custom"] Controls whether commits to preview branches trigger a preview deployment. One of the following: "all" Link to this property "none" Link to this property "custom" Link to this property
Link to this property production\_branch: str The production branch of the repository. Link to this property production\_deployments\_enabled: bool Whether to trigger a production deployment on commits to the production branch. Link to this property repo\_id: str The ID of the repository. Link to this property repo\_name: str The name of the repository. Link to this property
Link to this property
type: Literal\["github", "gitlab"] The source control management provider. One of the following: "github" Link to this property "gitlab" Link to this property
Link to this property
Link to this property
stages: List\[Stage] List of past stages. ended\_on: Optional\[datetime] When the stage ended. formatdate-time Link to this property
name: Literal\["queued", "initialize", "clone\_repo", 2 more] The current build stage. One of the following: "queued" Link to this property "initialize" Link to this property "clone\_repo" Link to this property "build" Link to this property "deploy" Link to this property
Link to this property started\_on: Optional\[datetime] When the stage started. formatdate-time Link to this property
status: Literal\["success", "idle", "active", 3 more] State of the current stage. One of the following: "success" Link to this property "idle" Link to this property "active" Link to this property "failure" Link to this property "canceled" Link to this property "skipped" Link to this property
Link to this property
Link to this property url: str The live URL to view this deployment. Link to this property
skip\_reason: Optional\[Literal\["commit\_message", "preview\_deployments\_disabled", "production\_deployments\_disabled", 4 more]] Why the deployment was skipped. One of the following: "commit\_message" Link to this property "preview\_deployments\_disabled" Link to this property "production\_deployments\_disabled" Link to this property "path\_config" Link to this property "branch\_config" Link to this property "pages\_to\_workers\_conversion" Link to this property "superseded\_queued\_build" Link to this property
Link to this property uses\_functions: Optional\[bool] Whether the deployment uses functions. Link to this property
Link to this property name: str Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens. Link to this property preview\_script\_name: str Name of the preview script. Link to this property production\_branch: str Production branch of the project. Used to identify production deployments. Link to this property production\_script\_name: str Name of the production script. Link to this property uses\_functions: Optional\[bool] Whether the project uses functions. Link to this property
build\_config: Optional\[BuildConfig] Configs for the project build process. web\_analytics\_tag: Optional\[str] The classifying tag for analytics. Link to this property web\_analytics\_token: Optional\[str] The auth token for analytics. Link to this property build\_caching: Optional\[bool] Enable build caching for the project. Link to this property build\_command: Optional\[str] Command used to build project. Link to this property destination\_dir: Optional\[str] Assets output directory of the build. Link to this property root\_dir: Optional\[str] Directory to run the command. Link to this property
Link to this property domains: Optional\[List\[str]] A list of associated custom domains for the project. Link to this property
source: Optional\[Source] Configs for the project source control.
config: SourceConfig Deprecateddeployments\_enabled: 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. Link to this property owner: str The owner of the repository. Link to this property owner\_id: str The owner ID of the repository. Link to this property path\_excludes: List\[str] A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported. Link to this property path\_includes: List\[str] A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported. Link to this property pr\_comments\_enabled: bool Whether to enable PR comments. Link to this property preview\_branch\_excludes: List\[str] 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. Link to this property preview\_branch\_includes: List\[str] A list of branches that should trigger a preview deployment. Wildcard syntax (*) is supported. Must be used with preview_deployment_setting set to custom. Link to this property
preview\_deployment\_setting: Literal\["all", "none", "custom"] Controls whether commits to preview branches trigger a preview deployment. One of the following: "all" Link to this property "none" Link to this property "custom" Link to this property
Link to this property production\_branch: str The production branch of the repository. Link to this property production\_deployments\_enabled: bool Whether to trigger a production deployment on commits to the production branch. Link to this property repo\_id: str The ID of the repository. Link to this property repo\_name: str The name of the repository. Link to this property
Link to this property
type: Literal\["github", "gitlab"] The source control management provider. One of the following: "github" Link to this property "gitlab" Link to this property
Link to this property
Link to this property subdomain: Optional\[str] The Cloudflare subdomain associated with the project. Link to this property
[Link to this property](<#(resource)%20pages.projects%20%3E%20(model)%20project%20%3E%20(schema)>) ### List Cloudflare Pages projects Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.pages.projects.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "7b162ea7-7367-4d67-bcde-1160995d5", "canonical_deployment": { "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6", "aliases": [ "https://branchname.projectname.pages.dev" ], "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "created_on": "2021-03-09T00:55:03.923456Z", "deployment_trigger": { "metadata": { "branch": "main", "commit_dirty": false, "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421", "commit_message": "Update index.html" }, "type": "ad_hoc" }, "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "environment": "preview", "is_skipped": true, "latest_stage": { "ended_on": "2021-03-09T00:58:59.045655Z", "name": "deploy", "started_on": "2021-03-09T00:55:03.923456Z", "status": "success" }, "modified_on": "2021-03-09T00:58:59.045655Z", "project_id": "7b162ea7-7367-4d67-bcde-1160995d5", "project_name": "this-is-my-project-01", "short_id": "f64788e9", "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "stages": [ { "ended_on": "2021-06-03T15:39:03.134378Z", "name": "queued", "started_on": "2021-06-03T15:38:15.608194Z", "status": "active" }, { "ended_on": null, "name": "initialize", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "clone_repo", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "build", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "deploy", "started_on": null, "status": "idle" } ], "url": "https://f64788e9.ninjakittens.pages.dev", "skip_reason": "commit_message", "uses_functions": true }, "created_on": "2017-01-01T00:00:00Z", "deployment_configs": { "preview": { "always_use_latest_compatibility_date": false, "build_image_major_version": 3, "compatibility_date": "2025-01-01T00:00:00Z", "compatibility_flags": [ "url_standard" ], "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "fail_open": true, "usage_model": "standard", "ai_bindings": { "AI_BINDING": { "project_id": "some-project-id" } }, "analytics_engine_datasets": { "ANALYTICS_ENGINE_BINDING": { "dataset": "api_analytics" } }, "browsers": { "BROWSER": {} }, "d1_databases": { "D1_BINDING": { "id": "445e2955-951a-43f8-a35b-a4d0c8138f63" } }, "durable_object_namespaces": { "DO_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "hyperdrive_bindings": { "HYPERDRIVE": { "id": "a76a99bc342644deb02c38d66082262a" } }, "kv_namespaces": { "KV_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "limits": { "cpu_ms": 100 }, "mtls_certificates": { "MTLS": { "certificate_id": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" } }, "placement": { "mode": "smart" }, "queue_producers": { "QUEUE_PRODUCER_BINDING": { "name": "some-queue" } }, "r2_buckets": { "R2_BINDING": { "name": "some-bucket", "jurisdiction": "eu" } }, "services": { "SERVICE_BINDING": { "environment": "production", "service": "example-worker", "entrypoint": "MyHandler" } }, "vectorize_bindings": { "VECTORIZE": { "index_name": "my_index" } }, "wrangler_config_hash": "abc123def456" }, "production": { "always_use_latest_compatibility_date": false, "build_image_major_version": 3, "compatibility_date": "2025-01-01T00:00:00Z", "compatibility_flags": [ "url_standard" ], "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "fail_open": true, "usage_model": "standard", "ai_bindings": { "AI_BINDING": { "project_id": "some-project-id" } }, "analytics_engine_datasets": { "ANALYTICS_ENGINE_BINDING": { "dataset": "api_analytics" } }, "browsers": { "BROWSER": {} }, "d1_databases": { "D1_BINDING": { "id": "445e2955-951a-43f8-a35b-a4d0c8138f63" } }, "durable_object_namespaces": { "DO_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "hyperdrive_bindings": { "HYPERDRIVE": { "id": "a76a99bc342644deb02c38d66082262a" } }, "kv_namespaces": { "KV_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "limits": { "cpu_ms": 100 }, "mtls_certificates": { "MTLS": { "certificate_id": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" } }, "placement": { "mode": "smart" }, "queue_producers": { "QUEUE_PRODUCER_BINDING": { "name": "some-queue" } }, "r2_buckets": { "R2_BINDING": { "name": "some-bucket", "jurisdiction": "eu" } }, "services": { "SERVICE_BINDING": { "environment": "production", "service": "example-worker", "entrypoint": "MyHandler" } }, "vectorize_bindings": { "VECTORIZE": { "index_name": "my_index" } }, "wrangler_config_hash": "abc123def456" } }, "framework": "framework", "framework_version": "framework_version", "latest_deployment": { "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6", "aliases": [ "https://branchname.projectname.pages.dev" ], "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "created_on": "2021-03-09T00:55:03.923456Z", "deployment_trigger": { "metadata": { "branch": "main", "commit_dirty": false, "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421", "commit_message": "Update index.html" }, "type": "ad_hoc" }, "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "environment": "preview", "is_skipped": true, "latest_stage": { "ended_on": "2021-03-09T00:58:59.045655Z", "name": "deploy", "started_on": "2021-03-09T00:55:03.923456Z", "status": "success" }, "modified_on": "2021-03-09T00:58:59.045655Z", "project_id": "7b162ea7-7367-4d67-bcde-1160995d5", "project_name": "this-is-my-project-01", "short_id": "f64788e9", "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "stages": [ { "ended_on": "2021-06-03T15:39:03.134378Z", "name": "queued", "started_on": "2021-06-03T15:38:15.608194Z", "status": "active" }, { "ended_on": null, "name": "initialize", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "clone_repo", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "build", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "deploy", "started_on": null, "status": "idle" } ], "url": "https://f64788e9.ninjakittens.pages.dev", "skip_reason": "commit_message", "uses_functions": true }, "name": "this-is-my-project-01", "preview_script_name": "pages-worker--1234567-preview", "production_branch": "main", "production_script_name": "pages-worker--1234567-production", "uses_functions": true, "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "domains": [ "customdomain.com", "customdomain.org" ], "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "subdomain": "helloworld.pages.dev" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "7b162ea7-7367-4d67-bcde-1160995d5", "canonical_deployment": { "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6", "aliases": [ "https://branchname.projectname.pages.dev" ], "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "created_on": "2021-03-09T00:55:03.923456Z", "deployment_trigger": { "metadata": { "branch": "main", "commit_dirty": false, "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421", "commit_message": "Update index.html" }, "type": "ad_hoc" }, "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "environment": "preview", "is_skipped": true, "latest_stage": { "ended_on": "2021-03-09T00:58:59.045655Z", "name": "deploy", "started_on": "2021-03-09T00:55:03.923456Z", "status": "success" }, "modified_on": "2021-03-09T00:58:59.045655Z", "project_id": "7b162ea7-7367-4d67-bcde-1160995d5", "project_name": "this-is-my-project-01", "short_id": "f64788e9", "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "stages": [ { "ended_on": "2021-06-03T15:39:03.134378Z", "name": "queued", "started_on": "2021-06-03T15:38:15.608194Z", "status": "active" }, { "ended_on": null, "name": "initialize", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "clone_repo", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "build", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "deploy", "started_on": null, "status": "idle" } ], "url": "https://f64788e9.ninjakittens.pages.dev", "skip_reason": "commit_message", "uses_functions": true }, "created_on": "2017-01-01T00:00:00Z", "deployment_configs": { "preview": { "always_use_latest_compatibility_date": false, "build_image_major_version": 3, "compatibility_date": "2025-01-01T00:00:00Z", "compatibility_flags": [ "url_standard" ], "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "fail_open": true, "usage_model": "standard", "ai_bindings": { "AI_BINDING": { "project_id": "some-project-id" } }, "analytics_engine_datasets": { "ANALYTICS_ENGINE_BINDING": { "dataset": "api_analytics" } }, "browsers": { "BROWSER": {} }, "d1_databases": { "D1_BINDING": { "id": "445e2955-951a-43f8-a35b-a4d0c8138f63" } }, "durable_object_namespaces": { "DO_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "hyperdrive_bindings": { "HYPERDRIVE": { "id": "a76a99bc342644deb02c38d66082262a" } }, "kv_namespaces": { "KV_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "limits": { "cpu_ms": 100 }, "mtls_certificates": { "MTLS": { "certificate_id": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" } }, "placement": { "mode": "smart" }, "queue_producers": { "QUEUE_PRODUCER_BINDING": { "name": "some-queue" } }, "r2_buckets": { "R2_BINDING": { "name": "some-bucket", "jurisdiction": "eu" } }, "services": { "SERVICE_BINDING": { "environment": "production", "service": "example-worker", "entrypoint": "MyHandler" } }, "vectorize_bindings": { "VECTORIZE": { "index_name": "my_index" } }, "wrangler_config_hash": "abc123def456" }, "production": { "always_use_latest_compatibility_date": false, "build_image_major_version": 3, "compatibility_date": "2025-01-01T00:00:00Z", "compatibility_flags": [ "url_standard" ], "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "fail_open": true, "usage_model": "standard", "ai_bindings": { "AI_BINDING": { "project_id": "some-project-id" } }, "analytics_engine_datasets": { "ANALYTICS_ENGINE_BINDING": { "dataset": "api_analytics" } }, "browsers": { "BROWSER": {} }, "d1_databases": { "D1_BINDING": { "id": "445e2955-951a-43f8-a35b-a4d0c8138f63" } }, "durable_object_namespaces": { "DO_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "hyperdrive_bindings": { "HYPERDRIVE": { "id": "a76a99bc342644deb02c38d66082262a" } }, "kv_namespaces": { "KV_BINDING": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" } }, "limits": { "cpu_ms": 100 }, "mtls_certificates": { "MTLS": { "certificate_id": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e" } }, "placement": { "mode": "smart" }, "queue_producers": { "QUEUE_PRODUCER_BINDING": { "name": "some-queue" } }, "r2_buckets": { "R2_BINDING": { "name": "some-bucket", "jurisdiction": "eu" } }, "services": { "SERVICE_BINDING": { "environment": "production", "service": "example-worker", "entrypoint": "MyHandler" } }, "vectorize_bindings": { "VECTORIZE": { "index_name": "my_index" } }, "wrangler_config_hash": "abc123def456" } }, "framework": "framework", "framework_version": "framework_version", "latest_deployment": { "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6", "aliases": [ "https://branchname.projectname.pages.dev" ], "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "created_on": "2021-03-09T00:55:03.923456Z", "deployment_trigger": { "metadata": { "branch": "main", "commit_dirty": false, "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421", "commit_message": "Update index.html" }, "type": "ad_hoc" }, "env_vars": { "foo": { "type": "plain_text", "value": "hello world" } }, "environment": "preview", "is_skipped": true, "latest_stage": { "ended_on": "2021-03-09T00:58:59.045655Z", "name": "deploy", "started_on": "2021-03-09T00:55:03.923456Z", "status": "success" }, "modified_on": "2021-03-09T00:58:59.045655Z", "project_id": "7b162ea7-7367-4d67-bcde-1160995d5", "project_name": "this-is-my-project-01", "short_id": "f64788e9", "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "stages": [ { "ended_on": "2021-06-03T15:39:03.134378Z", "name": "queued", "started_on": "2021-06-03T15:38:15.608194Z", "status": "active" }, { "ended_on": null, "name": "initialize", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "clone_repo", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "build", "started_on": null, "status": "idle" }, { "ended_on": null, "name": "deploy", "started_on": null, "status": "idle" } ], "url": "https://f64788e9.ninjakittens.pages.dev", "skip_reason": "commit_message", "uses_functions": true }, "name": "this-is-my-project-01", "preview_script_name": "pages-worker--1234567-preview", "production_branch": "main", "production_script_name": "pages-worker--1234567-production", "uses_functions": true, "build_config": { "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x", "build_caching": true, "build_command": "npm run build", "destination_dir": "build", "root_dir": "/" }, "domains": [ "customdomain.com", "customdomain.org" ], "source": { "config": { "deployments_enabled": true, "owner": "my-org", "owner_id": "12345678", "path_excludes": [ "string" ], "path_includes": [ "string" ], "pr_comments_enabled": true, "preview_branch_excludes": [ "string" ], "preview_branch_includes": [ "string" ], "preview_deployment_setting": "all", "production_branch": "main", "production_deployments_enabled": true, "repo_id": "12345678", "repo_name": "my-repo" }, "type": "github" }, "subdomain": "helloworld.pages.dev" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```