Harthelm Docs

List the keys of a vault

Keys and their current revision; values are never returned. A workspace's vault id is `Workspace.vault_id`. Needs `workspace.view` on the workspace that uses the vault.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/vaults/{vault}/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.

Path Parameters

vault*integer

A vault id, e.g. Workspace.vault_id.

Formatint64
Range1 <= value

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, sorted by key.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/vaults/1/keys'
{  "next_cursor": "string",  "items": [    {      "key": "string",      "revision": 1,      "generated": true,      "created_at": "2019-08-24T14:15:22Z",      "created_by": 1    }  ]}