Meta

Returns the backend's settings information.

GEThttps://api.example.com/api/v1/settings

Response

200default

Successfully returns application settings response.

Body

application/json

api*APIConfig (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.example.com/api/v1/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "api": {
    "saml": {
      "user_creation_mode": "manual",
      "users_group_membership_management_mode": "manual"
    }
  }
}

Returns the backend's meta information.

GEThttps://api.example.com/api/v1/meta-info

Response

200default

Happy response.

Body

application/json

version*string

Is set to the HQ build version.

build_id*string

Is set to the HQ build id.

backend_build_id*string

Is set to the HQ backend build id.

ui_build_id*string

Is set to the HQ UI build id.

goos*string

Equals runtime.GOOS.

goarch*string

Equals runtime.GOARCH.

started_at*string (date-time)

Is set to the instant the backend started.

memstats_alloc*integer (int64)

Equals runtime.Memstats.Alloc.

memstats_sys*integer (int64)

Equals runtime.Memstats.Sys.

gc_cpu_fraction*number

Equals runtime.Memstats.GCCPUFraction.

num_goroutine*integer (int32)

Equals runtime.NumGoroutine().

Request

JavaScriptCurlPython

const response = await fetch('https://api.example.com/api/v1/meta-info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "version": "text",
  "build_id": "text",
  "backend_build_id": "text",
  "ui_build_id": "text",
  "goos": "text",
  "goarch": "text",
  "started_at": "2025-01-17T13:58:02.370Z",
  "memstats_alloc": 0,
  "memstats_sys": 0,
  "gc_cpu_fraction": 0,
  "num_goroutine": 0
}