System API

1 endpoint, generated from packages/core/openapi/v1.snapshot.json (OpenAPI 3.1.0, contract version 1.0). Conventions for lists, errors, money and authentication are on the API conventions page.

GET/api/v1/system/status

System status for owners

Version, database and migration state, last backup, disk space, and how this request reached the server (client IP, scheme, trusted proxy). Owners only; read-only.

Access

Any signed-in member (own data only)

Responses

200 Success. object

• versionstringrequired
• timestringrequired
• publicUrlstring | nullrequired
• secureCookiesboolean | nullrequired
• databaseobjectrequired

  • statusenumrequired

    one of "ok", "unreachable"

  • driverenum or nullrequired

    one of "postgres", "pglite"

  • serverVersionstring | nullrequired
• schemaobjectrequired

  • tagstring | nullrequired
  • migratedByVersionstring | nullrequired
  • migratedAtstring | nullrequired
  • appliedMigrationsinteger or nullrequired

    min -9007199254740991

  • bundledMigrationsinteger or nullrequired

    min -9007199254740991

• backupsobjectrequired

  • lastobject or nullrequired

    • idstringrequired
    • triggerenumrequired

      one of "manual", "scheduled", "pre_migrate"

    • statusenumrequired

      one of "running", "succeeded", "failed"

    • startedAtstringrequired
    • finishedAtstring | nullrequired
    • fileNamestring | nullrequired
    • sizeBytesinteger or nullrequired

      min -9007199254740991

    • encryptedbooleanrequired
    • includesKeybooleanrequired
    • errorstring | nullrequired
  • lastSuccessfulobject or nullrequired

    • idstringrequired
    • triggerenumrequired

      one of "manual", "scheduled", "pre_migrate"

    • statusenumrequired

      one of "running", "succeeded", "failed"

    • startedAtstringrequired
    • finishedAtstring | nullrequired
    • fileNamestring | nullrequired
    • sizeBytesinteger or nullrequired

      min -9007199254740991

    • encryptedbooleanrequired
    • includesKeybooleanrequired
    • errorstring | nullrequired
  • encryptedboolean | nullrequired
  • schedulestring | nullrequired
  • keepinteger or nullrequired

    min -9007199254740991

  • beforeMigrateboolean | nullrequired
  • directorystring | nullrequired
  • stalebooleanrequired
• diskarray of objectrequired

  • labelstringrequired
  • pathstringrequired
  • freeBytesnumberrequired
  • totalBytesnumberrequired
• requestobjectrequired

  • clientIpstring | nullrequired
  • peerIpstring | nullrequired
  • schemeenumrequired

    one of "http", "https"

  • hoststring | nullrequired
  • viaTrustedProxybooleanrequired
• trustedProxiesarray of string or nullrequired

• 401 session_expired, session_revoked, unauthenticated
• 403 forbidden, mfa_enrolment_required