Skip to content

API keys

Programmatic access (the R / Python SDK, pipelines) uses API keys. A key carries the role of whoever minted it — so a key created by a clinician can see PII, a key created by a bioinformatician cannot.

Create a key

  1. Go to API keys.
  2. Enter a name (e.g. laptop-sdk) and click Create key.
  3. Copy the key now — the full value is shown only once. Only a hash is stored.

Use it as a bearer token:

Authorization: Bearer mdms_xxxxxxxxxxxxxxxx

…or pass it to the SDK as api_key="mdms_...".

Manage keys

The keys table shows each key's name, prefix, role, and when it was last used. Revoke a key at any time — any SDK or pipeline still using it stops working immediately.

Note

Treat keys like passwords. If a key leaks, revoke it and mint a new one.