Management API / v1
A small API surface.
Explicit session control.
Public platform telemetry on the apex. Authenticated workspace administration on your regional coordinator.
Two API surfaces. Separate credentials.
Public platform telemetry and onboarding inquiries are served from https://pulsegate.cloud. Regional workspace control is served by the coordinator assigned to the tenant. Browser clients create their sessions through the regional workspace service described in the integration guide.
Public telemetry and GET /docs need no credential. Protected coordinator routes require Authorization: Bearer <TENANT_TOKEN>. The token must match the tenant, approved region, and required operation scope.
| Surface | Base URL | Limit |
|---|---|---|
| Public platform | https://pulsegate.cloud/api/v1/ | 1,000 requests/minute per source |
| Regional coordinator | https://api.gw-<region>.pulsegate.cloud/v1/ | 120 requests/minute per tenant credential |
Replace <region> (or gw-X) with your nearest active regional Edge cluster (e.g. as listed in /backbone.html); per-PoP service subdomains vary by cluster role and are published in each node's /docs.
Public telemetry & platform health
Read-only requests return HTTP 200 and JSON. Health metadata reports service state and release metadata; it does not include a server inventory.
| Method | Corporate route | Response |
|---|---|---|
| GET | /api/v1/health | Service name, state, release revision |
| GET | /api/v1/status | Named workspace components and service state |
| GET | /api/v1/version | Release revision, build identifier, service name |
curl -fsS https://pulsegate.cloud/api/v1/health{
"svc": "pulsegate-workspace",
"status": "operational",
"rev": "1.4.0"
}Static compatibility routes are /health.json, /status.json, and /version.json. The API routes map to those same representations.
Submit a provisioning inquiry.
POST /api/v1/inquiry records an enterprise capacity request. Send an organization name and a corporate email address. No user credential is collected by this endpoint.
curl -fsS -X POST https://pulsegate.cloud/api/v1/inquiry \
-H 'Content-Type: application/json' \
--data '{"organization":"<ORGANIZATION_NAME>","email":"<WORK_EMAIL>"}'| Field | Type | Validation |
|---|---|---|
organization | string | Required, 1–180 characters after trimming |
email | string | Required, valid email address, at most 254 characters |
{
"reference_id": "<RETURNED_REFERENCE_ID>",
"inquiry_id": "<RETURNED_REFERENCE_ID>",
"status": "accepted"
}Clients accept either reference_id or inquiry_id as the request reference. HTTP 202 means the inquiry was recorded; capacity and access are confirmed after the review. Invalid fields return HTTP 400 with {"error":"invalid_request"}. Repeated submissions can receive HTTP 429.
If the inquiry service is unavailable, send the same details to hello@pulsegate.cloud.
Regional workspace session control
The coordinator handles tenant-scoped session administration. Its public discovery index lists available workspace roles and their schemas. Never derive service hostnames from a different cluster’s configuration.
| Method | Regional route | Authorization / result |
|---|---|---|
| GET | https://api.gw-<region>.pulsegate.cloud/docs | Public JSON discovery index |
| POST | https://api.gw-<region>.pulsegate.cloud/v1/sessions | Bearer token · 201 Created |
| GET | https://api.gw-<region>.pulsegate.cloud/v1/desktops/{id} | Bearer token · 200 OK |
| DELETE | https://api.gw-<region>.pulsegate.cloud/v1/sessions/{id} | Bearer token · 204 No Content |
curl -fsS -X POST \
'https://api.gw-<region>.pulsegate.cloud/v1/sessions' \
-H 'Authorization: Bearer <TENANT_TOKEN>' \
-H 'Content-Type: application/json' \
--data '{"profile":"contractor-engineering"}'Requests to protected routes without a valid credential return HTTP 401 Unauthorized with {"error":"unauthorized"}. A valid credential without access to the requested profile or region returns HTTP 403.
Resource lookup
GET /v1/desktops/{id} returns the desktop identifier, profile, region, and lifecycle state. A desktop outside the tenant’s scope is not disclosed. Use the public schema index to confirm supported state fields before extending a client.
Session request & response
The coordinator and regional workspace admission service use the same profile semantics. Session locations are returned by the assigned broker. They are not corporate apex routes.
| Request field | Type | Meaning |
|---|---|---|
profile | string | Workspace image and policy profile assigned to the tenant |
metadata | object, optional | Non-sensitive application correlation fields |
{
"session_id": "<SESSION_ID>",
"state": "ready",
"region": "<region>",
"expires_at": "<RFC3339_EXPIRY>",
"display_url": "<REGIONAL_DISPLAY_URL>",
"input_url": "<REGIONAL_INPUT_URL>",
"close_url": "<REGIONAL_SESSION_CLOSE_URL>",
"policy": {
"clipboard_out": false,
"download": false,
"printing": false,
"storage": "ephemeral"
}
}session_id and expires_at identify the admitted session and its maximum lifetime. display_url, input_url, and close_url are HTTPS locations returned by the regional service. policy is the effective workspace policy, not a client-selected override.
Session creation is a state-changing operation. Avoid blind retries after a connection interruption. For safe retries, consult the assigned coordinator schema for its supported idempotency mechanism.
Errors, limits, and recovery
| HTTP status | JSON error | Client action |
|---|---|---|
| 400 | invalid_request | Correct the request fields before resubmitting. |
| 401 | unauthorized | Obtain a valid, unexpired tenant credential. |
| 403 | forbidden | Check profile scope and permitted residency region. |
| 404 | not_found | Confirm the resource belongs to this tenant and region. |
| 429 | rate_limited | Honor the Retry-After response header. |
| 500 | internal_error | Retain the request reference and contact operations. |
{
"error": "rate_limited",
"message": "The tenant request allowance is temporarily exhausted.",
"request_id": "<REQUEST_REFERENCE>"
}Error responses may include a human-readable message and a non-secret request_id. Do not log Bearer headers, identity assertions, desktop contents, or session credentials. Public telemetry is limited to 1,000 requests per minute; protected coordinator requests are limited to 120 per minute per tenant credential.
For an operational investigation, send the request reference and observed time to noc@pulsegate.cloud. Service availability is published on the health board. Use is subject to the Terms of Service.