# Operations

## Get Operation Details

`client.Operations.Get(ctx, operationID) (*Operation, error)`

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

Get details about a specific operation

### Parameters

- `operationID string`

### Returns

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

    When the Operation was created.

  - `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 OperationFieldDiffFromUnion`

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  operation, err := client.Operations.Get(context.TODO(), "operation_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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(ctx, query) (*Cursor[Operation], error)`

**get** `/v1/operations`

List all operations

### Parameters

- `query OperationListParams`

  - `ProjectID param.Field[string]`

    Project ID of resources to request

  - `Cursor param.Field[string]`

    Pagination cursor returned by a previous request

  - `Limit param.Field[int64]`

    Maximum number of items to return

### Returns

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

    When the Operation was created.

  - `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 OperationFieldDiffFromUnion`

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/operations"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Operations.List(context.TODO(), operations.OperationListParams{
    ProjectID: "project_id",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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

- `type Operation struct{…}`

  Operation details.

  - `ID string`

    Unique identifier for the Operation.

  - `CreatedAt Time`

    When the Operation was created.

  - `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 OperationFieldDiffFromUnion`

        Previous value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffFromArray []string`

      - `To OperationFieldDiffToUnion`

        New value.

        - `string`

        - `float64`

        - `bool`

        - `type OperationFieldDiffToArray []string`

  - `Kind OperationKind`

    Kind of Operation.

    - `const OperationKindVM OperationKind = "vm"`

    - `const OperationKindVolume OperationKind = "volume"`

    - `const OperationKindVPC OperationKind = "vpc"`

    - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

    - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

    - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

  - `ProjectID string`

    Project ID the Operation belongs to.

  - `ResourceID string`

    ID of the resource that the Operation is acting on.

  - `Status OperationStatus`

    Status of the Operation.

    - `const OperationStatusPending OperationStatus = "pending"`

    - `const OperationStatusRunning OperationStatus = "running"`

    - `const OperationStatusDone OperationStatus = "done"`

    - `const OperationStatusFailed OperationStatus = "failed"`

    - `const OperationStatusUnknown OperationStatus = "unknown"`

  - `Type OperationType`

    Type of Operation.

    - `const OperationTypeCreate OperationType = "create"`

    - `const OperationTypeUpdate OperationType = "update"`

    - `const OperationTypeDelete OperationType = "delete"`

    - `const OperationTypeRestart OperationType = "restart"`

  - `UpdatedAt Time`

    When the Operation was updated.

### Operation Changes

- `type OperationChanges map[string, OperationFieldDiff]`

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

  - `From OperationFieldDiffFromUnion`

    Previous value.

    - `string`

    - `float64`

    - `bool`

    - `type OperationFieldDiffFromArray []string`

  - `To OperationFieldDiffToUnion`

    New value.

    - `string`

    - `float64`

    - `bool`

    - `type OperationFieldDiffToArray []string`

### Operation Details

- `type OperationDetails struct{…}`

  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 OperationFieldDiffFromUnion`

      Previous value.

      - `string`

      - `float64`

      - `bool`

      - `type OperationFieldDiffFromArray []string`

    - `To OperationFieldDiffToUnion`

      New value.

      - `string`

      - `float64`

      - `bool`

      - `type OperationFieldDiffToArray []string`

### Operation Field Diff

- `type OperationFieldDiff struct{…}`

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

  - `From OperationFieldDiffFromUnion`

    Previous value.

    - `string`

    - `float64`

    - `bool`

    - `type OperationFieldDiffFromArray []string`

  - `To OperationFieldDiffToUnion`

    New value.

    - `string`

    - `float64`

    - `bool`

    - `type OperationFieldDiffToArray []string`

### Operation Kind

- `type OperationKind string`

  Kind of Operation.

  - `const OperationKindVM OperationKind = "vm"`

  - `const OperationKindVolume OperationKind = "volume"`

  - `const OperationKindVPC OperationKind = "vpc"`

  - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

  - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

  - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

### Operation List

- `type OperationList struct{…}`

  - `Items []Operation`

    - `ID string`

      Unique identifier for the Operation.

    - `CreatedAt Time`

      When the Operation was created.

    - `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 OperationFieldDiffFromUnion`

          Previous value.

          - `string`

          - `float64`

          - `bool`

          - `type OperationFieldDiffFromArray []string`

        - `To OperationFieldDiffToUnion`

          New value.

          - `string`

          - `float64`

          - `bool`

          - `type OperationFieldDiffToArray []string`

    - `Kind OperationKind`

      Kind of Operation.

      - `const OperationKindVM OperationKind = "vm"`

      - `const OperationKindVolume OperationKind = "volume"`

      - `const OperationKindVPC OperationKind = "vpc"`

      - `const OperationKindFirewallRule OperationKind = "firewall_rule"`

      - `const OperationKindNKSCluster OperationKind = "nks_cluster"`

      - `const OperationKindNKSNodePool OperationKind = "nks_node_pool"`

    - `ProjectID string`

      Project ID the Operation belongs to.

    - `ResourceID string`

      ID of the resource that the Operation is acting on.

    - `Status OperationStatus`

      Status of the Operation.

      - `const OperationStatusPending OperationStatus = "pending"`

      - `const OperationStatusRunning OperationStatus = "running"`

      - `const OperationStatusDone OperationStatus = "done"`

      - `const OperationStatusFailed OperationStatus = "failed"`

      - `const OperationStatusUnknown OperationStatus = "unknown"`

    - `Type OperationType`

      Type of Operation.

      - `const OperationTypeCreate OperationType = "create"`

      - `const OperationTypeUpdate OperationType = "update"`

      - `const OperationTypeDelete OperationType = "delete"`

      - `const OperationTypeRestart OperationType = "restart"`

    - `UpdatedAt Time`

      When the Operation was updated.

  - `Pagination Pagination`

    Pagination response details.

    - `NextCursor string`

    - `PreviousCursor string`

    - `TotalCount int64`

### Operation Status

- `type OperationStatus string`

  Status of the Operation.

  - `const OperationStatusPending OperationStatus = "pending"`

  - `const OperationStatusRunning OperationStatus = "running"`

  - `const OperationStatusDone OperationStatus = "done"`

  - `const OperationStatusFailed OperationStatus = "failed"`

  - `const OperationStatusUnknown OperationStatus = "unknown"`

### Operation Type

- `type OperationType string`

  Type of Operation.

  - `const OperationTypeCreate OperationType = "create"`

  - `const OperationTypeUpdate OperationType = "update"`

  - `const OperationTypeDelete OperationType = "delete"`

  - `const OperationTypeRestart OperationType = "restart"`