API Keys

Create an API key

The raw key is returned once in this response and never again.

post/api/api-keys

Request

  • Base URL: https://api.engram.page
  • URL: https://api.engram.page/api/api-keys
  • Auth: HTTP bearer

Request body

default_access'none' | 'read' | 'write'

Level for every vault not listed in vault_access, including vaults you create later. Defaults to none when vault_access is given. write also lets the key create vaults. The key must reach at least one vault now or later.

namestring required
vault_accessobject

Level per vault id: none, read (search and read) or write (also create, edit, rename and delete notes, and rename or delete the vault). Every id must be one of your vaults. Omit both this and default_access for a key on every vault with full write access.

Example request

{
  "default_access": "none",
  "name": "CI pipeline",
  "vault_access": {
    "0b7c6a4e-3f1d-4c8e-9a2b-5d6e7f809a1b": "read"
  }
}

Response

Created (raw key)

default_access'none' | 'read' | 'write' required

The granted level for every vault not in vault_access, including later ones.

idstring uuid required
keystring required

Raw secret — store it now; never shown again.

namestring required
vault_accessobject required

What the key was granted, read back from storage: a level per listed vault id. Compare it with what you asked for; revoke the key if it is wider.

Changes

No recorded changes to this operation across all 1 revision of this API.