# Operations

## Get Operation Details

`client.operations.get(stringoperationID, RequestOptionsoptions?): Operation`

**get** `/v1/operations/{operation_id}`

Get details about a specific operation

### Parameters

- `operationID: string`

### Returns

- `Operation`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    When the Operation was created.

  - `details: OperationDetails | null`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

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

      - `from: string | number | boolean | Array<string>`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

      - `to: string | number | boolean | Array<string>`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

  - `kind: OperationKind`

    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: OperationStatus`

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Example

```typescript
import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const operation = await client.operations.get('operation_id');

console.log(operation.id);
```

#### Response

```json
{
  "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"
}
```

## List Operations

`client.operations.list(OperationListParamsquery, RequestOptionsoptions?): Cursor<Operation>`

**get** `/v1/operations`

List all operations

### Parameters

- `query: OperationListParams`

  - `project_id: string`

    Project ID of resources to request

  - `cursor?: string`

    Pagination cursor returned by a previous request

  - `limit?: number`

    Maximum number of items to return

### Returns

- `Operation`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    When the Operation was created.

  - `details: OperationDetails | null`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

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

      - `from: string | number | boolean | Array<string>`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

      - `to: string | number | boolean | Array<string>`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

  - `kind: OperationKind`

    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: OperationStatus`

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Example

```typescript
import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const operation of client.operations.list({ project_id: 'project_id' })) {
  console.log(operation.id);
}
```

#### Response

```json
{
  "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
  }
}
```

## Domain Types

### Operation

- `Operation`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    When the Operation was created.

  - `details: OperationDetails | null`

    Structured details about what an operation is changing.

    - `changes: OperationChanges`

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

      - `from: string | number | boolean | Array<string>`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

      - `to: string | number | boolean | Array<string>`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `Array<string>`

  - `kind: OperationKind`

    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: OperationStatus`

    Status of the Operation.

    - `"pending"`

    - `"running"`

    - `"done"`

    - `"failed"`

    - `"unknown"`

  - `type: OperationType`

    Type of Operation.

    - `"create"`

    - `"update"`

    - `"delete"`

    - `"restart"`

  - `updated_at: string`

    When the Operation was updated.

### Operation Changes

- `OperationChanges = Record<string, OperationFieldDiff>`

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

  - `from: string | number | boolean | Array<string>`

    Previous value.

    - `string`

    - `number`

    - `boolean`

    - `Array<string>`

  - `to: string | number | boolean | Array<string>`

    New value.

    - `string`

    - `number`

    - `boolean`

    - `Array<string>`

### Operation Details

- `OperationDetails`

  Structured details about what an operation is changing.

  - `changes: OperationChanges`

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

    - `from: string | number | boolean | Array<string>`

      Previous value.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

    - `to: string | number | boolean | Array<string>`

      New value.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

### Operation Field Diff

- `OperationFieldDiff`

  A single field's before/after pair on an operation. Values are scalars (string, number, boolean) or string arrays.

  - `from: string | number | boolean | Array<string>`

    Previous value.

    - `string`

    - `number`

    - `boolean`

    - `Array<string>`

  - `to: string | number | boolean | Array<string>`

    New value.

    - `string`

    - `number`

    - `boolean`

    - `Array<string>`

### Operation Kind

- `OperationKind = "vm" | "volume" | "vpc" | 3 more`

  Kind of Operation.

  - `"vm"`

  - `"volume"`

  - `"vpc"`

  - `"firewall_rule"`

  - `"nks_cluster"`

  - `"nks_node_pool"`

### Operation List

- `OperationList`

  - `items: Array<Operation>`

    - `id: string`

      Unique identifier for the Operation.

    - `created_at: string`

      When the Operation was created.

    - `details: OperationDetails | null`

      Structured details about what an operation is changing.

      - `changes: OperationChanges`

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

        - `from: string | number | boolean | Array<string>`

          Previous value.

          - `string`

          - `number`

          - `boolean`

          - `Array<string>`

        - `to: string | number | boolean | Array<string>`

          New value.

          - `string`

          - `number`

          - `boolean`

          - `Array<string>`

    - `kind: OperationKind`

      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: OperationStatus`

      Status of the Operation.

      - `"pending"`

      - `"running"`

      - `"done"`

      - `"failed"`

      - `"unknown"`

    - `type: OperationType`

      Type of Operation.

      - `"create"`

      - `"update"`

      - `"delete"`

      - `"restart"`

    - `updated_at: string`

      When the Operation was updated.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string | null`

    - `previous_cursor: string | null`

    - `total_count: number`

### Operation Status

- `OperationStatus = "pending" | "running" | "done" | 2 more`

  Status of the Operation.

  - `"pending"`

  - `"running"`

  - `"done"`

  - `"failed"`

  - `"unknown"`

### Operation Type

- `OperationType = "create" | "update" | "delete" | "restart"`

  Type of Operation.

  - `"create"`

  - `"update"`

  - `"delete"`

  - `"restart"`