VEvercel
ai-gateway

Update a BYOK credential

Changed on

Update a BYOK credential. Send credential to replace the key value in place, which keeps the credential ID, settings and model mappings.

patch/ai-gateway/byok-credentials/{credentialId}

Request

  • Base URL
    https://api.vercel.com
  • URL
    https://api.vercel.com/ai-gateway/byok-credentials/{credentialId}
  • Auth
    HTTP bearer

Path parameters

credentialIdstring required

The unique ID of the credential to update

Query parameters

ownerIdstring
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring

The new name for the credential

activeboolean

Whether the credential should be active

zeroDataRetentionboolean

Whether the customer attested this external credential has a zero data retention policy

userIdstring

The ID of the user performing this action, used for Activity-log attribution.

Response

activefalse | true required
createdAtnumber required
credentialIdstring required
lastFourCharsstring required
namestring required
ownerIdstring required
providerSlugstring required
rotatedAtnumber nullable required
updatedAtnumber required
zeroDataRetentionfalse | true required

Changes