Vaults

Update a vault credential

Changed on

Updates credential metadata or rotates its write-only secret. See vaults.

post/vaults/{vault_id}/credentials/{credential_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/vaults/{vault_id}/credentials/{credential_id}
  • Auth
    HTTP bearer

Path parameters

vault_idstring required

The ID of the vault.

credential_idstring required

The ID of the vault credential.

Request body

metadataobject

Replaces all metadata. Omit to preserve it, or pass {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.

Example request

{
  "metadata": {}
}

Response

The updated vault credential without secret values.

idstring required

The ID of the credential.

object'vault.credential' required

The object type. Always vault.credential.

vault_idstring required

The ID of the vault containing this credential.

namestring required

The human-readable name of the credential.

metadataobject required

Application-defined key-value pairs associated with this credential.

created_atinteger required

The Unix timestamp, in seconds, when the credential was created.

updated_atinteger required

The Unix timestamp, in seconds, when the credential was last updated.

Changes