Vaults

Create a vault credential

Creates a vault credential. Secret values are write-only and are never returned. See vaults.

post/vaults/{vault_id}/credentials

Path parameters

vault_idstring required

The ID of the vault.

Request body

namestring required

The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.

metadataobject

Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. Defaults to an empty map.

Response

The created 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 3 of the 163 revisions of this API.16

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      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

    • ○

      endpoint added

      endpoint-added