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/api/v1/vpcs/GetVpcs

Query parameters

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/vpcs/GetVpcs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

202

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Get detailed information about a specific VPC

GET/api/v1/vpcs/GetVpc

Query parameters

Response

202400401403500

Accepted

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/vpcs/GetVpc?Id=text&Cluster=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

202

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Create a new VPC

POST/api/v1/vpcs/CreateVpc

Body

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

id*string

cluster*string

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/vpcs/CreateVpc', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cluster": "text",
      "id": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}

Destroy a VPC

DELETE/api/v1/vpcs/DestroyVpc

Query parameters

Response

200400401403500

Success

Body

text/plainapplication/jsontext/json

idnullable string

clusternullable string

hostTypenullable string

usernamenullable string

tenancyNamenullable string

gpuTypenullable string

gpusinteger (int32)

vcpusinteger (int32)

vcpuTypenullable string

memoryinteger (int32)

ipnullable string

privateIpnullable string

imageIdnullable string

imagenullable string

storageinteger (int32)

storageClassnullable string

vpcIdnullable string

reservationnullable string

reservationExpirynullable string

statusnullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/vpcs/DestroyVpc?Id=text&Cluster=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "cluster": "text",
  "hostType": "text",
  "username": "text",
  "tenancyName": "text",
  "gpuType": "text",
  "vcpuType": "text",
  "ip": "text",
  "privateIp": "text",
  "imageId": "text",
  "image": "text",
  "storageClass": "text",
  "vpcId": "text",
  "reservation": "text",
  "reservationExpiry": "text",
  "status": "text"
}