API service information and version details
Get Access Mode
Returns the current access mode, the modes available to switch to, and any pending transition. Always reachable — works while unregistered, unlicensed, or in ReadOnly.
Get Access Mode › Responses
Returns the current access mode
accessModeCurrent operational mode of the API.
availableAccessModesThe access modes the API can currently operate in — i.e. which
targets POST /service/access-mode can be expected to accept.
pendingAccessModeCurrent operational mode of the API.
reasonIfAccessModePendingHuman-readable explanation of the pending access-mode transition (e.g. "Job open — release on close").
Set Access Mode
Transitions the API between ReadWrite and ReadOnly.
When switching to ReadOnly with a job open, the transition
is queued and returns 202 — the switch commits when the job
closes. When switching to ReadWrite the API attempts to
re-acquire MODULE_API_ID; a failure returns 409 and leaves the
access mode unchanged.
Set Access Mode › Request Body
accessModeCurrent operational mode of the API.
Set Access Mode › Responses
Access mode transitioned successfully; returns the updated access mode
accessModeCurrent operational mode of the API.
availableAccessModesThe access modes the API can currently operate in — i.e. which
targets POST /service/access-mode can be expected to accept.
pendingAccessModeCurrent operational mode of the API.
reasonIfAccessModePendingHuman-readable explanation of the pending access-mode transition (e.g. "Job open — release on close").
Get Service Info
Returns static identity information about the API instance — its base URL and the SPACE GASS version. Always reachable, including while unregistered or unlicensed.
Get Service Info › Responses
Returns the service info
apiPathThe API base URL (scheme, host, and path base).
spaceGassVersionSPACE GASS version number in format "X.XX.XXXX (ProgramType)".