Skip to main content
GET
/
vpcs
/
{vpcName}
Get a VPC by name
curl --request GET \
  --url https://api.blaxel.ai/v0/vpcs/{vpcName} \
  --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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

​
vpcName
string
required

Response

200 - application/json

successful operation

Virtual Private Cloud scoped to a workspace for network isolation and dedicated egress

​
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[]
read-only

Events happening on a resource deployed on Blaxel

​
status
enum<string>
read-only

Deployment status of a resource deployed on Blaxel

Available options:
DELETING,
TERMINATED,
FAILED,
DEACTIVATED,
DEACTIVATING,
UPLOADING,
BUILDING,
DEPLOYING,
DEPLOYED,
BUILT
Last modified on June 3, 2026