List VPCs

GET

/network/v1/workspaces/{workspace}/engines/qibdo/vpcs

curl --request GET \
  --url https://example.com/network/v1/workspaces/example/engines/qibdo/vpcs

Returns a paginated list of VPCs within a workspace.

Parameters

Path Parameters

workspace

required

string

The workspace to list VPCs for.

Query Parameters

page_size

integer format: int32

Page Size

The maximum number of VPCs to return. The service may return fewer than this value. If unspecified, at most 20 VPCs will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

Page Token

A page token, received from a previous ListQibdoVpcs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListQibdoVpcs must match the call that provided the page token.

filter

string

Filter

AIP-160 filter expression, e.g. ‘location_id = “uuid”’.

order_by

string

Order By

AIP-132 order_by expression, e.g. ‘name asc’.

Responses

200

OK

Media type application/json

ListQibdoVpcsResponse

Response message for ListQibdoVpcs. Note: This API intentionally omits total_size from list responses. Keyset pagination does not support efficient total count computation (COUNT(*) requires a full table scan). Per AIP-158, total_size is optional.

object

vpcs

The list of VPCs.

Array<object>

QibdoVpc — a virtual private cloud backed by Open Virtual Network (OVN). The agnostic CTI root holds workspace, location, name, description, cidr; this engine-specific message exposes the OVN-shaped surface clients interact with directly.

object

id

Unique identifier for this VPC.

stringOutput only

workspace_id

The workspace that owns this VPC.

stringOutput only

location_id

required

The region this VPC is deployed in. A VPC spans a region; its subnets are placed in individual zones within that region.

string

name

required

The display name of the VPC.

string

description

An optional human-readable description of the VPC.

string

cidr

required

The CIDR block that defines the IP address space for this VPC.

object

address

string

prefix

integer format: uint32

provider_resource_id

OVN-assigned VPC identifier. Populated once OVN provisions the VPC.

stringOutput only

created

When this VPC was created.

string format: date-time Output only

updated

When this VPC was last updated.

string format: date-time Output only

next_page_token

Next Page Token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string

Example ^generated

{
  "vpcs": [
    {
      "location_id": "example",
      "name": "example",
      "description": "example",
      "cidr": {
        "address": "example",
        "prefix": 1
      }
    }
  ],
  "next_page_token": "example"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}