REST - Virtual DC

Listing virtual data centers

Request

GET /v2/vdc

Returns an array with a list of existing groups.

Response

{
  "networks": [
    {
      "id": "$vdc_id",
      "name": "$vdc_name",
      "owner": {
        "id": "$owner_id",
        "name": "$owner_name"
      },
      "zone": {
        "id": "$zone_id",
        "name": "$zone_name"
      },
      "subnets": [
        {
          "id": "$subnets_id",
          "name": "$subnets_name",
          "address": "$subnets_address",
          "network": {
            "id": "$network_id",
            "name": "$network_name"
          },
          "virtual_machines": [
            {
              "id": "$virtual_machines_id",
              "name": "$virtual_machines_name"
            }, { ... }
          ],
          "gateways": [
            {
              "id": "$gateways_id",
              "type": "$gateways_type",
              "address": {
                "id": "$gateways_address_id",
                "address": "$gateways_address_address"
              },
              "subnet": {
                "id": "$gateways_subnet_id",
                "name": "$gateways_subnet_name"
              },
              "owner": {
                "id": "$gateways_owner_id",
                "name": "$gateways_owner_name"
              },
              "routes": [
                {
                  "id": "$gateways_route_id",
                  "destination": "$gateways_route_destination",
                  "routeTable": {
                    "id": "$gateways_route_routeTable_id"
                  }
                }, { ... }
              ]
            }, { ... }
          ],
          "route_table":
          {
            "id": "$gateways_route_table_id",
            "name": "$gateways_route_name"
          }
        }, { ... }
      ],
      "route_tables": [
        {
          "id": "$route_tables_id",
          "name": "$route_tables_name",
          "network": {
            "id": "$route_tables_network_id",
            "name": "$route_tables_network_name"
          },
          "owner": {
            "id": "$route_tables_owner_id",
            "name": "$route_tables_owner_name"
          },
          "routes": [
            {
              "id": "$route_tables_routes_id",
              "destination": "$route_tables_routes_destination",
              "gateway": {
                "id": "$route_tables_routes_gateway_id",
                "label": "$route_tables_routes_gateway_label"
              }
            }, { ... }
          ]
        }, { ... }
      ]
    }, { ... }
  ]
}

Returned information

• $vdc_id (string) - virtual DC UUID
• $vdc_name (string) - virtual DC name
• $owner_id (string) - owner UUID
• $owner_name (string) - owner name
• $zone_id (string) - compute zone UUID
• $zone_name (string) - compute zone name
• $subnets_id (string) - subnet UUID
• $subnets_name (string) - subnet name
• $subnets_address (string) - IPv4 network addressing of the subnet
• $network_id (string) - network UUID
• $network_name (string) - network name
• $virtual_machines_id (string) - virtual server UUID
• $virtual_machines_name (string) - virtual server name
• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route
• $gateways_route_table_id (string) - gateway routing table UUID
• $gateways_route_name (string) - gateway routing table name
• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Adding a virtual data center

Request

PUT /v2/vdc

Adds a new group.

Request body

{
  "zone_id": "$zone_id", 
  "name": "$name"
}

Parameter description

• $zone_id (string) - compute zone UUID
• $name (string) - virtual data center name

Response

{
  "networks": [
    {
      "id": "$vdc_id",
      "name": "$vdc_name",
      "owner": {
        "id": "$owner_id",
        "name": "$owner_name"
      },
      "zone": {
        "id": "$zone_id",
        "name": "$zone_name"
      },
      "subnets": [
        {
          "id": "$subnets_id",
          "name": "$subnets_name",
          "address": "$subnets_address",
          "network": {
            "id": "$network_id",
            "name": "$network_name"
          },
          "virtual_machines": [
            {
              "id": "$virtual_machines_id",
              "name": "$virtual_machines_name"
            }, { ... }
          ],
          "gateways": [
            {
              "id": "$gateways_id",
              "type": "$gateways_type",
              "address": {
                "id": "$gateways_address_id",
                "address": "$gateways_address_address"
              },
              "subnet": {
                "id": "$gateways_subnet_id",
                "name": "$gateways_subnet_name"
              },
              "owner": {
                "id": "$gateways_owner_id",
                "name": "$gateways_owner_name"
              },
              "routes": [
                {
                  "id": "$gateways_route_id",
                  "destination": "$gateways_route_destination",
                  "routeTable": {
                    "id": "$gateways_route_routeTable_id"
                  }
                }, { ... }
              ]
            }
          ],
          "route_table":
          {
            "id": "$gateways_route_table_id",
            "name": "$gateways_route_name"
          }
        }
      ],
      "route_tables": [
        {
          "id": "$route_tables_id",
          "name": "$route_tables_name",
          "network": {
            "id": "$route_tables_network_id",
            "name": "$route_tables_network_name"
          },
          "owner": {
            "id": "$route_tables_owner_id",
            "name": "$route_tables_owner_name"
          },
          "routes": [
            {
              "id": "$route_tables_routes_id",
              "destination": "$route_tables_routes_destination",
              "gateway": {
                "id": "$route_tables_routes_gateway_id",
                "label": "$route_tables_routes_gateway_label"
              }
            }, { ... }
          ]
        }
      ]
    }
  ]
}

Returned information

• $vdc_id (string) - virtual DC UUID
• $vdc_name (string) - virtual DC name
• $owner_id (string) - owner UUID
• $owner_name (string) - owner name
• $zone_id (string) - compute zone UUID
• $zone_name (string) - compute zone name
• $subnets_id (string) - subnet UUID
• $subnets_name (string) - subnet name
• $subnets_address (string) - IPv4 network addressing of the subnet
• $network_id (string) - network UUID
• $network_name (string) - network name
• $virtual_machines_id (string) - virtual server UUID
• $virtual_machines_name (string) - virtual server name
• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route
• $gateways_route_table_id (string) - gateway routing table UUID
• $gateways_route_name (string) - gateway routing table name
• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Getting VDC information

Request

GET /v2/vdc/$VDC_ID

Returns information about a single VDC with the specified $VDC_ID.

Response

{
  "networks": [
    {
      "id": "$vdc_id",
      "name": "$vdc_name",
      "owner": {
        "id": "$owner_id",
        "name": "$owner_name"
      },
      "zone": {
        "id": "$zone_id",
        "name": "$zone_name"
      },
      "subnets": [
        {
          "id": "$subnets_id",
          "name": "$subnets_name",
          "address": "$subnets_address",
          "network": {
            "id": "$network_id",
            "name": "$network_name"
          },
          "virtual_machines": [
            {
              "id": "$virtual_machines_id",
              "name": "$virtual_machines_name"
            }, { ... }
          ],
          "gateways": [
            {
              "id": "$gateways_id",
              "type": "$gateways_type",
              "address": {
                "id": "$gateways_address_id",
                "address": "$gateways_address_address"
              },
              "subnet": {
                "id": "$gateways_subnet_id",
                "name": "$gateways_subnet_name"
              },
              "owner": {
                "id": "$gateways_owner_id",
                "name": "$gateways_owner_name"
              },
              "routes": [
                {
                  "id": "$gateways_route_id",
                  "destination": "$gateways_route_destination",
                  "routeTable": {
                    "id": "$gateways_route_routeTable_id"
                  }
                }, { ... }
              ]
            }
          ],
          "route_table":
          {
            "id": "$gateways_route_table_id",
            "name": "$gateways_route_name"
          }
        }
      ],
      "route_tables": [
        {
          "id": "$route_tables_id",
          "name": "$route_tables_name",
          "network": {
            "id": "$route_tables_network_id",
            "name": "$route_tables_network_name"
          },
          "owner": {
            "id": "$route_tables_owner_id",
            "name": "$route_tables_owner_name"
          },
          "routes": [
            {
              "id": "$route_tables_routes_id",
              "destination": "$route_tables_routes_destination",
              "gateway": {
                "id": "$route_tables_routes_gateway_id",
                "label": "$route_tables_routes_gateway_label"
              }
            }, { ... }
          ]
        }
      ]
    }
  ]
}

Returned information

• $vdc_id (string) - virtual DC UUID
• $vdc_name (string) - virtual DC name
• $owner_id (string) - owner UUID
• $owner_name (string) - owner name
• $zone_id (string) - compute zone UUID
• $zone_name (string) - compute zone name
• $subnets_id (string) - subnet UUID
• $subnets_name (string) - subnet name
• $subnets_address (string) - IPv4 network addressing of the subnet
• $network_id (string) - network UUID
• $network_name (string) - network name
• $virtual_machines_id (string) - virtual server UUID
• $virtual_machines_name (string) - virtual server name
• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route
• $gateways_route_table_id (string) - gateway routing table UUID
• $gateways_route_name (string) - gateway routing table name
• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Getting subnet information

Request

GET /v2/vdc/$SUBNET_ID/subnet

Returns information about a single subnet with the specified $SUBNET_ID.

Response

{
  "id": "$subnets_id",
  "name": "$subnets_name",
  "address": "$subnets_address",
  "network": {
    "id": "$network_id",
    "name": "$network_name"
  },
  "virtual_machines": [
    {
      "id": "$virtual_machines_id",
      "name": "$virtual_machines_name"
    }, { ... }
  ],
  "gateways": [
    {
      "id": "$gateways_id",
      "type": "$gateways_type",
      "address": {
        "id": "$gateways_address_id",
        "address": "$gateways_address_address"
      },
      "subnet": {
        "id": "$gateways_subnet_id",
        "name": "$gateways_subnet_name"
      },
      "owner": {
        "id": "$gateways_owner_id",
        "name": "$gateways_owner_name"
      },
      "routes": [
        {
          "id": "$gateways_route_id",
          "destination": "$gateways_route_destination",
          "routeTable": {
            "id": "$gateways_route_routeTable_id"
          }
        }, { ... }
      ]
    }
  ],
  "route_table":
  {
    "id": "$gateways_route_table_id",
    "name": "$gateways_route_name"
  }
}

Returned information

• $subnets_id (string) - subnet UUID
• $subnets_name (string) - subnet name
• $subnets_address (string) - IPv4 network addressing of the subnet
• $network_id (string) - network UUID
• $network_name (string) - network name
• $virtual_machines_id (string) - virtual server UUID
• $virtual_machines_name (string) - virtual server name
• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route
• $gateways_route_table_id (string) - gateway routing table UUID
• $gateways_route_name (string) - gateway routing table name

Getting gateway information

Request

GET /v2/vdc/$GATEWAY_ID/gateway

Returns information about a single gateway with the specified $GATEWAY_ID.

Response

{
  "id": "$gateways_id",
  "type": "$gateways_type",
  "address": {
    "id": "$gateways_address_id",
    "address": "$gateways_address_address"
  },
  "subnet": {
    "id": "$gateways_subnet_id",
    "name": "$gateways_subnet_name"
  },
  "owner": {
    "id": "$gateways_owner_id",
    "name": "$gateways_owner_name"
  },
  "routes": [
    {
      "id": "$gateways_route_id",
      "destination": "$gateways_route_destination",
      "routeTable": {
        "id": "$gateways_route_routeTable_id"
      }
    }, { ... }
  ]
}

Returned information

• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route

Getting routing table information

Request

GET /v2/vdc/$ROUTE_TABLE_ID/route_table

Returns information about a single VDC routing table with the specified $ROUTE_TABLE_ID.

Response

{
  "id": "$route_tables_id",
  "name": "$route_tables_name",
  "network": {
    "id": "$route_tables_network_id",
    "name": "$route_tables_network_name"
  },
  "owner": {
    "id": "$route_tables_owner_id",
    "name": "$route_tables_owner_name"
  },
  "routes": [
    {
      "id": "$route_tables_routes_id",
      "destination": "$route_tables_routes_destination",
      "gateway": {
        "id": "$route_tables_routes_gateway_id",
        "label": "$route_tables_routes_gateway_label"
      }
    }, { ... }
  ]
}

Returned information

• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Adding a subnet

Request

PUT /v2/vdc/$VDC_ID/subnet

Adds a new subnet to the virtual data center $VDC_ID.

Request body

{
  "name": "$name", 
  "address": "$address"
}

Parameter description

• $name (string) - subnet name
• $address (string) - IPv4 network addressing of the subnet

Response

{
  "id": "$subnets_id",
  "name": "$subnets_name",
  "address": "$subnets_address",
  "network": {
    "id": "$network_id",
    "name": "$network_name"
  },
  "virtual_machines": [
    {
      "id": "$virtual_machines_id",
      "name": "$virtual_machines_name"
    }, { ... }
  ],
  "gateways": [
    {
      "id": "$gateways_id",
      "type": "$gateways_type",
      "address": {
        "id": "$gateways_address_id",
        "address": "$gateways_address_address"
      },
      "subnet": {
        "id": "$gateways_subnet_id",
        "name": "$gateways_subnet_name"
      },
      "owner": {
        "id": "$gateways_owner_id",
        "name": "$gateways_owner_name"
      },
      "routes": [
        {
          "id": "$gateways_route_id",
          "destination": "$gateways_route_destination",
          "routeTable": {
            "id": "$gateways_route_routeTable_id"
          }
        }, { ... }
      ]
    }
  ],
  "route_table":
  {
    "id": "$gateways_route_table_id",
    "name": "$gateways_route_name"
  }
}

Returned information

• $subnets_id (string) - subnet UUID
• $subnets_name (string) - subnet name
• $subnets_address (string) - IPv4 network addressing of the subnet
• $network_id (string) - network UUID
• $network_name (string) - network name
• $virtual_machines_id (string) - virtual server UUID
• $virtual_machines_name (string) - virtual server name
• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route
• $gateways_route_table_id (string) - gateway routing table UUID
• $gateways_route_name (string) - gateway routing table name

Adding a gateway to a subnet

Request

PUT /v2/vdc/$SUBNET_ID/gateway

Adds a new gateway to the subnet $SUBNET_ID.

Request body

{
  "type": "type", 
  "name": "$name", 
  "address_id": "$address_id"
}

Parameter description

• $type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $name (string) - gateway name
• $address_id (string) - gateway network address UUID, if type=NAT_IPV4

Response

{
  "id": "$gateways_id",
  "type": "$gateways_type",
  "address": {
    "id": "$gateways_address_id",
    "address": "$gateways_address_address"
  },
  "subnet": {
    "id": "$gateways_subnet_id",
    "name": "$gateways_subnet_name"
  },
  "owner": {
    "id": "$gateways_owner_id",
    "name": "$gateways_owner_name"
  },
  "routes": [
    {
      "id": "$gateways_route_id",
      "destination": "$gateways_route_destination",
      "routeTable": {
        "id": "$gateways_route_routeTable_id"
      }
    }
  ]
}

Returned information

• $gateways_id (string) - gateway UUID
• $gateways_type (string) - gateway type - NAT_IPV4, INTERNET_IPV4
• $gateways_address_id (string) - gateway network address UUID, if gateways_type=NAT_IPV4
• $gateways_address_address (string) - gateway network address, if gateways_type=NAT_IPV4
• $gateways_subnet_id (string) - gateway subnet UUID
• $gateways_subnet_name (string) - gateway subnet name
• $gateways_owner_id (string) - gateway owner UUID
• $gateways_owner_name (string) - gateway owner name
• $gateways_route_id (string) - gateway route UUID
• $gateways_route_destination (string) - destination IPv4 network address of the gateway route
• $gateways_route_routeTable_id (string) - routing table UUID of the gateway route

Adding a routing table

Request

PUT /v2/vdc/$VDC_ID/route_table

Adds a new routing table to the virtual data center $VDC_ID.

Request body

{
  "name": "$name"
}

Parameter description

• $name (string) - routing table name

Response

{
  "id": "$route_tables_id",
  "name": "$route_tables_name",
  "network": {
    "id": "$route_tables_network_id",
    "name": "$route_tables_network_name"
  },
  "owner": {
    "id": "$route_tables_owner_id",
    "name": "$route_tables_owner_name"
  },
  "routes": [
    {
      "id": "$route_tables_routes_id",
      "destination": "$route_tables_routes_destination",
      "gateway": {
        "id": "$route_tables_routes_gateway_id",
        "label": "$route_tables_routes_gateway_label"
      }
    }, { ... }
  ]
}

Returned information

• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Adding a route to a routing table

Request

PUT /v2/vdc/$ROUTE_TABLE_ID/route

Adds a new route to the routing table $ROUTE_TABLE_ID.

Request body

{
  "gateway_id": "$gateway_id",
  "destination": "$destination"
}

Parameter description

• $gateway_id (string) - gateway UUID
• $destination - destination IPv4 network address of the routing table rule

Response

{
  "id": "$route_tables_id",
  "name": "$route_tables_name",
  "network": {
    "id": "$route_tables_network_id",
    "name": "$route_tables_network_name"
  },
  "owner": {
    "id": "$route_tables_owner_id",
    "name": "$route_tables_owner_name"
  },
  "routes": [
    {
      "id": "$route_tables_routes_id",
      "destination": "$route_tables_routes_destination",
      "gateway": {
        "id": "$route_tables_routes_gateway_id",
        "label": "$route_tables_routes_gateway_label"
      }
    }, { ... }
  ]
}

Returned information

• $route_tables_id (string) - routing table UUID
• $route_tables_name (string) - routing table name
• $route_tables_network_id (string) - routing table network UUID
• $route_tables_network_name (string) - routing table network name
• $route_tables_owner_id (string) - routing table owner UUID
• $route_tables_owner_name (string) - routing table owner name
• $route_tables_routes_id (string) - routing table rule UUID
• $route_tables_routes_destination - destination IPv4 network address of the routing table rule
• $route_tables_routes_gateway_id (string) - routing table rule gateway UUID
• $route_tables_routes_gateway_label (string) - routing table rule gateway name

Attaching a routing table to a subnet

Request

PUT /v2/vdc/$SUBNET_ID/attach-route-table

Attaches a routing table to the subnet $SUBNET_ID.

Request body

{
  "route_table_id": "$route_table_id"
}

Parameter description

• $route_table_id (string) - routing table UUID

Response

{
  "success":true
}

Detaching a routing table from a subnet

Request

PUT /v2/vdc/$SUBNET_ID/detach-route-table

Detaches a routing table from the subnet $SUBNET_ID.

Request body

{
  "route_table_id": "$route_table_id"
}

Parameter description

• $route_table_id (string) - routing table UUID

Response

{
  "success":true
}

Renaming

Request

PUT /v2/vdc/$ID/rename

Changes the name of the resource $ID, which can be vdc_id, subnet_id, gateway_id, or route_table_id.

Request body

{
  "name": "$name"
}

Parameter description

• $name (string) - new resource name

Response

{
  "success":true
}

Deleting a virtual data center

Request

DELETE  DELETE /v2/vdc/$VDC_ID/vdc

Adds a task to delete the VDC with the specified $VDC_ID.

Response

{
  "success":true
}

Deleting a subnet

Request

DELETE  DELETE /v2/vdc/$SUBNET_ID/subnet

Adds a task to delete the subnet with the specified $SUBNET_ID.

Response

{  
  "success":true
}

Deleting a gateway

Request

DELETE  DELETE /v2/vdc/$GATEWAY_ID/gateway

Adds a task to delete the gateway with the specified $GATEWAY_ID.

Response

{  
  "success":true
}

Deleting a routing table

Request

DELETE  DELETE /v2/vdc/$ROUTE_TABLE_ID/route-table

Adds a task to delete the routing table with the specified $ROUTE_TABLE_ID.

Response

{  
  "success":true
}

Deleting a route

Request

DELETE  DELETE /v2/vdc/$ROUTE_ID/route

Adds a task to delete the route with the specified $ROUTE_ID.

Response

{  
  "success":true
}

Updated on 27 Apr 2026