ReferenceApi

Application access 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.

POST exchangeDatabaseSession

POST /v1/database/session

Server-only data-gateway exchange. The verified service credential needs database.session.issue plus an exact registered actor/app binding. The configured authority validates the forwarded cookie and native app grants still apply. A customer cookie domain never needs to cover the infrastructure domain.

Authentication: managementToken.

Request body (required):

ResponseMeaningBody
200Scoped native application sessionapplication/json: DatabaseSessionToken
401Credential, issuer binding or authority session deniedNo documented body
503Configured authority, native engine or secret store unavailableNo documented body

POST probeDatabase

POST /v1/database/probe

Server-only scoped probe of the registered native app credential and SQL/schema access. No customer records or secrets are returned.

Authentication: managementToken.

Request body (required):

ResponseMeaningBody
200Registered app is reachableapplication/json: DatabaseProbe
401Scoped observer deniedNo documented body
503Native dependency unavailableNo documented body

POST createHostedDatabaseSession

POST /__astrogate/database-session

Issue an existing native database session for the exact protected application hostname and authenticated application user. No management credential is accepted.

Authentication: hostedSession.

ResponseMeaningBody
200Native application-scoped sessionapplication/json: DatabaseSessionToken
401Application authentication requiredNo documented body
403Application/database scope deniedNo documented body

POST reserveStorageUpload

POST /v1/storage/{blockId}/uploads

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
Idempotency-KeyheaderYes{"type":"string"}

Request body (required):

ResponseMeaningBody
201Scoped application resultapplication/json: StorageObject
defaultScoped access or engine failureapplication/json: Error

PUT uploadStorageObject

PUT /v1/storage/{blockId}/objects/{objectId}

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}

Request body (required):

  • application/octet-stream: {"type":"string","format":"binary"}
ResponseMeaningBody
200Scoped application resultapplication/json: StorageObject
defaultScoped access or engine failureapplication/json: Error

GET downloadStorageObject

GET /v1/storage/{blockId}/objects/{objectId}

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}
ResponseMeaningBody
200Scoped streaming downloadapplication/octet-stream: {"type":"string","format":"binary"}
defaultScoped access or engine failureapplication/json: Error

DELETE deleteStorageObject

DELETE /v1/storage/{blockId}/objects/{objectId}

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}
ResponseMeaningBody
204CompletedNo documented body
defaultScoped access or engine failureapplication/json: Error

GET getStorageObject

GET /v1/storage/{blockId}/objects/{objectId}/metadata

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}
ResponseMeaningBody
200Scoped application resultapplication/json: StorageObject
defaultScoped access or engine failureapplication/json: Error

POST attachStorageReference

POST /v1/storage/{blockId}/objects/{objectId}/references

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}

Request body (required):

ResponseMeaningBody
204CompletedNo documented body
defaultScoped access or engine failureapplication/json: Error

DELETE detachStorageReference

DELETE /v1/storage/{blockId}/objects/{objectId}/references

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
objectIdpathYes{"type":"string"}

Request body (required):

ResponseMeaningBody
204CompletedNo documented body
defaultScoped access or engine failureapplication/json: Error

POST runApplicationJob

POST /v1/jobs/{blockId}/runs

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
Idempotency-KeyheaderYes{"type":"string"}

Request body (required):

ResponseMeaningBody
202Scoped application resultapplication/json: Accepted
defaultScoped access or engine failureapplication/json: Error

GET getApplicationJobRun

GET /v1/jobs/{blockId}/runs/{runId}

Authentication: applicationSession or blockSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
runIdpathYes{"type":"string"}
ResponseMeaningBody
200Scoped application resultapplication/json: JobRunState
defaultScoped access or engine failureapplication/json: Error

POST issueStorageSession

POST /v1/storage/{blockId}/session

Authentication: applicationSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
ResponseMeaningBody
200Resource-bound session, never the native login cookieapplication/json: ServiceSession
defaultAccess or authority failureapplication/json: Error

POST issueJobsSession

POST /v1/jobs/{blockId}/session

Authentication: applicationSession.

ParameterLocationRequiredType
blockIdpathYes{"type":"string"}
ResponseMeaningBody
200Resource-bound session, never the native login cookieapplication/json: ServiceSession
defaultAccess or authority failureapplication/json: Error

SDK and API entrypoints

Previous Page

Management HTTP API

Next Page

On this page

POST exchangeDatabaseSessionPOST probeDatabasePOST createHostedDatabaseSessionPOST reserveStorageUploadPUT uploadStorageObjectGET downloadStorageObjectDELETE deleteStorageObjectGET getStorageObjectPOST attachStorageReferenceDELETE detachStorageReferencePOST runApplicationJobGET getApplicationJobRunPOST issueStorageSessionPOST issueJobsSession