VPCs

Explore this section for comprehensive information on endpoints related to the deployment, management, and operation of Virtual Pri within our cloud software API environment.

Get a list of VPCs

get

Query parameters

clusterstringOptional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/vpcs/GetVpcs HTTP/1.1
Host: 
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "cluster": "text",
      "tenancyName": "text",
      "ipRange": "text",
      "createdAt": "2025-05-15T05:26:59.303Z",
      "blockIntraVpcComms": true,
      "isDefault": true
    }
  ]
}

Get detailed information about a specific VPC

get

Query parameters

IdstringRequired

Unique identifier for a resource within the cluster

ClusterstringRequired

The cluster you're operating on

Example: Msc1

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/vpcs/GetVpc?Id=text&Cluster=Msc1 HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text",
  "cluster": "text",
  "tenancyName": "text",
  "ipRange": "text",
  "createdAt": "2025-05-15T05:26:59.303Z",
  "blockIntraVpcComms": true,
  "isDefault": true
}

Create a new VPC

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

namestring · min: 1Required

name of the VPC. should start with {tenancyName}- in case of creating default VPC, name should be {tenancyName}

blockIntraVpcCommsbooleanOptional

if set to true, this VPC will block any intra-VPC communications if ommited, default is false

Example: false

isDefaultbooleanOptional

if set to true, this VPC will be the default VPC for the cluster only one VPC can be default per cluster. if omitted, default is false

Example: false

clusterstring · min: 1Required

The cluster you're operating on

Example: Msc1

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/vpcs/CreateVpc HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "blockIntraVpcComms": false,
  "isDefault": false,
  "cluster": "Msc1"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "id": "text",
  "name": "text",
  "cluster": "text",
  "tenancyName": "text",
  "ipRange": "text",
  "createdAt": "2025-05-15T05:26:59.303Z",
  "blockIntraVpcComms": true,
  "isDefault": true
}

Destroy a VPC

delete

Query parameters

IdstringRequired

Unique identifier for a resource within the cluster

ClusterstringRequired

The cluster you're operating on

Example: Msc1

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/vpcs/DestroyVpc?Id=text&Cluster=Msc1 HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text",
  "cluster": "text",
  "tenancyName": "text",
  "ipRange": "text",
  "createdAt": "2025-05-15T05:26:59.303Z",
  "blockIntraVpcComms": true,
  "isDefault": true
}