Skip to main content
GET
/
v1
/
actuator
/
info
{
  "version": "<string>",
  "gitCommit": "<string>",
  "readonly": true,
  "saas": true,
  "demo": true,
  "host": "<string>",
  "port": "<string>",
  "externalUrl": "<string>",
  "needAdminSetup": true,
  "disallowSignup": true,
  "lastActiveTime": "2023-11-07T05:31:56Z",
  "require2fa": true,
  "workspaceId": "<string>",
  "debug": true,
  "unlicensedFeatures": [
    "<string>"
  ],
  "disallowPasswordSignin": true,
  "passwordRestriction": {
    "minLength": 123,
    "requireNumber": true,
    "requireLetter": true,
    "requireUppercaseLetter": true,
    "requireSpecialCharacter": true,
    "requireResetPasswordForFirstLogin": true,
    "passwordRotation": "<string>"
  },
  "docker": true,
  "userStats": [
    {
      "userType": "USER_TYPE_UNSPECIFIED",
      "state": "STATE_UNSPECIFIED",
      "count": 123
    }
  ],
  "activatedInstanceCount": 123,
  "totalInstanceCount": 123,
  "enableSample": true
}

Response

OK

System information and configuration for the Bytebase instance. Actuator concept is similar to the Spring Boot Actuator.

​
version
string

The Bytebase server version.

​
gitCommit
string

The git commit hash of the build.

​
readonly
boolean

Whether the Bytebase instance is running in read-only mode.

​
saas
boolean

Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users.

​
demo
boolean

Whether the Bytebase instance is running in demo mode.

​
host
string

The host address of the Bytebase instance.

​
port
string

The port number of the Bytebase instance.

​
externalUrl
string

The external URL where users or webhook callbacks access Bytebase.

​
needAdminSetup
boolean

Whether the Bytebase instance requires initial admin setup.

​
disallowSignup
boolean

Whether self-service user signup is disabled.

​
lastActiveTime
string<date-time>

The last time any API call was made, refreshed on each request.

​
require2fa
boolean

Whether two-factor authentication is required for all users.

​
workspaceId
string

The unique identifier for the workspace.

​
debug
boolean

Whether debug mode is enabled.

​
unlicensedFeatures
string[]

List of features that are not licensed.

​
disallowPasswordSignin
boolean

Whether password-based signin is disabled (except for workspace admins).

​
passwordRestriction
object

Password complexity and restriction requirements.

​
docker
boolean

Whether the Bytebase instance is running in Docker.

​
userStats
object[]

Statistics about users in the system.

​
activatedInstanceCount
integer

The number of activated database instances.

​
totalInstanceCount
integer

The total number of database instances.

​
enableSample
boolean

Whether sample data setup is enabled.