Logo
OpenScaler
API DocumentationVirtual Private Cloud (VPC)

Delete a VPC

DELETE
/v1/vpcs/{vpc_id}

Delete a VPC with by its ID

NOTE:

this call will fail if the VPC is still used by some resource. In this case the resource needs to be deleted first before deleting the VPC itself.

Authorization

bearer_auth
AuthorizationBearer <token>

Authentication

Create an API token on Profile, or with osctl auth login. Send it in the Authorization header:

Authorization: Bearer os1_...

Do not use the Keycloak web-session JWT as an API token. Keep the secret secure and do not share it.

In: header

Path Parameters

vpc_id*string

A unique identifier for a VPC instance. See VPCs section for more details.

Formatuuid

Response Body

application/json

text/pain

application/json

application/json

curl -X DELETE "https://example.com/v1/vpcs/f47ac10b-58cc-4372-a567-0e02b2c3d479"
Empty
{  "errors": [    {      "message": "'vcpus' field must be an integer",      "field": "resource_id"    }  ]}
"Access denied"
{  "errors": [    {      "message": "User not initialized. Send POST /v1/init, then retry the request."    }  ]}
{  "errors": [    {      "message": "VM with ID 23 not found"    }  ]}