Skip to content
Docs

    Get VPC Details

    $ nirvana networking:vpcs get
    GET/v1/networking/vpcs/{vpc_id}

    Get details about a VPC

    ParametersExpand Collapse
    --vpc-id: string

    VPC ID

    ReturnsExpand Collapse
    vpc: object { id, created_at, firewall_rule_ids, 7 more }

    VPC details.

    id: string

    Unique identifier for the VPC.

    created_at: string

    When the VPC was created.

    firewall_rule_ids: array of string

    IDs of the Firewall Rules associated with the VPC.

    name: string

    Name of the VPC.

    project_id: string

    Project ID the VPC belongs to.

    region: "us-sva-2"

    Region the resource is in.

    "us-sva-2"
    status: "pending" or "creating" or "updating" or 4 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    subnet: object { id, cidr, created_at, 2 more }

    Subnet of the VPC.

    id: string

    Unique identifier for the Subnet.

    cidr: string

    CIDR block for the Subnet.

    created_at: string

    When the Subnet was created.

    name: string

    Name of the Subnet.

    updated_at: string

    When the Subnet was updated.

    tags: array of string

    Tags to attach to the VPC.

    updated_at: string

    When the VPC was updated.

    Get VPC Details

    nirvana networking:vpcs get \
      --api-key 'My API Key' \
      --vpc-id vpc_id
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "firewall_rule_ids": [
        "123e4567-e89b-12d3-a456-426614174001",
        "123e4567-e89b-12d3-a456-426614174002"
      ],
      "name": "my-vpc",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "status": "ready",
      "subnet": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "cidr": "10.128.35.128/25",
        "created_at": "2025-01-01T00:00:00Z",
        "name": "my-subnet",
        "updated_at": "2025-01-01T00:00:00Z"
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
    Returns Examples
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "firewall_rule_ids": [
        "123e4567-e89b-12d3-a456-426614174001",
        "123e4567-e89b-12d3-a456-426614174002"
      ],
      "name": "my-vpc",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "status": "ready",
      "subnet": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "cidr": "10.128.35.128/25",
        "created_at": "2025-01-01T00:00:00Z",
        "name": "my-subnet",
        "updated_at": "2025-01-01T00:00:00Z"
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }