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

ServerInfo is the API message for server info. Actuator concept is similar to the Spring Boot Actuator.

version
string

version is the bytebase's server version

gitCommit
string

git_commit is the git commit hash of the build

readonly
boolean

readonly flag means if the Bytebase is running in readonly mode.

saas
boolean

saas flag means if the Bytebase is running in SaaS mode, some features are not allowed to edit by users.

demo
boolean

demo flag means if the Bytebase is running in demo mode.

host
string

host is the Bytebase instance host.

port
string

port is the Bytebase instance port.

externalUrl
string

external_url is the URL where user or webhook callback visits Bytebase.

needAdminSetup
boolean

need_admin_setup flag means the Bytebase instance doesn't have any end users.

disallowSignup
boolean

disallow_signup is the flag to disable self-service signup.

lastActiveTime
string<date-time>

last_active_time is the service last active time in UTC Time Format, any API calls will refresh this value.

require2fa
boolean

require_2fa is the flag to require 2FA for all users.

workspaceId
string

workspace_id is the identifier for the workspace.

debug
boolean

debug flag means if the debug mode is enabled.

unlicensedFeatures
string[]
disallowPasswordSignin
boolean

disallow_password_signin is the flag to disallow user signin with email&password. (except workspace admins)

passwordRestriction
object
docker
boolean

docker flag means if the Bytebase instance is running in docker.

userStats
object[]
activatedInstanceCount
integer
totalInstanceCount
integer
enableSample
boolean