API keys

List API keys

Returns key metadata without plaintext. keys.manage and local authority list all keys; keys.mint lists keys within the caller's current reach. Requires keys.mint, keys.manage, or local authority.

GET
/keys

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Response body

About errors

Returns the keys, in one page. A revoked key, or one past its expires_at, isn't listed.

application/json
  1. response

A page holding every key you can reach.

data*array<>

Every key you can reach.

next_cursor*|

Always null: Marfa returns every key you can reach in one page.

  • validation_error: the query has a parameter this endpoint doesn't take.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • forbidden: this operation requires its explicit permission or local authority. details.required_scope names it.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/keys'
About errors
{  "data": [    {      "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",      "label": "CRM sync",      "source": "crm",      "sources": [],      "permissions": [        "schema.write",        "keys.mint",        "items.purge",        "webhooks.manage",        "config.manage",        "audit.read",        "grants.manage",        "instance.read",        "instance.maintain",        "connectors.manage",        "blobs.manage",        "keys.manage"      ],      "default_tier": "library",      "type_permissions": {        "*": "write"      },      "extension_permissions": {        "*": "write"      },      "edge_permissions": {        "*": "write"      },      "metadata_permissions": {        "*": "write"      },      "profile_permissions": {        "*": "read"      },      "created_at": "2026-10-03T09:35:25.394Z",      "expires_at": null,      "last_used_at": "2026-10-03T09:36:25.084Z"    },    {      "id": "01a10126-1e03-79a5-ba6f-f711fc6f0e95",      "label": "reporting",      "source": "reporting",      "sources": [],      "permissions": [        "instance.read"      ],      "default_tier": "library",      "type_permissions": {        "acme.deal": "read"      },      "extension_permissions": {},      "edge_permissions": {},      "metadata_permissions": {},      "profile_permissions": {},      "created_at": "2026-10-03T10:08:20.575Z",      "expires_at": null,      "last_used_at": null    }  ],  "next_cursor": null}