vpcs

List all VPCs in the workspace

get/vpcs

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopesadmin
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/vpcs/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

successful operation

specVPCSpec required

VPC specification (controlplane-only, no external resources)

status'DELETING' | 'TERMINATED' | 'FAILED' | 'DEACTIVATED' | 'DEACTIVATING' | 'UPLOADING' | 'BUILDING' | 'DEPLOYING' | 'DEPLOYED' | 'BUILT'

Deployment status of a resource deployed on Blaxel

Example response

[
  {
    "events": [
      {
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ],
    "metadata": {
      "displayName": "My Resource",
      "externalId": "my-session-123",
      "name": "my-resource"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.