Type at least two letters.

    ↑ ↓ to moveEnter to open

    Create and manage API keys

    Create a key for a script, a CI job, Postman or an AI assistant, limit what it can do, and revoke it.

    Updated

    An API key lets a program act as your account. Everything you can do with sites and audits in the app, a key can do over the API, limited to the scopes you choose. Keys are managed in the app under API keys, and only there.

    Keys are a developer tool. Turn on developer tools once in the app under Settings → Developer tools first; until then API keys is not in the menu and keys do not work. See Developer tools: who they are for.

    Create a key

    1. Open API keys in the app.
    2. Under Create a key, give it a Name that says where it will be used, for example CI pipeline or Postman.
    3. Tick the Scopes it needs. Read scopes are ticked by default.
    4. Press Create key.
    5. Copy the key from Your new key right away. It is shown once. Metricevo stores only a fingerprint (a SHA-256 hash) of it and cannot show it again.

    A key looks like mev_live_ followed by random characters. Keep it like a password: in a secret store or an environment variable, never in source code, a ticket or a chat.

    Choose scopes

    Give a key only what its job needs.

    Scope Allows Typical use
    sites:read List and read sites. Dashboards, reports
    sites:write Add, rename, schedule and remove sites. Onboarding scripts
    audits:read Check addresses, list runs, read results. Reports, CI result checks
    audits:write Start audits. CI after a deploy

    A CI job that starts an audit and reads its result needs audits:read and audits:write. An AI assistant that only answers questions about results needs the two read scopes.

    A request outside the key’s scopes gets 403 with code: insufficient_scope, and detail names the missing scope.

    What a key can never do

    • Create, list or revoke keys. Only you, signed in, can.
    • Change the account: name, email, password, two-step sign-in.
    • See another account’s data. Every request is bound to your account; another account’s id answers 404.

    Your keys

    Your keys lists every key with its name, its prefix (the first characters, enough to recognise it), its scopes and when it was last used. The secret part is never shown.

    Revoke a key

    Press Revoke on the key, then Revoke for good? to confirm. The key stops working at once; requests with it get 401 with code: invalid_api_key. Revoking cannot be undone: create a new key instead.

    Rotate a key

    To replace a key without downtime:

    1. Create a new key with the same scopes.
    2. Put the new key where the old one is used.
    3. Check Last used on the old key: when it no longer moves, revoke it.

    Limits

    You can keep 10 keys. Revoke one to create another. Over the API, a key can also be created with an expiry time (expiresAt); see API keys.