PHphala
CVMs

List CVM operations

Changed on

Returns operation records grouped by correlation_id. Only includes events with correlation_id (new format since 2024-01). Error messages are sanitized for non-admin users.

get/api/v1/cvms/{cvm_id}/operations

Request

Path parameters

cvm_idstring required

Query parameters

cursorstring nullable

Opaque cursor from previous response

limitinteger

Page size

start_timestring date-time nullable

Include operations started after this UTC time

end_timestring date-time nullable

Include operations started before this UTC time

operation_typesstring[] nullable

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

correlation_idstring nullable

Return the operation with this correlation ID

Response

Paginated operation records

next_cursorstring nullable

Opaque cursor for next page, null if last page

totalinteger required

Approximate total count (not exact for performance)

Example response

{
  "items": [
    {
      "triggered_by": "usr_0123abcd"
    }
  ]
}

Changes

  • c71a8dc90391Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      response property items/items/triggered_by list-of-types was widened by adding types null and string to media type application/json of response 200

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter correlation_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status