Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Create VPC

POST
/network/v1/workspaces/{workspace}/engines/qibdo/vpcs
 
curl --request POST \
  --url https://example.com/network/v1/workspaces/example/engines/qibdo/vpcs \
  --header 'Content-Type: application/json' \
  --data '{ "location_id": "example", "name": "example", "description": "example", "cidr": { "address": "example", "prefix": 1 } }'

Creates a new VPC within a workspace.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace to create the VPC in.

Request Body required

Section titled “Request Body required ”
Media type application/json

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
Example generated
{
  "location_id": "example",
  "name": "example",
  "description": "example",
  "cidr": {
    "address": "example",
    "prefix": 1
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Network Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object
id

Operation ID

Unique identifier for this operation.

stringOutput only
resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only
resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.network:vpc”).

stringOutput only
operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only
Allowed values: NETWORK_OPERATION_TYPE_UNSPECIFIED NETWORK_OPERATION_TYPE_CREATE NETWORK_OPERATION_TYPE_UPDATE NETWORK_OPERATION_TYPE_DELETE
status

Status

Current lifecycle state of the operation.

string format: enum Output only
Allowed values: NETWORK_OPERATION_STATUS_UNSPECIFIED NETWORK_OPERATION_STATUS_PENDING NETWORK_OPERATION_STATUS_RUNNING NETWORK_OPERATION_STATUS_DONE NETWORK_OPERATION_STATUS_ERROR
insert_time

Insert Time

When the operation was first created.

string format: date-time Output only
start_time

Start Time

When the operation started executing.

string format: date-time Output only
end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only
errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Network Operation Error

A structured error returned inside an operation when a business rule fails.

object
code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the error.

stringOutput only
warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Network Operation Warning

A non-fatal notice attached to an operation.

object
code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the warning.

stringOutput only
progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only
Example 
{
  "operation_type": "NETWORK_OPERATION_TYPE_UNSPECIFIED",
  "status": "NETWORK_OPERATION_STATUS_UNSPECIFIED"
}

default

Section titled “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"
    }
  ]
}