ScanopyScanopy
Daemon API Keys

List daemon API keys

GET
/api/v1/daemon-api-keys

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Query Parameters

site_ids?array<>|

Filter by site ID. Repeat the parameter to pass several.

ids?array<>|

Filter by specific entity IDs (for selective loading)

unbound?|

true returns only keys no daemon is bound to, the ones managed from the API keys page; false only keys bound to a daemon. Omit for both.

is_enabled?array<boolean>|

Only enabled keys (true), disabled ones (false), or both (repeat it). Sent empty, matches none.

tag_ids?array<>|

Filter by tag IDs (returns keys that have ANY of the specified tags)

tag_sets?array<string>|

Tag sets the key must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

search?|

Free-text search. Case-insensitive substring match against the key's name.

group_by?|

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by?|

Secondary ordering field (sorting within groups or standalone sort).

group_by_tag_group?|

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_group?|

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

order_direction?|

Direction for order_by field (group_by always uses ASC).

limit?|

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offset?|

Number of results to skip. Default: 0.

Response Body

application/json

curl -X GET "https://example.com/api/v1/daemon-api-keys"
{
  "data": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "string",
      "last_used": "2019-08-24T14:15:22Z",
      "name": "string",
      "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
      "tags": [
        "a424dc99-d215-4281-ad2d-a3a9bc179925"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "daemon_id": "0f0cd6bf-ac90-457b-aa3f-6f24990d5ff6",
      "expires_at": "2019-08-24T14:15:22Z",
      "is_enabled": true
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.4"
  },
  "success": true,
  "error": "string"
}

Product names and logos are trademarks of their respective owners. See credits.