HYhyperbrowser

Create a vault

Changed on

Creates a vault: a set of environment variables that point at your secrets. Pass the vault by name as vault to POST /api/sandbox and POST /api/sandbox/{id}/processes, or as {"vault": name} in a browser session's credentials. A team can have at most 100 vaults. 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).

post/api/vaults

Request

Request body

namestring required

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

descriptionstring

Trimmed before it's stored.

entriesobject

Environment variable name to secret. 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).

Example request

{
  "entries": {
    "USERNAME": {
      "name": "github-username"
    },
    "PASSWORD": {
      "name": "github-password"
    }
  }
}

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

      added the new required request property //

    • breaking

      removed from the / request property oneOf list

    • breaking

      the / request property type changed from no type to object

    • 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

      added the new optional request property //

    • 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