PATCH /accounts/{account_id}/pages/projects/{project_name}
Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_name |
String | Yes | |
account_id |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
source |
Object | No | |
source.config |
Object | No | |
source.config.production_branch |
String | No |
The production branch of the repository. |
source.config.path_excludes[] |
Array | No |
A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax ( |
source.config.deployments_enabled |
Boolean | No |
Whether to enable automatic deployments when pushing to the source repository. When disabled, no deployments (production or preview) will be triggered automatically. |
source.config.preview_branch_includes[] |
Array | No |
A list of branches that should trigger a preview deployment. Wildcard syntax ( Default value: [ "*" ] |
source.config.preview_deployment_setting |
String | No |
Controls whether commits to preview branches trigger a preview deployment. Valid values:
Default value: "all" |
source.config.path_includes[] |
Array | No |
A list of paths that should be watched to trigger a preview deployment. Wildcard syntax ( Default value: [ "*" ] |
source.config.pr_comments_enabled |
Boolean | No |
Whether to enable PR comments. |
source.config.preview_branch_excludes[] |
Array | No |
A list of branches that should not trigger a preview deployment. Wildcard syntax ( |
source.config.owner |
String | No |
The owner of the repository. |
source.config.production_deployments_enabled |
Boolean | No |
Whether to trigger a production deployment on commits to the production branch. |
source.config.repo_name |
String | No |
The name of the repository. |
source.type |
String | No |
The source control management provider. Valid values:
|
domains[] |
Array | No |
A list of associated custom domains for the project. |
subdomain |
String | No |
The Cloudflare subdomain associated with the project. |
deployment_configs |
Object | No |
Configs for deployments in a project. |
deployment_configs.production |
Object | No |
Configs for production deploys. |
deployment_configs.production.build_image_major_version |
Integer | No |
The major version of the build image to use for Pages Functions. Default value: 3 |
deployment_configs.production.compatibility_flags[] |
Array | No |
Compatibility flags used for Pages Functions. |
deployment_configs.production.env_vars |
Object | No |
Environment variables used for builds and Pages Functions. |
deployment_configs.production.env_vars.plain_text |
Object | No |
A plaintext environment variable. |
deployment_configs.production.env_vars.plain_text.type |
String | Yes |
Valid values:
|
deployment_configs.production.env_vars.plain_text.value |
String | Yes |
Environment variable value. |
deployment_configs.production.env_vars.secret_text |
Object | No |
An encrypted environment variable. |
deployment_configs.production.env_vars.secret_text.type |
String | Yes |
Valid values:
|
deployment_configs.production.env_vars.secret_text.value |
String | Yes |
Secret value. |
deployment_configs.production.mtls_certificates |
Object | No |
mTLS bindings used for Pages Functions. |
deployment_configs.production.mtls_certificates.name |
Object | No |
mTLS binding. |
deployment_configs.production.mtls_certificates.name.certificate_id |
String | No | |
deployment_configs.production.placement |
Object | No |
Placement setting used for Pages Functions. |
deployment_configs.production.placement.mode |
String | No |
Placement mode. |
deployment_configs.production.analytics_engine_datasets |
Object | No |
Analytics Engine bindings used for Pages Functions. |
deployment_configs.production.analytics_engine_datasets.name |
Object | No |
Analytics Engine binding. |
deployment_configs.production.analytics_engine_datasets.name.dataset |
String | No |
Name of the dataset. |
deployment_configs.production.browsers |
Object | No |
Browser bindings used for Pages Functions. |
deployment_configs.production.durable_object_namespaces |
Object | No |
Durable Object namespaces used for Pages Functions. |
deployment_configs.production.durable_object_namespaces.name |
Object | No |
Durable Object binding. |
deployment_configs.production.durable_object_namespaces.name.namespace_id |
String | No |
ID of the Durable Object namespace. |
deployment_configs.production.services |
Object | No |
Services used for Pages Functions. |
deployment_configs.production.services.name |
Object | No |
Service binding. |
deployment_configs.production.services.name.environment |
String | No |
The Service environment. |
deployment_configs.production.services.name.service |
String | No |
The Service name. |
deployment_configs.production.services.name.entrypoint |
String | No |
The entrypoint to bind to. |
deployment_configs.production.kv_namespaces |
Object | No |
KV namespaces used for Pages Functions. |
deployment_configs.production.kv_namespaces.name |
Object | No |
KV namespace binding. |
deployment_configs.production.kv_namespaces.name.namespace_id |
String | No |
ID of the KV namespace. |
deployment_configs.production.queue_producers |
Object | No |
Queue Producer bindings used for Pages Functions. |
deployment_configs.production.queue_producers.name |
Object | No |
Queue Producer binding. |
deployment_configs.production.queue_producers.name.name |
String | No |
Name of the Queue. |
deployment_configs.production.limits |
Object | No |
Limits for Pages Functions. |
deployment_configs.production.limits.cpu_ms |
Integer | No |
CPU time limit in milliseconds. |
deployment_configs.production.vectorize_bindings |
Object | No |
Vectorize bindings used for Pages Functions. |
deployment_configs.production.vectorize_bindings.name |
Object | No |
Vectorize binding. |
deployment_configs.production.vectorize_bindings.name.index_name |
String | No | |
deployment_configs.production.hyperdrive_bindings |
Object | No |
Hyperdrive bindings used for Pages Functions. |
deployment_configs.production.hyperdrive_bindings.name |
Object | No |
Hyperdrive binding. |
deployment_configs.production.hyperdrive_bindings.name.id |
String | No | |
deployment_configs.production.ai_bindings |
Object | No |
Constellation bindings used for Pages Functions. |
deployment_configs.production.ai_bindings.name |
Object | No |
AI binding. |
deployment_configs.production.ai_bindings.name.project_id |
String | No | |
deployment_configs.production.always_use_latest_compatibility_date |
Boolean | No |
Whether to always use the latest compatibility date for Pages Functions. Default value: false |
deployment_configs.production.r2_buckets |
Object | No |
R2 buckets used for Pages Functions. |
deployment_configs.production.r2_buckets.name |
Object | No |
R2 binding. |
deployment_configs.production.r2_buckets.name.jurisdiction |
String | No |
Jurisdiction of the R2 bucket. |
deployment_configs.production.r2_buckets.name.name |
String | No |
Name of the R2 bucket. |
deployment_configs.production.usage_model |
String | No |
The usage model for Pages Functions. Valid values:
Default value: "standard" |
deployment_configs.production.wrangler_config_hash |
String | No |
Hash of the Wrangler configuration used for the deployment. |
deployment_configs.production.fail_open |
Boolean | No |
Whether to fail open when the deployment config cannot be applied. Default value: true |
deployment_configs.production.compatibility_date |
String | No |
Compatibility date used for Pages Functions. |
deployment_configs.production.d1_databases |
Object | No |
D1 databases used for Pages Functions. |
deployment_configs.production.d1_databases.name |
Object | No |
D1 binding. |
deployment_configs.production.d1_databases.name.id |
String | No |
UUID of the D1 database. |
deployment_configs.preview |
Object | No |
Configs for preview deploys. |
deployment_configs.preview.build_image_major_version |
Integer | No |
The major version of the build image to use for Pages Functions. Default value: 3 |
deployment_configs.preview.compatibility_flags[] |
Array | No |
Compatibility flags used for Pages Functions. |
deployment_configs.preview.env_vars |
Object | No |
Environment variables used for builds and Pages Functions. |
deployment_configs.preview.env_vars.plain_text |
Object | No |
A plaintext environment variable. |
deployment_configs.preview.env_vars.plain_text.type |
String | Yes |
Valid values:
|
deployment_configs.preview.env_vars.plain_text.value |
String | Yes |
Environment variable value. |
deployment_configs.preview.env_vars.secret_text |
Object | No |
An encrypted environment variable. |
deployment_configs.preview.env_vars.secret_text.type |
String | Yes |
Valid values:
|
deployment_configs.preview.env_vars.secret_text.value |
String | Yes |
Secret value. |
deployment_configs.preview.mtls_certificates |
Object | No |
mTLS bindings used for Pages Functions. |
deployment_configs.preview.mtls_certificates.name |
Object | No |
mTLS binding. |
deployment_configs.preview.mtls_certificates.name.certificate_id |
String | No | |
deployment_configs.preview.placement |
Object | No |
Placement setting used for Pages Functions. |
deployment_configs.preview.placement.mode |
String | No |
Placement mode. |
deployment_configs.preview.analytics_engine_datasets |
Object | No |
Analytics Engine bindings used for Pages Functions. |
deployment_configs.preview.analytics_engine_datasets.name |
Object | No |
Analytics Engine binding. |
deployment_configs.preview.analytics_engine_datasets.name.dataset |
String | No |
Name of the dataset. |
deployment_configs.preview.browsers |
Object | No |
Browser bindings used for Pages Functions. |
deployment_configs.preview.durable_object_namespaces |
Object | No |
Durable Object namespaces used for Pages Functions. |
deployment_configs.preview.durable_object_namespaces.name |
Object | No |
Durable Object binding. |
deployment_configs.preview.durable_object_namespaces.name.namespace_id |
String | No |
ID of the Durable Object namespace. |
deployment_configs.preview.services |
Object | No |
Services used for Pages Functions. |
deployment_configs.preview.services.name |
Object | No |
Service binding. |
deployment_configs.preview.services.name.environment |
String | No |
The Service environment. |
deployment_configs.preview.services.name.service |
String | No |
The Service name. |
deployment_configs.preview.services.name.entrypoint |
String | No |
The entrypoint to bind to. |
deployment_configs.preview.kv_namespaces |
Object | No |
KV namespaces used for Pages Functions. |
deployment_configs.preview.kv_namespaces.name |
Object | No |
KV namespace binding. |
deployment_configs.preview.kv_namespaces.name.namespace_id |
String | No |
ID of the KV namespace. |
deployment_configs.preview.queue_producers |
Object | No |
Queue Producer bindings used for Pages Functions. |
deployment_configs.preview.queue_producers.name |
Object | No |
Queue Producer binding. |
deployment_configs.preview.queue_producers.name.name |
String | No |
Name of the Queue. |
deployment_configs.preview.limits |
Object | No |
Limits for Pages Functions. |
deployment_configs.preview.limits.cpu_ms |
Integer | No |
CPU time limit in milliseconds. |
deployment_configs.preview.vectorize_bindings |
Object | No |
Vectorize bindings used for Pages Functions. |
deployment_configs.preview.vectorize_bindings.name |
Object | No |
Vectorize binding. |
deployment_configs.preview.vectorize_bindings.name.index_name |
String | No | |
deployment_configs.preview.hyperdrive_bindings |
Object | No |
Hyperdrive bindings used for Pages Functions. |
deployment_configs.preview.hyperdrive_bindings.name |
Object | No |
Hyperdrive binding. |
deployment_configs.preview.hyperdrive_bindings.name.id |
String | No | |
deployment_configs.preview.ai_bindings |
Object | No |
Constellation bindings used for Pages Functions. |
deployment_configs.preview.ai_bindings.name |
Object | No |
AI binding. |
deployment_configs.preview.ai_bindings.name.project_id |
String | No | |
deployment_configs.preview.always_use_latest_compatibility_date |
Boolean | No |
Whether to always use the latest compatibility date for Pages Functions. Default value: false |
deployment_configs.preview.r2_buckets |
Object | No |
R2 buckets used for Pages Functions. |
deployment_configs.preview.r2_buckets.name |
Object | No |
R2 binding. |
deployment_configs.preview.r2_buckets.name.jurisdiction |
String | No |
Jurisdiction of the R2 bucket. |
deployment_configs.preview.r2_buckets.name.name |
String | No |
Name of the R2 bucket. |
deployment_configs.preview.usage_model |
String | No |
The usage model for Pages Functions. Valid values:
Default value: "standard" |
deployment_configs.preview.wrangler_config_hash |
String | No |
Hash of the Wrangler configuration used for the deployment. |
deployment_configs.preview.fail_open |
Boolean | No |
Whether to fail open when the deployment config cannot be applied. Default value: true |
deployment_configs.preview.compatibility_date |
String | No |
Compatibility date used for Pages Functions. |
deployment_configs.preview.d1_databases |
Object | No |
D1 databases used for Pages Functions. |
deployment_configs.preview.d1_databases.name |
Object | No |
D1 binding. |
deployment_configs.preview.d1_databases.name.id |
String | No |
UUID of the D1 database. |
created_on |
String | No |
When the project was created. |
production_script_name |
String | No |
Name of the production script. |
id |
String | Yes |
ID of the project. |
production_branch |
String | Yes |
Production branch of the project. Used to identify production deployments. |
name |
String | Yes |
Name of the project. |
preview_script_name |
String | No |
Name of the preview script. |
uses_functions |
Boolean | No |
Whether the project uses functions. |
framework_version |
String | No |
Version of the framework the project is using. |
framework |
String | No |
Framework the project is using. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.