Logo
OpenScaler
API Documentation/Virtual Private Cloud (VPC)

Retrieve an existing VPC.

Retrieve details about an existing VM by its ID.

GET
/v1/vpcs/{vpc_id}

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

Path Parameters

vpc_idRequiredstring

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

curl -X GET "https://api.alpha.openscaler.net/v1/vpcs/5" \
  -H "Authorization: Bearer <token>"

VPC details

{
  "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"
}