PATCH /v1/projects/{idOrName}/protection-bypass
Update the deployment protection automation bypass for a project
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrName |
String | Yes |
The unique project identifier or the project name |
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 |
|---|---|---|---|
generate |
Object | No |
Generate a new secret. If neither generate or revoke are provided, a new random secret will be generated. |
generate.secret |
String | No |
Optional value of the secret to generate, don't send it for oauth2 tokens |
revoke |
Object | No |
Optional instructions for revoking and regenerating a automation bypass |
revoke.regenerate |
Boolean | Yes |
Whether or not a new automation bypass should be created after the provided secret is revoked |
revoke.secret |
String | Yes |
Automation bypass to revoked |
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.