ReferenceApi
HTTP schema definitions
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.
CreateProject
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
}Accepted
{
"type": "object",
"required": [
"operationId",
"resourceId",
"statusUrl"
],
"properties": {
"operationId": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"statusUrl": {
"type": "string"
}
}
}Operation
{
"type": "object",
"required": [
"id",
"resourceId",
"state",
"step",
"attempts",
"errorCode"
],
"properties": {
"id": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"waiting",
"succeeded",
"failed"
]
},
"step": {
"type": "string",
"enum": [
"accepted",
"provisioning",
"verifying",
"complete"
]
},
"attempts": {
"type": "integer"
},
"errorCode": {
"type": "string"
}
}
}Error
{
"type": "object",
"required": [
"code",
"message",
"requestId",
"retryable"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"requestId": {
"type": "string"
},
"retryable": {
"type": "boolean"
}
}
}CreateDeployment
{
"type": "object",
"additionalProperties": false,
"required": [
"releaseId",
"expectedRevision"
],
"properties": {
"releaseId": {
"type": "string"
},
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
}
}
}DeploymentState
{
"type": "object",
"required": [
"revision",
"bindingRevision",
"activeRelease"
],
"properties": {
"revision": {
"type": "integer",
"format": "int64"
},
"bindingRevision": {
"type": "integer",
"format": "int64"
},
"activeRelease": {
"type": "string",
"nullable": true
}
}
}OperationLog
{
"type": "object",
"required": [
"operationId",
"kind",
"available",
"text"
],
"properties": {
"operationId": {
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/OperationLogKind"
},
"available": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
}CreateSourceDeployment
{
"type": "object",
"additionalProperties": false,
"required": [
"revision",
"bindingRevision",
"expectedRevision"
],
"properties": {
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{40}$"
},
"bindingRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"databasePlan": {
"$ref": "#/components/schemas/ReleasePlanApproval"
}
}
}CreateDatabase
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"initializationRef": {
"type": "string",
"description": "Immutable reviewed native initialization reference, authorized by installation policy. Reuse does not reseed existing data."
},
"expectedEnvironmentKind": {
"type": "string",
"description": "Optional role precondition: preview, staging or production. It restricts the verified target and never grants permission."
},
"restoreRef": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Verified native component registered for this exact target scope by the installation owner. Mutually exclusive with initializationRef; requires an explicit expectedEnvironmentKind. A reference cannot select a file path or grant access."
}
}
}DatabaseBinding
{
"type": "object",
"additionalProperties": false,
"required": [
"appId",
"environmentId",
"state",
"apiURI",
"websocketURI",
"cellId",
"locationId",
"revision",
"environmentKind",
"initializationRef",
"schemaRevision",
"datasetRevision"
],
"properties": {
"appId": {
"type": "string"
},
"environmentId": {
"type": "string"
},
"state": {
"type": "string"
},
"apiURI": {
"type": "string"
},
"websocketURI": {
"type": "string"
},
"cellId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int64"
},
"environmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"initializationRef": {
"type": "string"
},
"schemaRevision": {
"type": "string"
},
"datasetRevision": {
"type": "string"
}
}
}CreateDatabaseSession
{
"type": "object",
"additionalProperties": false,
"required": [
"appId",
"cookie"
],
"properties": {
"appId": {
"type": "string",
"format": "uuid",
"x-go-type": "string"
},
"cookie": {
"type": "string",
"writeOnly": true,
"description": "Opaque configured-authority session forwarded only by the registered application server. Never log this field."
}
}
}DatabaseSessionToken
{
"type": "object",
"additionalProperties": false,
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"format": "uuid",
"description": "Native app-scoped session; the gateway continues live authority, grant and expiry checks.",
"x-go-type": "string"
}
}
}CreateDatabaseProbe
{
"type": "object",
"additionalProperties": false,
"required": [
"appId"
],
"properties": {
"appId": {
"type": "string",
"format": "uuid",
"x-go-type": "string"
}
}
}DatabaseProbe
{
"type": "object",
"additionalProperties": false,
"required": [
"ready"
],
"properties": {
"ready": {
"type": "boolean"
}
}
}CreateReleasePlan
{
"type": "object",
"additionalProperties": false,
"required": [
"steps",
"rules",
"destructiveApproved"
],
"properties": {
"steps": {
"type": "array",
"items": {
"type": "array",
"items": {}
},
"description": "Native Instant schema transaction steps. Unsupported background operations are rejected."
},
"rules": {
"type": "object",
"additionalProperties": true,
"description": "Native CEL permission rules."
},
"destructiveApproved": {
"type": "boolean",
"description": "Requires deployment.plan.approve for the exact reviewed plan at deployment acceptance."
}
}
}ReleasePlan
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"state",
"databaseAppId",
"digest",
"plan"
],
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pending",
"reviewed"
]
},
"databaseAppId": {
"type": "string",
"pattern": "^[a-f0-9-]{36}$"
},
"digest": {
"type": "string"
},
"plan": {
"type": "object",
"additionalProperties": true
}
}
}ReleasePlanApproval
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"digest"
],
"properties": {
"id": {
"type": "string"
},
"digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
}DomainRegistration
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"domain": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pending",
"verified"
]
},
"revision": {
"type": "integer",
"format": "int64"
},
"challengeName": {
"type": "string"
},
"challengeValue": {
"type": "string"
}
},
"required": [
"id",
"domain",
"state",
"revision",
"challengeName",
"challengeValue"
]
}CreateDomainRegistration
{
"type": "object",
"additionalProperties": false,
"properties": {
"domain": {
"type": "string"
}
},
"required": [
"domain"
]
}CreateHostnameBinding
{
"type": "object",
"additionalProperties": false,
"properties": {
"registrationId": {
"type": "string"
},
"hostname": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"expectedRevision": {
"type": "integer",
"format": "int64"
}
},
"required": [
"registrationId",
"hostname",
"primary",
"expectedRevision"
]
}HostnameBinding
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"pending",
"ready",
"failed",
"retiring",
"retired"
]
},
"revision": {
"type": "integer",
"format": "int64"
},
"reason": {
"type": "string"
}
},
"required": [
"id",
"hostname",
"primary",
"state",
"revision",
"reason"
]
}StartWorkspace
{
"type": "object",
"additionalProperties": false,
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64"
},
"sourceRevision": {
"type": "string"
}
},
"required": [
"expectedRevision",
"sourceRevision"
]
}Workspace
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pending",
"starting",
"ready",
"stopped",
"failed"
]
},
"sourceRevision": {
"type": "string"
},
"url": {
"type": "string"
},
"operationId": {
"type": "string"
}
},
"required": [
"id",
"state",
"sourceRevision",
"url",
"operationId"
]
}ExpectedRevision
{
"type": "object",
"additionalProperties": false,
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64"
}
},
"required": [
"expectedRevision"
]
}WriteWorkspace
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision",
"path",
"content"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"path": {
"type": "string",
"description": "Safe relative UTF-8 source file path. Engine, secret, generated and dependency paths are denied."
},
"content": {
"type": "string",
"description": "UTF-8 source content, bounded by the registered source byte budget."
}
}
}PlacementResources
{
"type": "object",
"additionalProperties": false,
"required": [
"millicpu",
"memoryBytes",
"storageBytes"
],
"properties": {
"millicpu": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"memoryBytes": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"storageBytes": {
"type": "integer",
"format": "int64",
"minimum": 0
}
}
}PlacementDesired
{
"type": "object",
"additionalProperties": false,
"required": [
"capacityProfile",
"location",
"standbyLocation",
"runtimeMode"
],
"properties": {
"capacityProfile": {
"type": "string"
},
"location": {
"type": "string",
"description": "Exact registered location, or empty for stable automatic selection."
},
"standbyLocation": {
"type": "string",
"description": "Exact optional recovery location, or empty for no standby."
},
"runtimeMode": {
"type": "string",
"enum": [
"onDemand",
"alwaysOn"
]
}
}
}ChangePlacement
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision",
"policyRevision",
"desired"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"policyRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"desired": {
"$ref": "#/components/schemas/PlacementDesired"
}
}
}PlacementState
{
"type": "object",
"additionalProperties": false,
"required": [
"revision",
"epoch",
"desired",
"effectiveCell",
"effectiveLocation",
"effectiveProfile",
"operationId",
"phase",
"reason",
"standbyCell",
"protection",
"reserved"
],
"properties": {
"revision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"epoch": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"desired": {
"$ref": "#/components/schemas/PlacementDesired"
},
"effectiveCell": {
"type": "string"
},
"effectiveLocation": {
"type": "string"
},
"effectiveProfile": {
"type": "string"
},
"operationId": {
"type": "string"
},
"phase": {
"type": "string",
"enum": [
"pending",
"ready",
"draining",
"fenced",
"copying",
"verified",
"committed",
"routing",
"waiting"
]
},
"reason": {
"type": "string"
},
"standbyCell": {
"type": "string"
},
"protection": {
"type": "string",
"enum": [
"none",
"pending",
"snapshot-ready",
"degraded"
]
},
"reserved": {
"$ref": "#/components/schemas/PlacementResources"
},
"recoveryPoint": {
"$ref": "#/components/schemas/PlacementRecoveryPoint"
},
"capacity": {
"$ref": "#/components/schemas/PlacementCapacity"
}
}
}PlacementLocation
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"geographicGroup",
"profiles",
"healthy"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"geographicGroup": {
"type": "string"
},
"profiles": {
"type": "array",
"items": {
"type": "string"
}
},
"healthy": {
"type": "boolean"
}
}
}PlacementRecoveryPoint
{
"type": "object",
"additionalProperties": false,
"required": [
"cell",
"capturedAt"
],
"properties": {
"cell": {
"type": "string"
},
"capturedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Verified point-in-time recovery package. This does not imply continuous replication or automatic failover."
}IdentityBlockSpec
{
"type": "object",
"additionalProperties": false,
"required": [
"redirects",
"accessPolicyRef"
],
"properties": {
"redirects": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"minItems": 1
},
"accessPolicyRef": {
"type": "string"
}
}
}ScheduleBlockSpec
{
"type": "object",
"additionalProperties": false,
"required": [
"jobsResourceId",
"taskDefinitionRef",
"cron",
"timeZone",
"enabled",
"concurrencyPolicy",
"missedRunPolicy"
],
"properties": {
"jobsResourceId": {
"type": "string"
},
"taskDefinitionRef": {
"type": "string"
},
"cron": {
"type": "string"
},
"timeZone": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"concurrencyPolicy": {
"type": "string",
"enum": [
"forbid"
]
},
"missedRunPolicy": {
"type": "string",
"enum": [
"skip"
]
}
}
}BuildingBlockSpec
{
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"profileId"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"identity",
"storage",
"jobs",
"schedule"
]
},
"profileId": {
"type": "string"
},
"identity": {
"$ref": "#/components/schemas/IdentityBlockSpec"
},
"schedule": {
"$ref": "#/components/schemas/ScheduleBlockSpec"
}
}
}CreateBuildingBlock
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision",
"expectedEnvironmentKind",
"spec"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"expectedEnvironmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"spec": {
"$ref": "#/components/schemas/BuildingBlockSpec"
},
"restoreRef": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Installation-registered verified storage import for this exact target environment. Only storage blocks support restore; destination login proof is required and grants are not copied."
}
}
}BuildingBlockBinding
{
"type": "object",
"additionalProperties": false,
"required": [
"resourceId",
"endpoint",
"authorityId"
],
"properties": {
"resourceId": {
"type": "string"
},
"endpoint": {
"type": "string",
"format": "uri"
},
"authorityId": {
"type": "string"
},
"namespace": {
"type": "string"
}
}
}BuildingBlock
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"kind",
"profileId",
"state",
"revision",
"binding"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"identity",
"storage",
"jobs",
"schedule"
]
},
"profileId": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pending",
"ready",
"retained",
"failed"
]
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"binding": {
"$ref": "#/components/schemas/BuildingBlockBinding"
}
}
}CreateJobRun
{
"type": "object",
"additionalProperties": false,
"required": [
"jobsResourceId",
"taskDefinitionRef",
"expectedEnvironmentKind",
"payload"
],
"properties": {
"jobsResourceId": {
"type": "string"
},
"taskDefinitionRef": {
"type": "string"
},
"expectedEnvironmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"payload": {
"type": "object",
"additionalProperties": true
}
}
}ServiceBinding
{
"type": "object",
"additionalProperties": false,
"required": [
"resourceId",
"endpoint",
"authorityId",
"cellId",
"locationId",
"environmentId",
"environmentKind"
],
"properties": {
"resourceId": {
"type": "string"
},
"endpoint": {
"type": "string",
"format": "uri"
},
"authorityId": {
"type": "string"
},
"cellId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"environmentId": {
"type": "string"
},
"environmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
}
}
}ServiceBindings
{
"type": "object",
"additionalProperties": false,
"properties": {
"identity": {
"$ref": "#/components/schemas/ServiceBinding"
},
"storage": {
"$ref": "#/components/schemas/ServiceBinding"
},
"jobs": {
"$ref": "#/components/schemas/ServiceBinding"
}
}
}CreateStorageUpload
{
"type": "object",
"additionalProperties": false,
"required": [
"sizeBytes",
"sha256",
"contentType",
"filename"
],
"properties": {
"sizeBytes": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"contentType": {
"type": "string"
},
"filename": {
"type": "string"
}
}
}StorageObject
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"resourceId",
"sizeBytes",
"sha256",
"contentType",
"filename",
"state",
"retainUntil"
],
"properties": {
"id": {
"type": "string"
},
"resourceId": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"contentType": {
"type": "string"
},
"filename": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pending",
"ready",
"deleting",
"deleted"
]
},
"retainUntil": {
"type": "string",
"format": "date-time"
}
}
}StorageReference
{
"type": "object",
"additionalProperties": false,
"required": [
"referenceId"
],
"properties": {
"referenceId": {
"type": "string"
}
}
}ApplicationJobRun
{
"type": "object",
"additionalProperties": false,
"required": [
"taskDefinitionRef",
"expectedEnvironmentKind",
"payload"
],
"properties": {
"taskDefinitionRef": {
"type": "string"
},
"expectedEnvironmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"payload": {
"type": "object",
"additionalProperties": true
}
}
}JobRunState
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"operationId",
"taskDefinitionRef",
"state",
"errorCode",
"attempts"
],
"properties": {
"id": {
"type": "string"
},
"operationId": {
"type": "string"
},
"taskDefinitionRef": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"waiting",
"succeeded",
"failed"
]
},
"errorCode": {
"type": "string"
},
"attempts": {
"type": "integer"
}
}
}Environment
{
"type": "object",
"required": [
"id",
"projectId",
"name",
"kind",
"revision"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"projectId": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"revision": {
"type": "integer",
"format": "int64"
}
}
}ServiceSession
{
"type": "object",
"additionalProperties": false,
"required": [
"resourceId",
"token"
],
"properties": {
"resourceId": {
"type": "string"
},
"token": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
}ServiceSessions
{
"type": "object",
"additionalProperties": false,
"properties": {
"storage": {
"$ref": "#/components/schemas/ServiceSession"
},
"jobs": {
"$ref": "#/components/schemas/ServiceSession"
}
}
}UpdateSchedule
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision",
"expectedEnvironmentKind",
"spec"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"expectedEnvironmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"spec": {
"$ref": "#/components/schemas/ScheduleBlockSpec"
}
}
}Schedule
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"revision",
"state",
"spec"
],
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int64"
},
"state": {
"type": "string",
"enum": [
"pending",
"ready",
"retained",
"failed"
]
},
"spec": {
"$ref": "#/components/schemas/ScheduleBlockSpec"
}
}
}Project
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"revision"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 1
}
}
}Repository
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"projectId",
"profileId",
"revision",
"state",
"nativeId",
"cloneUrl"
],
"properties": {
"id": {
"type": "string"
},
"projectId": {
"type": "string"
},
"profileId": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"state": {
"type": "string",
"enum": [
"pending",
"ready",
"retained",
"failed"
]
},
"nativeId": {
"type": "integer",
"format": "int64"
},
"cloneUrl": {
"type": "string"
}
}
}CreateRepository
{
"type": "object",
"additionalProperties": false,
"required": [
"expectedRevision",
"profileId"
],
"properties": {
"expectedRevision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"profileId": {
"type": "string"
}
}
}CatalogEntry
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
}
}CatalogEntryPage
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogEntry"
}
},
"nextCursor": {
"type": "string",
"description": "Opaque collection/scope-bound continuation; empty when complete."
}
}
}ProjectPage
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
},
"nextCursor": {
"type": "string",
"description": "Opaque collection/scope-bound continuation; empty when complete."
}
}
}EnvironmentPage
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Environment"
}
},
"nextCursor": {
"type": "string",
"description": "Opaque collection/scope-bound continuation; empty when complete."
}
}
}BuildingBlockPage
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildingBlock"
}
},
"nextCursor": {
"type": "string",
"description": "Opaque scoped continuation; empty string marks the last page."
}
}
}OperationPage
{
"type": "object",
"additionalProperties": false,
"required": [
"items",
"nextCursor"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"nextCursor": {
"type": "string",
"description": "Opaque scoped continuation; empty string marks the last page."
}
}
}ArchiveScope
{
"type": "object",
"additionalProperties": false,
"required": [
"product",
"tenant",
"project",
"environment"
],
"properties": {
"product": {
"type": "string",
"minLength": 1
},
"tenant": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"minLength": 1
},
"environment": {
"type": "string",
"minLength": 1
}
}
}ArchiveComponent
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"kind",
"sha256",
"bytes",
"nativeFormat"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$"
},
"kind": {
"type": "string",
"enum": [
"metadata",
"database",
"file",
"identity",
"jobs",
"artifact",
"repository",
"workspace"
]
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"format": "int64",
"minimum": 0
},
"nativeFormat": {
"type": "string",
"minLength": 1
}
}
}ArchiveResource
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"kind",
"componentIds"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"environment",
"database",
"storage",
"identity",
"jobs",
"schedule",
"runtime",
"repository",
"workspace"
]
},
"componentIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
}
}
}EnvironmentArchive
{
"type": "object",
"additionalProperties": false,
"required": [
"format",
"scope",
"environmentKind",
"revision",
"placementEpoch",
"capturedAt",
"platformRevision",
"components",
"resources"
],
"properties": {
"format": {
"type": "string",
"enum": [
"astrogate.environment.v1"
]
},
"scope": {
"$ref": "#/components/schemas/ArchiveScope"
},
"environmentKind": {
"type": "string",
"enum": [
"preview",
"staging",
"production"
]
},
"revision": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"placementEpoch": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"capturedAt": {
"type": "string",
"format": "date-time"
},
"platformRevision": {
"type": "string",
"pattern": "^[a-f0-9]{40}$"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArchiveComponent"
},
"minItems": 1
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArchiveResource"
},
"minItems": 1
}
}
}PlacementCapacity
{
"type": "object",
"additionalProperties": false,
"required": [
"maximum",
"required",
"evidence",
"cellCostMicrosPerHour"
],
"properties": {
"maximum": {
"$ref": "#/components/schemas/PlacementResources"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"evidence": {
"type": "string"
},
"cellCostMicrosPerHour": {
"type": "integer",
"format": "int64",
"minimum": 0,
"description": "Registered full-cell infrastructure cost, not an environment invoice or apportioned tenant cost."
},
"highWater": {
"$ref": "#/components/schemas/PlacementUsage"
}
}
}PlacementUsage
{
"type": "object",
"additionalProperties": false,
"required": [
"resources",
"validUntil",
"fresh"
],
"properties": {
"resources": {
"$ref": "#/components/schemas/PlacementResources"
},
"validUntil": {
"type": "string",
"format": "date-time"
},
"fresh": {
"type": "boolean"
}
},
"description": "Epoch-bound high-water observation. Absence means unknown; fresh false preserves explicitly stale evidence."
}OperatorOperationDetail
{
"type": "object",
"additionalProperties": false,
"required": [
"operation",
"logKinds"
],
"properties": {
"operation": {
"$ref": "#/components/schemas/Operation"
},
"logKinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationLogKind"
}
}
}
}OperationLogKind
{
"type": "string",
"enum": [
"build",
"execution"
]
}TopologyHost
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"providerId",
"architecture",
"operatingSystem",
"kubeletVersion",
"containerRuntimeVersion",
"ready"
],
"properties": {
"name": {
"type": "string"
},
"providerId": {
"type": "string"
},
"architecture": {
"type": "string"
},
"operatingSystem": {
"type": "string"
},
"kubeletVersion": {
"type": "string"
},
"containerRuntimeVersion": {
"type": "string"
},
"ready": {
"type": "boolean"
}
}
}TopologyTarget
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"node",
"service",
"ready"
],
"properties": {
"name": {
"type": "string"
},
"node": {
"type": "string"
},
"service": {
"type": "string"
},
"ready": {
"type": "boolean"
}
}
}EnvironmentTopology
{
"type": "object",
"additionalProperties": false,
"required": [
"cell",
"epoch",
"hosts",
"targets",
"observedAt",
"validUntil",
"fresh"
],
"properties": {
"cell": {
"type": "string"
},
"epoch": {
"type": "integer",
"format": "int64",
"minimum": 1
},
"hosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopologyHost"
}
},
"targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopologyTarget"
}
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"validUntil": {
"type": "string",
"format": "date-time"
},
"fresh": {
"type": "boolean"
}
}
}HostnameBindingPage
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HostnameBinding"
}
},
"nextCursor": {
"type": "string"
}
},
"required": [
"items",
"nextCursor"
]
}Authentication schemes
{
"managementToken": {
"type": "http",
"scheme": "bearer",
"description": "32 random bytes encoded as 64 hex characters, registered only for this management API."
},
"hostedSession": {
"type": "apiKey",
"in": "cookie",
"name": "installation-configured-session",
"description": "The installed identity authority chooses the cookie names; this descriptor is not a fixed cookie contract."
},
"applicationSession": {
"type": "apiKey",
"in": "cookie",
"name": "installation-defined-native-Better-Auth-session",
"description": "Native authority session plus independently registered technical block grant. A cookie alone grants no block access."
},
"blockSession": {
"type": "http",
"scheme": "bearer",
"description": "Opaque token scoped to one resource. Native user session and grant revocation are checked on every use."
},
"operatorToken": {
"type": "http",
"scheme": "bearer",
"description": "Installation-issued read-only operator credential, independently scoped to approved product IDs. Product/service and app-use tokens are rejected."
}
}