ReferenceApi

Read-only operator HTTP API

Documentation version: 858adedd187db2e94614b1dfd389e4bf98e6e202:ac5d527caaa1f97eee9d71262e7c843ae7b24000e01ba5b44931108b2b489c0d

Generated from the canonical OpenAPI 0.1.0 contract. Source SHA256: 764c85e702f4b1b5618d7c4d0dd0dd8159117a25e80950464da1618013a36c45. This describes implemented transport shapes; installation capability, grants and validated profile still govern availability.

GET listOperatorProducts

GET /v1/operator/products

Authentication: operatorToken.

ParameterLocationRequiredType
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: CatalogEntryPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET listOperatorTenants

GET /v1/operator/products/{product}/tenants

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: CatalogEntryPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET listOperatorProjects

GET /v1/operator/products/{product}/tenants/{tenant}/projects

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: ProjectPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET listOperatorEnvironments

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: EnvironmentPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET operatorGetDeploymentState

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-state

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Durable operation stateapplication/json: DeploymentState
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetDatabaseBinding

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/database

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Scoped native database binding; no administrator credentialsapplication/json: DatabaseBinding
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetWorkspace

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/workspace

getWorkspace

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Scoped resource resultapplication/json: Workspace
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Plan exceeds the registered hierarchical native message budgetapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetPlacement

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/placement

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Authorized environment placementapplication/json: PlacementState
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorListPlacementLocations

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/locations

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Registered locations allowed by this environment policyapplication/json: {"type":"array","items":{"$ref":"#/components/schemas/PlacementLocation"}}
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetBuildingBlock

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/building-blocks/{resource}

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
resourcepathYes{"type":"string"}
ResponseMeaningBody
200Scoped desired and observed building blockapplication/json: BuildingBlock
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetEnvironmentBuildingBlock

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/building-blocks/by-kind/{kind}

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
kindpathYes{"type":"string","enum":["identity","storage","jobs"]}
ResponseMeaningBody
200Scoped primary blockapplication/json: BuildingBlock

GET operatorGetEnvironment

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Scoped current environmentapplication/json: Environment

GET operatorGetProject

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
ResponseMeaningBody
200Scoped resourceapplication/json: Project

GET operatorGetRepository

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/repository

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
ResponseMeaningBody
200Scoped resourceapplication/json: Repository

GET operatorListProjectOperations

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/operations

List scoped project operations

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: OperationPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET operatorListBuildingBlocks

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/building-blocks

List scoped building blocks

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Authorized stable keyset page. Empty nextCursor marks the end.application/json: BuildingBlockPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

GET getOperatorProjectOperation

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/operations/{operation}

Authentication: managementToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
operationpathYes{"type":"string"}
ResponseMeaningBody
200Durable operation stateapplication/json: OperatorOperationDetail
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET getOperatorProjectOperationLog

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/operations/{operation}/logs/{kind}

Authentication: managementToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
operationpathYes{"type":"string"}
kindpathYes{"type":"string","enum":["build","execution"]}
ResponseMeaningBody
200Durable operation stateapplication/json: OperationLog
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorGetEnvironmentTopology

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/topology

Observed native application hosts, runtime versions and targets for the exact committed placement epoch. Operator audience only. Missing and expired observations are explicit; this does not assert database replication or standby readiness.

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
ResponseMeaningBody
200Native epoch-bound topology observationapplication/json: EnvironmentTopology
400Invalid inputapplication/json: Error
401Missing or invalid credentialapplication/json: Error
403Missing capabilityapplication/json: Error
404Unknown route or scopeapplication/json: Error
409Idempotency conflictapplication/json: Error
413Body exceeds 16 KiBapplication/json: Error
415JSON requiredapplication/json: Error
429Quota exceededapplication/json: Error
503Dependency unavailableapplication/json: Error

GET operatorListHostnames

GET /v1/operator/products/{product}/tenants/{tenant}/projects/{project}/environments/{environment}/hostnames

Registered hostname bindings for the exact environment. This is routing-owner state, not an independent reachability or standby-readiness assertion.

Authentication: operatorToken.

ParameterLocationRequiredType
productpathYes{"type":"string"}
tenantpathYes{"type":"string"}
projectpathYes{"type":"string"}
environmentpathYes{"type":"string"}
limitqueryNo{"type":"integer","minimum":1,"maximum":200,"default":50}
cursorqueryNo{"type":"string"}
ResponseMeaningBody
200Scoped routing-owner inventory, including pending and retired bindingsapplication/json: HostnameBindingPage
400Rejected request or unavailable dependencyapplication/json: Error
401Rejected request or unavailable dependencyapplication/json: Error
403Rejected request or unavailable dependencyapplication/json: Error
404Rejected request or unavailable dependencyapplication/json: Error
503Rejected request or unavailable dependencyapplication/json: Error

Management HTTP API

Previous Page

HTTP schema definitions

Next Page

On this page

GET listOperatorProductsGET listOperatorTenantsGET listOperatorProjectsGET listOperatorEnvironmentsGET operatorGetDeploymentStateGET operatorGetDatabaseBindingGET operatorGetWorkspaceGET operatorGetPlacementGET operatorListPlacementLocationsGET operatorGetBuildingBlockGET operatorGetEnvironmentBuildingBlockGET operatorGetEnvironmentGET operatorGetProjectGET operatorGetRepositoryGET operatorListProjectOperationsGET operatorListBuildingBlocksGET getOperatorProjectOperationGET getOperatorProjectOperationLogGET operatorGetEnvironmentTopologyGET operatorListHostnames