---
title: "KMS Config List"
method: GET
path: "/1/kms/configs"
tags: ["KMS Configuration"]
---

# KMS Config List

`GET /1/kms/configs`

## Request

- Base URL: `http://localhost:3000/api`
- URL: `http://localhost:3000/api/1/kms/configs`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/1/kms/configs/get.ts> (a function with typed inputs; its response is checked against the schema)

List the metadata of all KMS configurations owned by the calling vendor.  
This does not decrypt any of the sensitive KMS configuration data.

## Query parameters

- `sortColumn` 'assignments' | 'created' | 'updated'
- `kmsType` 'AWS' | 'GCP' | 'AZURE'
- `leasingEnabled` boolean
- `pageSize` integer
- `page` integer
- `sortDirection` 'asc' | 'desc'

## Headers

- `icl-requestor-id` string, required

## Response `200`

Result of listing the vendor's KMS configurations

- object
  - `result` BasicKmsConfig[], required: Vendor configs
    - `id` integer, required: KMS Config ID
    - `kmsType` 'AZURE' | 'AWS' | 'GCP', required: KMS type: AWS, Azure, or GCP
    - `version` integer, required: Config verssion
    - `createdBy` CreatedBy, required: Metadata about creating user/service
      - `id` string, required: Creator ID
      - `name` string, required: Creator name
      - `type` 'Tsp' | 'Admin' | 'Va', required: Creator type
    - `leasingAllowed` boolean, required: Is key leasing enabled?
    - `assignmentCount` integer, required: Number of consumers of the configuration.
    - `secretCount` integer, required: Number of active secrets associated with this configuration
    - `created` string, required: RFC3339 timestamp
    - `updated` string, required: RFC3339 timestamp
  - `page` integer, required: Current response page number
  - `totalPages` integer, required: Total number of response pages

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge.md) - [All operations](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/revisions/5c0e553ffa21?raw)