--- title: Create a Pages deployment --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Pages](https://developers.cloudflare.com/api/typescript/resources/pages) [Projects](https://developers.cloudflare.com/api/typescript/resources/pages/subresources/projects) [Deployments](https://developers.cloudflare.com/api/typescript/resources/pages/subresources/projects/subresources/deployments) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a Pages deployment client.pages.projects.deployments.create(stringprojectName, DeploymentCreateParams {account\_id, \_headers, \_redirects, 11 more } params, RequestOptionsoptions?): [Deployment]() {id, aliases, build\_config, 15 more } POST/accounts/{account\_id}/pages/projects/{project\_name}/deployments Create a Cloudflare Pages deployment from a Git branch or Direct Upload manifest. Git repositories must already be authorized in Cloudflare Pages. ##### 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 Write` ##### ParametersExpand Collapse projectName: 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.deployments%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20project_name%20%3E%20(schema)>)

params: DeploymentCreateParams {account\_id, \_headers, \_redirects, 11 more }

account\_id: string Path param: Identifier. maxLength32 Link to this property \_headers?: Uploadable Body param: Headers configuration file for the deployment. Link to this property \_redirects?: Uploadable Body param: Redirects configuration file for the deployment. Link to this property \_routesJson?: Uploadable Body param: Routes configuration file defining routing rules. Link to this property \_workerBundle?: Uploadable Body param: Worker bundle file in multipart/form-data format. Mutually exclusive with _worker.js. Cannot specify both _worker.js and _worker.bundle in the same request. Maximum size: 25 MiB. Link to this property \_workerJS?: Uploadable Body param: Worker JavaScript file. Mutually exclusive with _worker.bundle. Cannot specify both _worker.js and _worker.bundle in the same request. Link to this property branch?: string Body param: Git branch to deploy. Uses the branch’s HEAD; defaults to the project’s production branch. Link to this property

commit\_dirty?: "true"| "false" Body param: Whether the associated Git working tree has uncommitted changes. Provide true or false.

One of the following: "true" Link to this property "false" Link to this property

Link to this property commit\_hash?: string Body param: Git commit SHA associated with the deployment. Link to this property commit\_message?: string Body param: Git commit message associated with the deployment. Link to this property functionsFilepathRoutingConfigJson?: Uploadable Body param: Functions routing configuration file. Link to this property manifest?: string Body param: JSON-encoded object mapping deployment file paths to their uploaded content hashes. Required for Direct Upload deployments. Maximum 20,000 entries. Link to this property pages\_build\_output\_dir?: string Body param: The build output directory path. Link to this property wrangler\_config\_hash?: string Body param: Hash of the Wrangler configuration file used for this deployment. Link to this property

[Link to this property](<#(resource)%20pages.projects.deployments%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

Deployment {id, aliases, build\_config, 15 more }

id: string Id of the deployment. Link to this property aliases: Array<string>| null A list of alias URLs pointing to this deployment. Link to this property

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

web\_analytics\_tag: string| null The classifying tag for analytics. Link to this property web\_analytics\_token: string| null The auth token for analytics. Link to this property build\_caching?: boolean| null Enable build caching for the project. Link to this property build\_command?: string| null Command used to build project. Link to this property destination\_dir?: string| null Assets output directory of the build. Link to this property root\_dir?: string| null 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: DeploymentTrigger {metadata, type } Info about what caused the deployment.

metadata: Metadata {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"| "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

env\_vars: Record<string, PagesPlainTextEnvVar {type, value } | null| PagesSecretTextEnvVar {type, value } | null>| null Environment variables used for builds and Pages Functions.

One of the following:

PagesPlainTextEnvVar {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

PagesSecretTextEnvVar {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"| "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| null When the stage ended. formatdate-time Link to this property

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

status: "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: 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: Source {config, type } Configs for the project source control.

config: Config {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<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<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<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<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"| "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: 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"| "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<Stage {ended\_on, name, started\_on, status } > List of past stages.

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

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

status: "success"| "idle"| "active"| 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?: "commit\_message"| "preview\_deployments\_disabled"| "production\_deployments\_disabled"| 4 more| null 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?: boolean| null Whether the deployment uses functions. Link to this property

[Link to this property](<#(resource)%20pages.projects%20%3E%20(model)%20deployment%20%3E%20(schema)>) ### Create a Pages deployment TypeScript HTTPTypeScriptPythonGoTerraform ``` import fs from 'fs'; import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const deployment = await client.pages.projects.deployments.create('this-is-my-project-01', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(deployment.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": "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 }, "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": "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 }, "success": true } ```