Vaults

In Cerby, vaults are secure spaces for storing and managing your account data and sensitive information, such as secrets. They provide an additional layer of protection by implementing encryption and access controls to ensure that only authorized users can access the stored data.

A vault object is created in Cerby when you perform the following actions:

• Create and configure a Cerby workspace. This action creates a default cloud vault for the workspace.

• Create additional local vaults in your Cerby workspace.

With the Cerby API, you can list all the vaults in your workspace. To learn more about vaults, refer to the Managing your vaults article collection on the Cerby Help Center.

Important:

• You can only retrieve vaults if you have the workspace Admin, Super Admin, or Owner role. Your permissions are determined by your API key based on Cerby’s RBAC system.

• You can retrieve cloud vaults using the Cerby API, but not local vaults.

Retrieve the list of all vaults

get

With a GET request to the /vaults endpoint, you can retrieve the list of all the vaults in your workspace.

Important: The API scope required to use this endpoint is Read vaults.

Query parameters

page[number]integer · min: 1Optional

The page number to retrieve in a paginated list.

Default: 1

page[size]integer · min: 1 · max: 100Optional

The number of items to display per page.

Default: 25

Responses

200

OK — The paginated list of vaults.

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/vaults

HTTPcURLJavaScriptPython

GET /api/v1/vaults HTTP/1.1
Host: my-workspace.cerby.com
Accept: */*

{
  "data": [
    {
      "id": "07eb52b2-8c4d-4752-8a4f-2776411c95a0",
      "type": "vault",
      "attributes": {
        "createdAt": "2023-05-19T12:59:50.202000+00:00",
        "createdBy": "03c3648f-1234-4134-8d3f-f9f052c1ccf5",
        "createdByType": "user",
        "name": "lek_vault",
        "scheme": "local_encryption_key",
        "state": "disabled",
        "updatedAt": "2024-03-25T15:17:55.093000+00:00",
        "workspaceId": "5aab889c-db7d-4164-87b0-e07e57c36007"
      }
    },
    {
      "id": "1828a35a-4ad1-422e-943c-7fb318d16d8a",
      "type": "vault",
      "attributes": {
        "createdAt": "2024-11-04T23:03:31.838000+00:00",
        "createdBy": "aa919a58-1234-4233-b3d1-a0ef0ba4ee69",
        "createdByType": "user",
        "name": "TEST KMS BYO",
        "scheme": "kms_byo",
        "state": "enabled",
        "updatedAt": "2024-11-04T23:03:31.838000+00:00",
        "workspaceId": "5aab889c-db7d-4164-87b0-e07e57c36007"
      }
    },
    {
      "id": "6dfb5e8e-f9a1-46b1-aba1-f21402b98291",
      "type": "vault",
      "attributes": {
        "createdAt": "2024-04-10T22:46:09.919000+00:00",
        "createdBy": "62517be2-1234-41df-b2f0-2e84b6709f89",
        "createdByType": "user",
        "name": "Test",
        "scheme": "akv",
        "state": "disabled",
        "updatedAt": "2024-04-10T22:46:50.425000+00:00",
        "workspaceId": "5aab889c-db7d-4164-87b0-e07e57c36007"
      }
    }
  ],
  "links": {
    "next": null,
    "previous": null,
    "self": "/api/v1/vaults?page%5Bnumber%5D=1&page%5Bsize%5D=100"
  },
  "meta": {
    "page": {
      "maxSize": 100,
      "total": 51
    }
  }
}