Type at least two letters.

    ↑ ↓ to moveEnter to open

    Keys API

    List, create and revoke API keys.

    Updated

    3 live operations. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.

    To try these with your own account, sign in and open Automation → Try the API in the app.

    List your keys (never the secret). Human session only

    GET/api/v1/api-keys
    App session onlyoperationId: listApiKeys

    Responses

    200object

    Keys (never the secret)

    1 field
    dataarray of ApiKey
    7 fields of data
    idstring
    namestring
    prefixstring
    scopesarray of string
    expiresAtstring or null (date-time)
    lastUsedAtstring or null (date-time)
    createdAtstring (date-time)

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Create a key; it is shown once. Human session only

    POST/api/v1/api-keys
    App session onlyoperationId: createApiKey

    Request body

    namestringrequired

    At most 80 characters

    scopesarray of stringrequired
    expiresAtstring (date-time)
    {
      "name": "CI pipeline",
      "scopes": [
        "audits:read",
        "audits:write"
      ]
    }

    Responses

    201object

    Created. The key is shown once; only its hash is stored.

    8 fields
    idstring
    namestring
    prefixstring
    scopesarray of string
    expiresAtstring or null (date-time)
    lastUsedAtstring or null (date-time)
    createdAtstring (date-time)
    keystring

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.

    Revoke a key. Human session only

    DELETE/api/v1/api-keys/{keyId}
    App session onlyoperationId: revokeApiKey

    Parameters

    keyIdstring · pathrequired

    Responses

    204

    Revoked

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.