List API keys (admin)

GET

/api/keys

curl --request GET \
  --url https://example.com/api/keys \
  --header 'Remote-User: <Remote-User>'

• Your gotifacts apex (canonical base domain), fronted by your reverse proxy. Any configured alias domains serve the same API and sites, but responses (e.g. base_domain) always report the canonical domain.

Plaintext tokens are never returned.

Authorizations

• forwardAuth

Responses

200

The API keys.

Media typeapplication/json

object

keys

Array<object>

An API key as returned by listing (never includes the plaintext token).

object

id

required

integer format: int64

name

required

string

admin

required

boolean

grants

required

Array<object>

object

kind

required

string

Allowed values: group site

target

required

A group path (e.g. docs, empty = all sites) or a group/slug for a single site.

string

permissions

required

Array<string>

Allowed values: publish unpublish rollback patch purge read

created_at

required

string format: date-time

last_used_at

string format: date-time

expires_at

string format: date-time

Example

{
  "keys": [
    {
      "grants": [
        {
          "kind": "group",
          "permissions": [
            "publish"
          ]
        }
      ]
    }
  ]
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

403

Authenticated, but not permitted for this target/capability.

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}