Skip to main content
GET
/
api
/
v1
/
cvms
/
{cvm_id}
/
operations
List CVM operations
curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/operations
{
  "items": [
    {
      "correlation_id": "<string>",
      "operation_type": "<string>",
      "target_state": "<string>",
      "triggered_by": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "sub_operations": [
        "<string>"
      ],
      "events": [
        {
          "event_type": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "state": "<string>"
        }
      ],
      "instance_name": "<string>",
      "triggered_by_username": "<string>",
      "triggered_by_email": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "error_message": "<string>",
      "compose_hash": "<string>"
    }
  ],
  "total": 123,
  "next_cursor": "<string>"
}

Path Parameters

​
cvm_id
string
required

Query Parameters

​
cursor
string | null

Opaque cursor from previous response

​
limit
integer
default:50

Page size

Required range: 1 <= x <= 500
​
start_time
string<date-time> | null

Include operations started after this UTC time

​
end_time
string<date-time> | null

Include operations started before this UTC time

​
operation_types
string[] | null

Filter by operation types (e.g. compose_update, power_on)

Response

Paginated operation records

Cursor-paginated list of CVM operations.

​
items
CvmOperationResponse · object[]
required

Operations ordered by started_at DESC

​
total
integer
required

Approximate total count (not exact for performance)

​
next_cursor
string | null

Opaque cursor for next page, null if last page