Information
- License: AGPL-3.0-only
- OpenAPI version:
3.1.0
Overview
Stratum API v0.7.0
Section titled “Stratum API v0.7.0”The REST API of Stratum: every resource, for tenants and operators.
Endpoint. https://stratum.<parent-domain> through the front door, or
http://<node>:8443 on the node’s address.
Authentication. Sign in with POST /v1/iam/login (email and password) and
send the returned token on every call as Authorization: Bearer <token>. A
personal access token or a service-account key works the same way.
Requests. JSON in and out. Project resources live under
/v1/projects/{projectId}/<service>/...; install-wide ones under /v1/<service>.
Creates and other long changes answer 202 with the resource in its first
state; poll it until it is ready. Lists are paginated with a cursor
(pageToken, nextPageToken).
Errors. RFC 7807 problem documents (application/problem+json) with a
machine-readable code, for example 400 VALIDATION_FAILED, 403 FORBIDDEN,
404 NOT_FOUND, 409 CONFLICT, 503 SERVICE_DISABLED.
Generated from Stratum v0.7.0 (7d9b80cd).
Operations
Section titled “Operations”GET
/healthzGET
/livezGET
/readyzGET
/dataplaneGET
/startupzGET
/versionPOST
/v1/iam/loginPOST
/v1/iam/logoutGET
/v1/iam/mePOST
/v1/iam/usersDELETE
/v1/iam/users/{userId}POST
/v1/iam/simulatePOST
/v1/iam/groupsDELETE
/v1/iam/groups/{groupId}GET
/v1/brandingGET
/v1/projectsDELETE
/v1/projects/{projectId}GET
/v1/servicesGET
/v1/regionsGET
/v1/auditPOST
/v1/projects/{projectId}/network/client-vpn-endpoints/{clientVpnEndpointId}/associate-floating-ipGET
/v1/imagesPOST
/v1/imagesDELETE
/v1/images/{imageId}DELETE
/v1/projects/{projectId}/observability/log-groups/{logGroupId}/metric-filters/{metricFilterId}GET
/v1/projects/{projectId}/db/instances/{dbInstanceId}/blue-green-deployments/{blueGreenDeploymentId}DELETE
/v1/projects/{projectId}/db/instances/{dbInstanceId}/blue-green-deployments/{blueGreenDeploymentId}POST
/v1/join/pakeAuthentication
Section titled “Authentication”bearerAuth
Section titled “bearerAuth”Opaque Bearer token. Obtained via POST /v1/iam/login.
Security scheme type: http
Bearer format: opaque