List your keys

GET /keys
Bearer auth

Query parameters

  • cursor string

    A cursor returned from a previous call to /keys

Responses

  • 200

    Your keys

    Hide response attributes Show response attributes object
    • keys array[object] Required
      Hide keys attributes Show keys attributes
      • id string Required

        An identifier for a key

      • name string Required
      • scopes array[string] Required

        An authorization scope associated with a key. Any request that is signed by a JWT with this key will have access to the scopes associated with that key.

        Values are events.write, events.read, state.read, instances.read, instances.write, instances.admin, machines.read, machines.write, machines.admin, machine-versions.read, machine-versions.write, analytics.read, org.read, org.write, org.keys.write, org-members.write, logs.read, or tokens.admin.

      • createdAt string(date-time) Required
    • cursor string

      The cursor to use on the next call to retrieve the next page of keys. If no cursor is returned, there are no more pages to retrieve.
GET /keys 
curl \
 -X GET https://api.statebacked.dev/keys \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "keys": [
    {
      "id": "sbk_nXzdtCxESemgtxS5JX-LrA",
      "name": "string",
      "scopes": [
        "events.write"
      ],
      "createdAt": "2023-05-04T09:42:00+00:00"
    }
  ],
  "cursor": "string"
}
Response examples (200) 
{
  "keys": [
    {
      "id": "sbk_nXzdtCxESemgtxS5JX-LrA",
      "name": "string",
      "scopes": [
        "events.write"
      ],
      "createdAt": "2024-05-04T09:42:00+00:00"
    }
  ],
  "cursor": "string"
}