--- title: Get a Cloudflare Pages project --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Pages](https://developers.cloudflare.com/api/resources/pages) [Projects](https://developers.cloudflare.com/api/resources/pages/subresources/projects) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a Cloudflare Pages project GET/accounts/{account\_id}/pages/projects/{project\_name} Retrieve the configuration and deployment settings for a Cloudflare Pages project. ##### 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` ##### P ath ParametersExpand Collapse account\_id: string Identifier. maxLength32 [Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) project\_name: string 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](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20project_name%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)

result: Project { id, canonical\_deployment, created\_on, 13 more }

id: string ID of the project. Link to this property

canonical\_deployment: Deployment { id, aliases, build\_config, 15 more } Most recent production deployment of the project.

id: string Id of the deployment. Link to this property aliases: array of string A list of alias URLs pointing to this deployment. Link to this property

build\_config: object {web\_analytics\_tag, web\_analytics\_token, build\_caching, 3 more } Configs for the project build process.

web\_analytics\_tag: string The classifying tag for analytics. Link to this property web\_analytics\_token: string The auth token for analytics. Link to this property build\_caching: optional boolean Enable build caching for the project. Link to this property build\_command: optional string Command used to build project. Link to this property destination\_dir: optional string Assets output directory of the build. Link to this property root\_dir: optional string Directory to run the command. Link to this property

Link to this property created\_on: string When the deployment was created. formatdate-time Link to this property

deployment\_trigger: object {metadata, type } Info about what caused the deployment.

metadata: object {branch, commit\_dirty, commit\_hash, commit\_message } Additional info about the trigger.

branch: string Where the trigger happened. Link to this property commit\_dirty: boolean Whether the deployment trigger commit was dirty. Link to this property commit\_hash: string Hash of the deployment trigger commit. Link to this property commit\_message: string Message of the deployment trigger commit. Link to this property

Link to this property

type: "github:push"or "ad\_hoc"or "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

env\_vars: map\[object {type, value } or object {type, value } ] Environment variables used for builds and Pages Functions.

One of the following:

PlainText object {type, value } A plaintext environment variable.

type: "plain\_text" Link to this property value: string Environment variable value. Link to this property

Link to this property

SecretText object {type, value } An encrypted environment variable.

type: "secret\_text" Link to this property value: string Secret value. Link to this property

Link to this property

environment: "preview"or "production" Type of deploy.

One of the following: "preview" Link to this property "production" Link to this property

Link to this property is\_skipped: boolean Whether the deployment was skipped. Link to this property

latest\_stage: Stage { ended\_on, name, started\_on, status } The status of the deployment.

ended\_on: string When the stage ended. formatdate-time Link to this property

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: string When the stage started. formatdate-time Link to this property

status: "success"or "idle"or "active"or 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: string When the deployment was last modified. formatdate-time Link to this property project\_id: string Id of the project. Link to this property project\_name: string 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: string Short Id (8 character) of the deployment. Link to this property

source: object {config, type } Configs for the project source control.

config: object {deployments\_enabled, owner, owner\_id, 10 more }

Deprecateddeployments\_enabled: boolean 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: string The owner of the repository. Link to this property owner\_id: string The owner ID of the repository. Link to this property path\_excludes: array of string A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (*) is supported. Link to this property path\_includes: array of string A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (*) is supported. Link to this property pr\_comments\_enabled: boolean Whether to enable PR comments. Link to this property preview\_branch\_excludes: array of 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. Link to this property preview\_branch\_includes: array of 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. Link to this property

preview\_deployment\_setting: "all"or "none"or "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: string The production branch of the repository. Link to this property production\_deployments\_enabled: boolean Whether to trigger a production deployment on commits to the production branch. Link to this property repo\_id: string The ID of the repository. Link to this property repo\_name: string The name of the repository. Link to this property

Link to this property

type: "github"or "gitlab" The source control management provider.

One of the following: "github" Link to this property "gitlab" Link to this property

Link to this property

stages: array of Stage { ended\_on, name, started\_on, status } List of past stages.

ended\_on: string When the stage ended. formatdate-time Link to this property

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: string When the stage started. formatdate-time Link to this property

status: "success"or "idle"or "active"or 3 more State of the current stage.

Link to this property

Link to this property url: string The live URL to view this deployment. Link to this property

skip\_reason: optional "commit\_message"or "preview\_deployments\_disabled"or "production\_deployments\_disabled"or 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 boolean Whether the deployment uses functions. Link to this property

Link to this property created\_on: string When the project was created. formatdate-time Link to this property

deployment\_configs: object {preview, production } Configs for deployments in a project.

preview: object {always\_use\_latest\_compatibility\_date, build\_image\_major\_version, compatibility\_date, 19 more } Configs for preview deploys.

always\_use\_latest\_compatibility\_date: boolean Whether to always use the latest compatibility date for Pages Functions. Link to this property build\_image\_major\_version: number The major version of the build image to use for Pages Functions. Link to this property compatibility\_date: string Compatibility date used for Pages Functions. Link to this property compatibility\_flags: array of string Compatibility flags used for Pages Functions. Link to this property

env\_vars: map\[object {type, value } or object {type, value } ] Environment variables used for builds and Pages Functions.

One of the following:

PlainText object {type, value } A plaintext environment variable.

type: "plain\_text" Link to this property value: string Environment variable value. Link to this property

Link to this property

SecretText object {type, value } An encrypted environment variable.

type: "secret\_text" Link to this property value: string Secret value. Link to this property

Link to this property

Link to this property fail\_open: boolean Whether to fail open when the deployment config cannot be applied. Link to this property

Deprecatedusage\_model: "standard"or "bundled"or "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 map\[object {project\_id } ] Constellation bindings used for Pages Functions.

project\_id: string Link to this property

Link to this property

analytics\_engine\_datasets: optional map\[object {dataset } ] Analytics Engine bindings used for Pages Functions.

dataset: string Name of the dataset. Link to this property

Link to this property browsers: optional map\[object {} ] Browser bindings used for Pages Functions. Link to this property

d1\_databases: optional map\[object {id } ] D1 databases used for Pages Functions.

id: string UUID of the D1 database. Link to this property

Link to this property

durable\_object\_namespaces: optional map\[object {namespace\_id } ] Durable Object namespaces used for Pages Functions.

namespace\_id: string ID of the Durable Object namespace. Link to this property

Link to this property

hyperdrive\_bindings: optional map\[object {id } ] Hyperdrive bindings used for Pages Functions.

id: string Link to this property

Link to this property

kv\_namespaces: optional map\[object {namespace\_id } ] KV namespaces used for Pages Functions.

namespace\_id: string ID of the KV namespace. Link to this property

Link to this property

limits: optional object {cpu\_ms } Limits for Pages Functions.

cpu\_ms: number CPU time limit in milliseconds. Link to this property

Link to this property

mtls\_certificates: optional map\[object {certificate\_id } ] mTLS bindings used for Pages Functions.

certificate\_id: string Link to this property

Link to this property

placement: optional object {mode } Placement setting used for Pages Functions.

mode: string Placement mode. Link to this property

Link to this property

queue\_producers: optional map\[object {name } ] Queue Producer bindings used for Pages Functions.

Link to this property

r2\_buckets: optional map\[object {name, jurisdiction } ] R2 buckets used for Pages Functions.

name: string Name of the R2 bucket. Link to this property jurisdiction: optional string Jurisdiction of the R2 bucket. Link to this property

Link to this property

services: optional map\[object {environment, service, entrypoint } ] Services used for Pages Functions.

environment: string The Service environment. Link to this property service: string The Service name. Link to this property entrypoint: optional string The entrypoint to bind to. Link to this property

Link to this property

vectorize\_bindings: optional map\[object {index\_name } ] Vectorize bindings used for Pages Functions.

index\_name: string Link to this property

Link to this property wrangler\_config\_hash: optional string Hash of the Wrangler configuration used for the deployment. Link to this property

Link to this property

production: object {always\_use\_latest\_compatibility\_date, build\_image\_major\_version, compatibility\_date, 19 more } Configs for production deploys.

env\_vars: map\[object {type, value } or object {type, value } ] Environment variables used for builds and Pages Functions.

One of the following:

PlainText object {type, value } A plaintext environment variable.

type: "plain\_text" Link to this property value: string Environment variable value. Link to this property

Link to this property

SecretText object {type, value } An encrypted environment variable.

type: "secret\_text" Link to this property value: string Secret value. Link to this property

Link to this property

Link to this property fail\_open: boolean Whether to fail open when the deployment config cannot be applied. Link to this property

Deprecatedusage\_model: "standard"or "bundled"or "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 map\[object {project\_id } ] Constellation bindings used for Pages Functions.

project\_id: string Link to this property

Link to this property

analytics\_engine\_datasets: optional map\[object {dataset } ] Analytics Engine bindings used for Pages Functions.

dataset: string Name of the dataset. Link to this property

Link to this property browsers: optional map\[object {} ] Browser bindings used for Pages Functions. Link to this property

d1\_databases: optional map\[object {id } ] D1 databases used for Pages Functions.

id: string UUID of the D1 database. Link to this property

Link to this property

durable\_object\_namespaces: optional map\[object {namespace\_id } ] Durable Object namespaces used for Pages Functions.

namespace\_id: string ID of the Durable Object namespace. Link to this property

Link to this property

hyperdrive\_bindings: optional map\[object {id } ] Hyperdrive bindings used for Pages Functions.

id: string Link to this property

Link to this property

kv\_namespaces: optional map\[object {namespace\_id } ] KV namespaces used for Pages Functions.

namespace\_id: string ID of the KV namespace. Link to this property

Link to this property

limits: optional object {cpu\_ms } Limits for Pages Functions.

cpu\_ms: number CPU time limit in milliseconds. Link to this property

Link to this property

mtls\_certificates: optional map\[object {certificate\_id } ] mTLS bindings used for Pages Functions.

certificate\_id: string Link to this property

Link to this property

placement: optional object {mode } Placement setting used for Pages Functions.

mode: string Placement mode. Link to this property

Link to this property

queue\_producers: optional map\[object {name } ] Queue Producer bindings used for Pages Functions.

Link to this property

r2\_buckets: optional map\[object {name, jurisdiction } ] R2 buckets used for Pages Functions.

name: string Name of the R2 bucket. Link to this property jurisdiction: optional string Jurisdiction of the R2 bucket. Link to this property

Link to this property

services: optional map\[object {environment, service, entrypoint } ] Services used for Pages Functions.

environment: string The Service environment. Link to this property service: string The Service name. Link to this property entrypoint: optional string The entrypoint to bind to. Link to this property

Link to this property

vectorize\_bindings: optional map\[object {index\_name } ] Vectorize bindings used for Pages Functions.

index\_name: string Link to this property

Link to this property wrangler\_config\_hash: optional string Hash of the Wrangler configuration used for the deployment. Link to this property

Link to this property

Link to this property framework: string Framework the project is using. Link to this property framework\_version: string Version of the framework the project is using. Link to this property

latest\_deployment: Deployment { id, aliases, build\_config, 15 more } Most recent deployment of the project.

id: string Id of the deployment. Link to this property aliases: array of string A list of alias URLs pointing to this deployment. Link to this property

build\_config: object {web\_analytics\_tag, web\_analytics\_token, build\_caching, 3 more } Configs for the project build process.

Link to this property created\_on: string When the deployment was created. formatdate-time Link to this property

deployment\_trigger: object {metadata, type } Info about what caused the deployment.

metadata: object {branch, commit\_dirty, commit\_hash, commit\_message } Additional info about the trigger.

Link to this property

type: "github:push"or "ad\_hoc"or "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

env\_vars: map\[object {type, value } or object {type, value } ] Environment variables used for builds and Pages Functions.

One of the following:

PlainText object {type, value } A plaintext environment variable.

type: "plain\_text" Link to this property value: string Environment variable value. Link to this property

Link to this property

SecretText object {type, value } An encrypted environment variable.

type: "secret\_text" Link to this property value: string Secret value. Link to this property

Link to this property

environment: "preview"or "production" Type of deploy.

One of the following: "preview" Link to this property "production" Link to this property

Link to this property is\_skipped: boolean Whether the deployment was skipped. Link to this property

latest\_stage: Stage { ended\_on, name, started\_on, status } The status of the deployment.

ended\_on: string When the stage ended. formatdate-time Link to this property

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: string When the stage started. formatdate-time Link to this property

status: "success"or "idle"or "active"or 3 more State of the current stage.

Link to this property

source: object {config, type } Configs for the project source control.

config: object {deployments\_enabled, owner, owner\_id, 10 more }

preview\_deployment\_setting: "all"or "none"or "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

type: "github"or "gitlab" The source control management provider.

One of the following: "github" Link to this property "gitlab" Link to this property

Link to this property

stages: array of Stage { ended\_on, name, started\_on, status } List of past stages.

ended\_on: string When the stage ended. formatdate-time Link to this property

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: string When the stage started. formatdate-time Link to this property

status: "success"or "idle"or "active"or 3 more State of the current stage.

Link to this property

Link to this property url: string The live URL to view this deployment. Link to this property

skip\_reason: optional "commit\_message"or "preview\_deployments\_disabled"or "production\_deployments\_disabled"or 4 more Why the deployment was skipped.

Link to this property uses\_functions: optional boolean Whether the deployment uses functions. Link to this property

Link to this property name: string 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: string Name of the preview script. Link to this property production\_branch: string Production branch of the project. Used to identify production deployments. Link to this property production\_script\_name: string Name of the production script. Link to this property uses\_functions: boolean Whether the project uses functions. Link to this property

build\_config: optional object {web\_analytics\_tag, web\_analytics\_token, build\_caching, 3 more } Configs for the project build process.

Link to this property domains: optional array of string A list of associated custom domains for the project. Link to this property

source: optional object {config, type } Configs for the project source control.

config: object {deployments\_enabled, owner, owner\_id, 10 more }

preview\_deployment\_setting: "all"or "none"or "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

type: "github"or "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 string The Cloudflare subdomain associated with the project. Link to this property

[Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20pages.projects%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### Get a Cloudflare Pages project HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/pages/projects/$PROJECT_NAME \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } ``` ##### 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 } ```