PATCH /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}
Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrName |
String | Yes |
The unique project identifier or the project name |
environmentSlugOrId |
String | Yes |
The unique custom environment identifier within the project |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
slug |
String | No |
The Team slug to perform the request on behalf of. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
Description of the custom environment. This is optional. |
slug |
String | No |
The slug of the custom environment. |
branchMatcher |
Object | No |
How we want to determine a matching branch. This is optional. |
branchMatcher.type |
String | Yes |
Type of matcher. One of "equals", "startsWith", or "endsWith". Possible values:
|
branchMatcher.pattern |
String | Yes |
Git branch name or portion thereof. |
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.