Harthelm Docs
REST APIAPI keys

The caller's API keys

Personal API keys, newest first. Secrets are never returned; a key is shown once, when it is created or regenerated. A key acts with all of its user's permissions.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/me/api-keys

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Query Parameters

limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of keys.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/me/api-keys'
{  "next_cursor": "string",  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "source": "console",      "prefix": "string",      "created_at": "2019-08-24T14:15:22Z",      "regenerated_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z"    }  ]}

Delete an API key

The key stops working at once, also on workspace hosts (the routers drop it with the next route delta).

Regenerate an API key

Replaces the key's secret: the old token is invalid at once, the new one is in `token` once. Id, name and expiry stay. Browser sessions only (403 with an API key).