Skip to main content
GET
/
api
/
v1
/
cvms
/
{cvm_id}
/
state
Handle Get Cvm State
curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/state
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

cvm_id
string
required

Query Parameters

target
string | null

Target status to wait for. If specified, returns SSE stream.

interval
integer
default:5

Polling interval in seconds (5-30)

Required range: 5 <= x <= 30
timeout
integer
default:300

Maximum wait time in seconds (10-600)

Required range: 10 <= x <= 600

Response

Successful Response