リファレンスHTTP APIA P I keys

The caller's personal keys and the agent keys they manage

GET
/v1/api-keys

Owners and admins see every agent key; an agent's admin sees that agent's keys. Who sees which agent keys is read from the caller's role on every page, so a page read after a role change follows the new role. Newest created_at first, limit per page (default 50, at most 100). Pass next_cursor back as cursor for the next page; it is null on the last one. A cursor that does not decode to a position in that order answers 400; a cursor only positions the read, so one from another workspace shows nothing of it. Secrets are never returned.

Auth: cookie session only; no scope.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Query Parameters

cursor?string

The next_cursor of the page before; omit it for the first page.

Length1 <= length
limit?integer

How many items a page holds at most.

Range1 <= value <= 100
Default50

Response Body

Success

application/json
  1. response
items*array<>
next_cursor*|null
Example Request
curl -X GET 'https://example.com/v1/api-keys'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "personal",      "name": "string",      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",      "created_by_user": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "display_name": "string"      },      "scopes": [        "sessions:read"      ],      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "revoked_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}