PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}/secrets
This endpoint updates the secrets of a resource. If a resource has projects connected, the connected secrets are updated with the new secrets. The old secrets may still be used by existing connected projects because they are not automatically redeployed. Redeployment is a manual action and must be completed by the user. All new project connections will use the new secrets.
Use cases for this endpoint:
- Resetting the credentials of a database in the partner. If the user requests the credentials to be updated in the partner’s application, the partner post the new set of secrets to Vercel, the user should redeploy their application and the expire the old credentials.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
integrationConfigurationId |
String | Yes | |
resourceId |
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 |
|---|---|---|---|
secrets[] |
Array | Yes | |
secrets[].environmentOverrides |
Object | No |
A map of environments to override values for the secret, used for setting different values across deployments in production, preview, and development environments. Note: the same value will be used for all deployments in the given environment. |
secrets[].environmentOverrides.production |
String | No |
Value used for production environment. |
secrets[].environmentOverrides.preview |
String | No |
Value used for preview environment. |
secrets[].environmentOverrides.development |
String | No |
Value used for development environment. |
secrets[].name |
String | Yes | |
secrets[].prefix |
String | No | |
secrets[].value |
String | Yes | |
partial |
Boolean | No |
If true, will only overwrite the provided secrets instead of replacing all secrets. |
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.