List Operations

$ nirvana operations list

GET/v1/operations

List all operations

ParametersExpand Collapse

--project-id: string

Project ID of resources to request

--cursor: optional string

Pagination cursor returned by a previous request

--limit: optional number

Maximum number of items to return

ReturnsExpand Collapse

operation_list: object { items, pagination }

items: array of Operation { id, created_at, details, 6 more }

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

details: object { changes }

Structured details about what an operation is changing.

changes: map[OperationFieldDiff { from, to } ]

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

to: string or number or boolean or array of string

New value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

kind: "vm" or "volume" or "vpc" or 3 more

Kind of Operation.

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: "pending" or "running" or "done" or 2 more

Status of the Operation.

"pending"

"running"

"done"

"failed"

"unknown"

type: "create" or "update" or "delete" or "restart"

Type of Operation.

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

List Operations

nirvana operations list \
  --api-key 'My API Key' \
  --project-id project_id

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "details": {
        "changes": {
          "foo": {
            "from": "string",
            "to": "string"
          }
        }
      },
      "kind": "vm",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "resource_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "type": "create",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "details": {
        "changes": {
          "foo": {
            "from": "string",
            "to": "string"
          }
        }
      },
      "kind": "vm",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "resource_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "type": "create",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}