HYhyperbrowser

Update a vault

Changed on

Changes a vault's description or entries. Entries you pass replace those variables and null removes one; others are kept. Processes that already started keep the values they received. Secrets are enabled for teams on request; please contact support to enable them (otherwise 403 SECRETS_FEATURE_DISABLED). Restricted API keys need the secrets.manage scope. When you're signed in rather than using an API key, you must be a team owner or admin (otherwise 403 SECRETS_ADMIN_REQUIRED).

patch/api/vaults/{id}

Request

Path parameters

idstring uuid required

Vault ID.

Request body

descriptionstring

Replaces the description. Trimmed before it's stored.

entriesobject

Entries to change: each one given replaces that variable, null removes it, and variables not given are kept. Keys are environment variable names: letters, digits and _, not starting with a digit, at most 256 characters. A vault holds at most 32 entries (otherwise 409 VAULT_ENTRY_LIMIT_REACHED).

Response

Success

idstring uuid required
namestring required

1-128 letters, digits, _ or -, starting with a letter or digit. Unique within your team.

descriptionstring required
entriesobject required

Environment variable name to entry.

createdAtstring date-time required
updatedAtstring date-time required

Changes

  • 225d94fe61a0Revision changes
    • breaking

      removed from the / request property oneOf list

    • warning

      removed the request property

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

  • 6ca0b00ee564Revision changes
    • info

      endpoint added