Skip to content
API reference

Inventory and configuration

Authenticated Segal browser sessions only. Provider credentials remain server-side. No documentation button submits a billable operation.

Read authorized provider inventory or a regional configuration catalog

GET /api/infrastructure/{service}

Parameters

service · path · required
See the endpoint contract and service guide.
region · query
A region explicitly enabled for the signed-in organization.
page · query
See the endpoint contract and service guide.
view · query
See the endpoint contract and service guide.

Responses

  • 200 — Provider-derived resources and pagination metadata; no preview fallback.
  • 401 — Sign-in required.
  • 403 — Region or resource is not authorized.
  • 503 — Application, tenant or provider connection is not activated.

Submit an explicitly activated configuration operation

POST /api/infrastructure/{service}

Owners/admins only. Same-origin browser requests only. Requires a UUID requestId, charge acknowledgment, database migration and operator activation. No automatic retries. Unsupported service orders remain engineering-assisted. Start/stop do not imply a billing pause.

Parameters

service · path · required
See the endpoint contract and service guide.

Request body

requestId · required
string
operation · required
string
acknowledgeCharges · required
boolean
parameters · required
Service-specific validated fields. See the service guide. Instances: name,region,flavorId,imageId,sshKeyId. Volumes: name,region,size,type. VPC/clusters/buckets: name,region. DNS creation: zone,type,name,value,ttl; publication: zone. Instance start/stop: resourceId. Unknown fields are rejected.

Responses

  • 202 — Provider accepted the operation; readiness remains to be verified.
  • 400 — Invalid configuration.
  • 403 — Role, origin, region or resource scope denied.
  • 409 — Assisted provisioning, conflicting request or reconciliation required.
  • 502 — Provider failure or uncertain mutation outcome. Reconcile before retrying.
  • 503 — Provisioning is not activated or operation storage is unavailable.

Read from an authenticated page

Run within the signed-in Segal origin. Choose a configured service and region; this example reads inventory only.

ts
const response = await fetch("/api/infrastructure/instances", { credentials: "same-origin" });
if (!response.ok) throw new Error("Infrastructure access unavailable");
const inventory = await response.json();
Provider setup and activation