Dedicated Access
Platform Control Plane

Enterprise Management API Reference

The PulseGate API enables automated workspace lifecycle management, container session provisioning, and cluster telemetry. Requests against session endpoints require Bearer token authentication and are rate-limited to 120 req/min per tenant.

Authentication & Headers

Standard Request Headers Security Protocol 
Authorization: Bearer <TENANT_TOKEN>
Content-Type: application/json
Accept: application/json

1. Public Telemetry Endpoints (Unauthenticated)

Served directly via Anycast CDN for continuous platform health monitoring (rate limit: 1,000 req/min):

Method & Path Description Response
GET /api/v1/health Overall platform health indicator 200 OK {"status":"operational"}
GET /api/v1/status Platform component operational breakdown 200 OK {"platform":"operational"}
GET /api/v1/version Active control plane version and build hash 200 OK {"version":"1.4.0"}
POST /api/v1/inquiry Dedicated tenant access onboarding request 202 Accepted {"status":"received"}

2. Regional Session Control Endpoints (Bearer Required)

Routed directly to regional cluster gateways (e.g. https://api.gw-<region>.pulsegate.cloud/v1/):

Allocate Workspace Session

POST /v1/sessions

Request Body JSON Schema 
{
  "display": {
    "resolution": "1920x1080@60",
    "codec": "av1"
  },
  "ephemeral": true,
  "idle_timeout_seconds": 1800
}
Response (201 Created) JSON Body 
{
  "session_id": "vdi-8f92a1c4",
  "status": "allocated",
  "stream_endpoint": "https://display.gw-eu.pulsegate.cloud/vdi/v1/display/vdi-8f92a1c4",
  "allocated_at": "2026-10-08T12:00:00Z",
  "expires_in": 3600
}

Query Session Status

GET /v1/sessions/{session_id}

Response (200 OK) Active State 
{
  "session_id": "vdi-8f92a1c4",
  "state": "connected",
  "fps": 60,
  "rtt_ms": 16,
  "client_ip_hash": "e3b0c44298fc"
}

Terminate Workspace Session

DELETE /v1/sessions/{session_id}

Response (200 OK) Tear-Down Confirmation 
{
  "session_id": "vdi-8f92a1c4",
  "state": "terminated",
  "data_purged": true
}

Error Handling & HTTP Status Codes

Status Code Meaning Example Payload
401 Unauthorized Missing or invalid Bearer token {"error":"unauthorized","message":"Valid Bearer token required"}
403 Forbidden Tenant pool quota reached {"error":"forbidden","message":"Session capacity exceeded"}
429 Too Many Requests Rate limit threshold exceeded {"error":"rate_limited","retry_after":60}
500 Server Error Internal cluster exception {"error":"internal_error","message":"Cluster retry in progress"}