System

Generated system operations.

GET/v1/systemRead systemopen

Audience: Integrations · Native API
Authorization: No credential needed
OpenAPI operation ID: get_system

Responses

200Successapplication/json

Example

{
  "apiLevel": 0,
  "apiMajors": [
    0
  ],
  "apiVersion": "string",
  "capabilities": [
    "string"
  ],
  "hostedAttached": true,
  "hostedConfigured": true,
  "id": "id_8h2k4q",
  "move": "to_portico",
  "moveEndsAt": "2026-10-18T19:30:00Z",
  "name": "Fargo",
  "setupRequired": true,
  "signIn": "portico",
  "version": "string"
}

Schema

apiLevelintegerrequired
apiMajorsarray of integerrequired
apiVersionstringrequired
capabilitiesarray of stringrequired
hostedAttachedbooleanrequired
hostedConfiguredbooleanrequired
idstringrequired
movestring | any | nullrequired
moveEndsAtstring | any | nullrequired
namestringrequired
setupRequiredbooleanrequired
signInstringrequiredone of "portico", "local"
versionstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/system"