Logo
OpenScaler
API Documentation/Virtual Private Cloud (VPC)

List All VPCs

lists VPCs used by user or by project

GET
/v1/vpcs

Authorization

AuthorizationRequiredBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Query Parameters

project_idRequiredstring

ID of the project used to filter results.

curl -X GET "https://api.alpha.openscaler.net/v1/vpcs?project_id=my-project-default" \
  -H "Authorization: Bearer <token>"

VPC list based on requested filters

[
  {
    "name": "my-vpc",
    "description": "My website VPC",
    "subnet": "10.1.0.0/24",
    "vpc_id": 156,
    "is_default": false,
    "region": "alg1",
    "user_id": "7247ba6a-b17d-4c72-94f1-a36108aee56d",
    "project_id": "my-project-default"
  }
]