Skip to main content
GET
/
vpcs
List all VPCs in the workspace
curl --request GET \
  --url https://api.blaxel.ai/v0/vpcs \
  --header 'Authorization: Bearer <token>'
[
  {
    "metadata": {
      "name": "my-resource",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "displayName": "My Resource",
      "labels": {},
      "plan": "<string>",
      "url": "<string>",
      "workspace": "<string>"
    },
    "spec": {},
    "events": [
      {
        "canaryRevision": "<string>",
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ],
    "status": "DELETING"
  }
]

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Response

200 - application/json

successful operation

​
metadata
object
required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

​
spec
object
required

VPC specification (controlplane-only, no external resources)

​
events
object[]

Events happening on a resource deployed on Blaxel

​
status
enum<string>

Deployment status of a resource deployed on Blaxel

Available options:
DELETING,
TERMINATED,
FAILED,
DEACTIVATED,
DEACTIVATING,
UPLOADING,
BUILDING,
DEPLOYING,
DEPLOYED