Skip to main content
GET
/
api
/
v1
/
kms
/
{kms_id}
Get KMS details
curl --request GET \
  --url https://cloud-api.phala.com/api/v1/kms/{kms_id}
{
  "id": "<string>",
  "url": "<string>",
  "version": "<string>",
  "slug": "<string>",
  "chain_id": 123,
  "kms_contract_address": "<string>",
  "gateway_app_id": "<string>"
}

Path Parameters

​
kms_id
string
required

KMS ID (hashed) or slug

Response

Successful Response

KMS instance information.

​
id
string<hashid>
required

Hashed KMS identifier (kms_xxxxx)

Pattern: ^kms_.+
Example:

"kms_0123abcd"

​
url
string
required

KMS endpoint URL

​
version
string
required

KMS software version

​
slug
string | null

Human-readable KMS name

​
chain_id
integer | null

Blockchain chain ID if onchain

​
kms_contract_address
string | null

Smart contract address if onchain

​
gateway_app_id
string | null

Gateway application ID