Skip to content
Docs

Update Resource Secrets

PUThttps://api.vercel.com/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.
https://api.vercel.com/v1/installations/{integrationConfigurationId}/resources/{resourceId}/secrets
const response = await fetch('https://api.vercel.com/v1/installations/integrationConfigurationId/resources/resourceId/secrets', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "secrets": [
      {
        "name": "Example Name",
        "value": "string",
        "prefix": "string",
        "environmentOverrides": {
          "development": "string",
          "preview": "string",
          "production": "string"
        }
      }
    ],
    "partial": "true"
  }),
});


const data = await response.json();
console.log(data);
Response
{}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired
resourceIdstringRequired

Request

This endpoint expects an object.

secretsarrayRequired
partialbooleanOptional
If true, will only overwrite the provided secrets instead of replacing all secrets.

Response

201Success

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error
422Error
Update Resource Secrets | Vercel API