Skip to content
Docs

Create Connect Connection

$ nirvana networking:connect:connections create
POST/v1/networking/connect/connections

Create a Connect Connection

ParametersExpand Collapse
--bandwidth-mbps: 50 or 200 or 500 or 2 more

Connect Connection speed in Mbps

--cidr: 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-cidr: array of string

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

--region: "us-sva-2"

Region the resource is in.

--aws: optional object { account_id, region }

AWS provider configuration

--tag: optional array of string

Tags to attach to the Connect Connection

ReturnsExpand Collapse
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: 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.

Create Connect Connection

nirvana networking:connect:connections create \
  --api-key 'My API Key' \
  --bandwidth-mbps 50 \
  --cidr 10.0.0.0/16 \
  --name my-connect-connection \
  --project-id 123e4567-e89b-12d3-a456-426614174000 \
  --provider-cidr 172.16.0.0/16 \
  --region us-sva-2
{
  "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"
}
Returns Examples
{
  "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"
}