Skip to main content
GET
/
api
/
v1
/
kms
List KMS instances
curl --request GET \
  --url https://cloud-api.phala.com/api/v1/kms
{
  "items": [
    {
      "id": "<string>",
      "url": "<string>",
      "version": "<string>",
      "slug": "<string>",
      "chain_id": 123,
      "kms_contract_address": "<string>",
      "gateway_app_id": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "pages": 123
}

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:20

Items per page (1-100)

Required range: 1 <= x <= 100
​
is_onchain
boolean | null

Filter: true=onchain only, false=offchain only, omit=all

Response

Successful Response

Paginated KMS list response.

​
items
KMSInfo · object[]
required
​
total
integer
required
​
page
integer
required
​
page_size
integer
required
​
pages
integer
required