Sign in
system

Get Application Information

Changed on

Retrieves current application version and status information including setup state

get/bodhi/v1/info

Request

  • Base URL: http://localhost:1135
  • URL: http://localhost:1135/bodhi/v1/info
  • Auth: none declared

Response

Application information retrieved successfully

versionstring required

Application version number (semantic versioning)

commit_shastring required

Git commit SHA of the build

status'setup' | 'ready' | 'resource_admin' required
deployment'standalone' | 'multi_tenant' required
client_idstring nullable

Active tenant's OAuth client_id (present when authenticated with an active tenant)

urlstring required

Public URL of the server

url_publicboolean required

Whether url is reachable from the public internet. Declared by the deployment through BODHI_PUBLIC_URL_REACHABLE; false unless explicitly set. A third-party backend uses this to decide whether it can call this instance directly or must go through remote_access.

reference_api_urlstring required

Base URL of the external reference API the frontend calls directly (configurable via BODHI_REFERENCE_API_URL, env-overridable for tests)

Example response

{
  "client_id": "my-client-id",
  "commit_sha": "abc1234",
  "deployment": "standalone",
  "reference_api_url": "https://api.getbodhi.app",
  "status": "ready",
  "url": "https://example.com",
  "url_public": false,
  "version": "0.1.0"
}

Changes

  • fdae2474a8deRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 4d4ee0c37d75Revision changes
    • info

      added the required property to the response with the status