Sign in
Vaults

Update a vault credential

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

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

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

Changed in 4 of the 163 revisions of this API.27

  • de263316e28b1See the full diff
    • ▲

      request body became required

      request-body-became-required

  • d1cbc7a204613See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      added the required property to the response with the status

      response-required-property-added

  • ae9b7322bc4f13See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added environment_variable discriminator mapping keys to the request property

      request-property-discriminator-mapping-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added

    • ○

      added environment_variable discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added

  • f2dae1a9aced1See the full diff
    • ○

      endpoint added

      endpoint-added