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 |
|---|---|---|---|
id |
String | No |
Id of the project. |
production_branch |
String | No |
Production branch of the project. Used to identify production deployments. |
source |
Object | No | |
source.config |
Object | No | |
source.config.production_branch |
String | No | |
source.config.path_excludes[] |
Array | No | |
source.config.deployments_enabled |
Boolean | No | |
source.config.preview_branch_includes[] |
Array | No | |
source.config.preview_deployment_setting |
String | No |
Possible values:
|
source.config.path_includes[] |
Array | No | |
source.config.pr_comments_enabled |
Boolean | No | |
source.config.preview_branch_excludes[] |
Array | No | |
source.config.owner |
String | No | |
source.config.production_deployments_enabled |
Boolean | No | |
source.config.repo_name |
String | No | |
source.type |
String | No | |
build_config |
Object | No |
Configs for the project build process. |
build_config.build_caching |
Boolean | No |
Enable build caching for the project. |
build_config.web_analytics_tag |
String | No |
The classifying tag for analytics. |
build_config.destination_dir |
String | No |
Output directory of the build. |
build_config.root_dir |
String | No |
Directory to run the command. |
build_config.build_command |
String | No |
Command used to build project. |
build_config.web_analytics_token |
String | No |
The auth token for analytics. |
domains[] |
Array | No |
A list of associated custom domains for the project. |
name |
String | No |
Name of 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.preview |
Object | No |
Configs for preview deploys. |
created_on |
String | No |
When the project was created. |
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.