Update a BYOK credential | Edgenivo REST API

APIs & SDKs

Update a BYOK credential

PATCH/__remote/api.vercel.com/ai-gateway/byok-credentials/{credentialId}

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

/__remote/api.vercel.com/ai-gateway/byok-credentials/{credentialId}

const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials/credentialId?ownerId=string&teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Name",
    "active": "true",
    "zeroDataRetention": "true",
    "userId": "example_id"
  }),
});

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

Response

{
  "active": "false",
  "createdAt": "123",
  "credentialId": "example_id",
  "lastFourChars": "string",
  "name": "Example Name",
  "ownerId": "example_id",
  "providerSlug": "example_id",
  "updatedAt": "123",
  "zeroDataRetention": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

credentialIdstringRequired

The unique ID of the credential to update

Query parameters

ownerIdstringOptional

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

namestringOptional

The new name for the credential

activebooleanOptional

Whether the credential should be active

zeroDataRetentionbooleanOptional

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

userIdstringOptional

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

Response

200Success

activebooleanRequired

createdAtnumberRequired

credentialIdstringRequired

lastFourCharsstringRequired

namestringRequired

ownerIdstringRequired

providerSlugstringRequired

updatedAtnumberRequired

zeroDataRetentionbooleanRequired

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

410Error

500Error

/__remote/api.vercel.com/ai-gateway/byok-credentials/{credentialId}

const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials/credentialId?ownerId=string&teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Name",
    "active": "true",
    "zeroDataRetention": "true",
    "userId": "example_id"
  }),
});

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

Response

{
  "active": "false",
  "createdAt": "123",
  "credentialId": "example_id",
  "lastFourChars": "string",
  "name": "Example Name",
  "ownerId": "example_id",
  "providerSlug": "example_id",
  "updatedAt": "123",
  "zeroDataRetention": "false"
}

OpenAPI Specification