---
title: "List KMS instances"
method: GET
path: "/api/v1/kms"
tags: ["KMS"]
---

# List KMS instances

`GET /api/v1/kms`

Query available KMS instances with pagination. Filter by onchain status to find instances with blockchain integration.

## Query parameters

- `page` integer — Page number (1-indexed)
- `page_size` integer — Items per page (1-100)
- `is_onchain` boolean, nullable — Filter: true=onchain only, false=offchain only, omit=all

## Response `200`

Successful Response

- KmsListResponse — Paginated KMS list response.
  - `items` KMSInfo[], required
    - `id` string, hashid, required — Hashed KMS identifier (kms_xxxxx)
    - `slug` string, nullable — Human-readable KMS name
    - `url` string, required — KMS endpoint URL
    - `version` string, required — KMS software version
    - `chain_id` integer, nullable — Blockchain chain ID if onchain
    - `kms_contract_address` string, nullable — Smart contract address if onchain
    - `gateway_app_id` string, nullable — Gateway application ID
  - `total` integer, required
  - `page` integer, required
  - `page_size` integer, required
  - `pages` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/phala/apis/phala-cloud-api.md) · [All operations](https://skmtc.net/phala/apis/phala-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phala/phala-cloud-api/revisions/83c6ae62e860/schema)