# Connect

## Domain Types

### Connect Bandwidth Mbps

- `ConnectBandwidthMbps = 50 or 200 or 500 or 2 more`

  Connect Connection speed in Mbps

  - `50`

  - `200`

  - `500`

  - `1000`

  - `2000`

### Connect Connection

- `ConnectConnection object { id, asn, aws, 13 more }`

  Connect Connection details.

  - `id: string`

    Unique identifier for the Connect Connection

  - `asn: number`

    ASN

  - `aws: ConnectConnectionAWSConfig`

    AWS provider configuration

    - `region: string`

      AWS region where the connection is established

  - `bandwidth_mbps: ConnectBandwidthMbps`

    Connect Connection speed in Mbps

    - `50`

    - `200`

    - `500`

    - `1000`

    - `2000`

  - `cidrs: array of string`

    CIDRs for the Connect Connection

  - `created_at: string`

    When the Connect Connection was created

  - `name: string`

    Name of the Connect Connection

  - `project_id: string`

    Project ID the Connect Connection belongs to

  - `provider_asn: number`

    Provider ASN

  - `provider_cidrs: array of string`

    Provider CIDRs for the Connect Connection

  - `provider_router_ip: string`

    Provider Router IP for the Connect Connection

  - `region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

  - `router_ip: string`

    Router IP

  - `status: ResourceStatus`

    Status of the resource.

    - `"pending"`

    - `"creating"`

    - `"updating"`

    - `"ready"`

    - `"deleting"`

    - `"deleted"`

    - `"error"`

  - `tags: array of string`

    Tags to attach to the Connect Connection

  - `updated_at: string`

    When the Connect Connection was updated

### Connect Connection AWS Config

- `ConnectConnectionAWSConfig object { region }`

  AWS provider configuration

  - `region: string`

    AWS region where the connection is established

### Connect Connection AWS Config Request

- `ConnectConnectionAWSConfigRequest object { account_id, region }`

  AWS provider configuration

  - `account_id: string`

    AWS account id

  - `region: string`

    AWS region where the connection will be established

### Connect Connection List

- `ConnectConnectionList object { items, pagination }`

  - `items: array of ConnectConnection`

    - `id: string`

      Unique identifier for the Connect Connection

    - `asn: number`

      ASN

    - `aws: ConnectConnectionAWSConfig`

      AWS provider configuration

      - `region: string`

        AWS region where the connection is established

    - `bandwidth_mbps: ConnectBandwidthMbps`

      Connect Connection speed in Mbps

      - `50`

      - `200`

      - `500`

      - `1000`

      - `2000`

    - `cidrs: array of string`

      CIDRs for the Connect Connection

    - `created_at: string`

      When the Connect Connection was created

    - `name: string`

      Name of the Connect Connection

    - `project_id: string`

      Project ID the Connect Connection belongs to

    - `provider_asn: number`

      Provider ASN

    - `provider_cidrs: array of string`

      Provider CIDRs for the Connect Connection

    - `provider_router_ip: string`

      Provider Router IP for the Connect Connection

    - `region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `router_ip: string`

      Router IP

    - `status: ResourceStatus`

      Status of the resource.

      - `"pending"`

      - `"creating"`

      - `"updating"`

      - `"ready"`

      - `"deleting"`

      - `"deleted"`

      - `"error"`

    - `tags: array of string`

      Tags to attach to the Connect Connection

    - `updated_at: string`

      When the Connect Connection was updated

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Connect Route

- `ConnectRoute object { nirvana_region, provider, provider_region }`

  Routes supported for Connect.

  - `nirvana_region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

  - `provider: string`

    Provider name.

  - `provider_region: string`

    Provider region name.

### Connect Route List

- `ConnectRouteList object { items, pagination }`

  - `items: array of ConnectRoute`

    - `nirvana_region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `provider: string`

      Provider name.

    - `provider_region: string`

      Provider region name.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

# Connections

## Create Connect Connection

**post** `/v1/networking/connect/connections`

Create a Connect Connection

### Body Parameters

- `bandwidth_mbps: ConnectBandwidthMbps`

  Connect Connection speed in Mbps

  - `50`

  - `200`

  - `500`

  - `1000`

  - `2000`

- `cidrs: array of string`

  CIDRs for the Connect Connection. Must be in network-aligned/canonical form.

- `name: string`

  Name of the Connect Connection

- `project_id: string`

  Project ID the Connect Connection belongs to

- `provider_cidrs: array of string`

  Provider CIDRs. Must be in network-aligned/canonical form.

- `region: RegionName`

  Region the resource is in.

  - `"us-sva-2"`

- `aws: optional ConnectConnectionAWSConfigRequest`

  AWS provider configuration

  - `account_id: string`

    AWS account id

  - `region: string`

    AWS region where the connection will be established

- `tags: optional array of string`

  Tags to attach to the Connect Connection

### Returns

- `Operation object { id, created_at, details, 6 more }`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    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: string or number or boolean or array of string`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of 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

```http
curl https://api.nirvanalabs.io/v1/networking/connect/connections \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "bandwidth_mbps": 50,
          "cidrs": [
            "10.0.0.0/16"
          ],
          "name": "my-connect-connection",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "provider_cidrs": [
            "172.16.0.0/16"
          ],
          "region": "us-sva-2",
          "tags": [
            "production",
            "ethereum"
          ]
        }'
```

#### 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"
}
```

## Get Connect Connection

**get** `/v1/networking/connect/connections/{connection_id}`

Get Connect Connection details

### Path Parameters

- `connection_id: string`

### Returns

- `ConnectConnection object { id, asn, aws, 13 more }`

  Connect Connection details.

  - `id: string`

    Unique identifier for the Connect Connection

  - `asn: number`

    ASN

  - `aws: ConnectConnectionAWSConfig`

    AWS provider configuration

    - `region: string`

      AWS region where the connection is established

  - `bandwidth_mbps: ConnectBandwidthMbps`

    Connect Connection speed in Mbps

    - `50`

    - `200`

    - `500`

    - `1000`

    - `2000`

  - `cidrs: array of string`

    CIDRs for the Connect Connection

  - `created_at: string`

    When the Connect Connection was created

  - `name: string`

    Name of the Connect Connection

  - `project_id: string`

    Project ID the Connect Connection belongs to

  - `provider_asn: number`

    Provider ASN

  - `provider_cidrs: array of string`

    Provider CIDRs for the Connect Connection

  - `provider_router_ip: string`

    Provider Router IP for the Connect Connection

  - `region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

  - `router_ip: string`

    Router IP

  - `status: ResourceStatus`

    Status of the resource.

    - `"pending"`

    - `"creating"`

    - `"updating"`

    - `"ready"`

    - `"deleting"`

    - `"deleted"`

    - `"error"`

  - `tags: array of string`

    Tags to attach to the Connect Connection

  - `updated_at: string`

    When the Connect Connection was updated

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/connect/connections/$CONNECTION_ID \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "asn": 64512,
  "aws": {
    "region": "us-east-1"
  },
  "bandwidth_mbps": 50,
  "cidrs": [
    "10.0.0.0/16"
  ],
  "created_at": "2025-01-01T00:00:00Z",
  "name": "my-connect-connection",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_asn": 64513,
  "provider_cidrs": [
    "172.16.0.0/16"
  ],
  "provider_router_ip": "169.254.1.43",
  "region": "us-sva-2",
  "router_ip": "169.254.1.42",
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z"
}
```

## Update Connect Connection

**patch** `/v1/networking/connect/connections/{connection_id}`

Update Connect Connection details

### Path Parameters

- `connection_id: string`

### Body Parameters

- `name: optional string`

  Name of the Connect Connection.

- `tags: optional array of string`

  Tags to attach to the Connect Connection

### Returns

- `Operation object { id, created_at, details, 6 more }`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    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: string or number or boolean or array of string`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of 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

```http
curl https://api.nirvanalabs.io/v1/networking/connect/connections/$CONNECTION_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-connect-connection",
          "tags": [
            "production",
            "ethereum"
          ]
        }'
```

#### 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"
}
```

## Delete Connect Connection

**delete** `/v1/networking/connect/connections/{connection_id}`

Delete Connect Connection

### Path Parameters

- `connection_id: string`

### Returns

- `Operation object { id, created_at, details, 6 more }`

  Operation details.

  - `id: string`

    Unique identifier for the Operation.

  - `created_at: string`

    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: string or number or boolean or array of string`

        Previous value.

        - `string`

        - `number`

        - `boolean`

        - `array of string`

      - `to: string or number or boolean or array of string`

        New value.

        - `string`

        - `number`

        - `boolean`

        - `array of 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

```http
curl https://api.nirvanalabs.io/v1/networking/connect/connections/$CONNECTION_ID \
    -X DELETE \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

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

**get** `/v1/networking/connect/connections`

List all Connect Connections

### Query Parameters

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

### Returns

- `ConnectConnectionList object { items, pagination }`

  - `items: array of ConnectConnection`

    - `id: string`

      Unique identifier for the Connect Connection

    - `asn: number`

      ASN

    - `aws: ConnectConnectionAWSConfig`

      AWS provider configuration

      - `region: string`

        AWS region where the connection is established

    - `bandwidth_mbps: ConnectBandwidthMbps`

      Connect Connection speed in Mbps

      - `50`

      - `200`

      - `500`

      - `1000`

      - `2000`

    - `cidrs: array of string`

      CIDRs for the Connect Connection

    - `created_at: string`

      When the Connect Connection was created

    - `name: string`

      Name of the Connect Connection

    - `project_id: string`

      Project ID the Connect Connection belongs to

    - `provider_asn: number`

      Provider ASN

    - `provider_cidrs: array of string`

      Provider CIDRs for the Connect Connection

    - `provider_router_ip: string`

      Provider Router IP for the Connect Connection

    - `region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `router_ip: string`

      Router IP

    - `status: ResourceStatus`

      Status of the resource.

      - `"pending"`

      - `"creating"`

      - `"updating"`

      - `"ready"`

      - `"deleting"`

      - `"deleted"`

      - `"error"`

    - `tags: array of string`

      Tags to attach to the Connect Connection

    - `updated_at: string`

      When the Connect Connection was updated

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/connect/connections \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

```json
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "asn": 64512,
      "aws": {
        "region": "us-east-1"
      },
      "bandwidth_mbps": 50,
      "cidrs": [
        "10.0.0.0/16"
      ],
      "created_at": "2025-01-01T00:00:00Z",
      "name": "my-connect-connection",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "provider_asn": 64513,
      "provider_cidrs": [
        "172.16.0.0/16"
      ],
      "provider_router_ip": "169.254.1.43",
      "region": "us-sva-2",
      "router_ip": "169.254.1.42",
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
```

# Routes

## List Connect Supported Routes

**get** `/v1/networking/connect/routes`

List all supported routes with regions for Connect.

### Query Parameters

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `ConnectRouteList object { items, pagination }`

  - `items: array of ConnectRoute`

    - `nirvana_region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `provider: string`

      Provider name.

    - `provider_region: string`

      Provider region name.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

```http
curl https://api.nirvanalabs.io/v1/networking/connect/routes \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

```json
{
  "items": [
    {
      "nirvana_region": "us-sva-2",
      "provider": "aws",
      "provider_region": "us-east-1"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
```