/api/v1/settings

Unauthenticated endpoint reporting brief information about the running fylr instance: version, instance name, build details, Elastic index_names and license-derived capabilities. The current system status is returned in the x-fylr-status response header, which makes this path usable as a liveness/status probe.

GET /settings — Get all settings

Get all settings

get

This settings endpoint is unprotected and delivers brief information about the running fylr instance. It can also be used to check the current status of the running fylr (no authentication required; suitable for liveness/status probes).

Differs from easydb 5: the response has no api field (easydb 5 reports an api API-version number); fylr exposes only the version family (version, version_release_date, version_full).

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Responses

200

Brief information about the running fylr.

application/json

200

Brief information about the running fylr.

{
  "name": "fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b",
  "config_name": "fylr apitest",
  "startup_time": "2023-03-20T15:31:28Z",
  "instance": "apitest",
  "version": "v6.2.6",
  "external_url": "http://fylr.localhost",
  "build_commit": "b83beb3f03f541c5c2ee8cc58d5bb17bfe4ab2b0",
  "build_commit_time": "2023-03-20T13:35:26Z",
  "index_names": {
    "BaseRead": "apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-base-1",
    "BaseWrite": "apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-base-1",
    "ObjectRead": "apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-object-1",
    "ObjectWrite": "apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-object-1"
  },
  "capabilities": {
    "indexer_vendor": "Elasticsearch",
    "indexer_geo_support": false
  }
}