Sign in
Misc

Retrieve the instance configuration.

Changed on

Global endpoint available to all users.

get/api/v1/configs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/configs
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Response

getConfiguration 200 response

uuidstring
versionstring
edition'OSS' | 'EE'
commitIdstring
chartDefaultDurationstring
commitDatestring date-time
isCustomDashboardsEnabledboolean
isAnonymousUsageEnabledboolean
isUiAnonymousUsageEnabledboolean
isTemplateEnabledboolean
urlstring
systemNamespacestring
hiddenLabelsPrefixesstring[]
isAiEnabledboolean
isBasicAuthInitializedboolean
pluginsHashinteger
isConcurrencyViewEnabledboolean
secretsEnabledboolean
pluginManagementEnabledboolean
pluginCustomEnabledboolean
mailServiceEnabledboolean
outputsInInternalStorageEnabledboolean
inMaintenanceboolean
passwordRegexpstring
passwordlessEnabledboolean
airgappedboolean
featureGatingboolean
featuresstring[]

Example response

{
  "preview": {
    "initial": 0,
    "max": 6
  },
  "isBasicAuthInitialized": true,
  "passwordlessEnabled": true,
  "inMaintenance": true,
  "edition": "OSS",
  "pluginManagementEnabled": true,
  "isConcurrencyViewEnabled": true,
  "uuid": "uuid",
  "pluginsHash": 1,
  "killSwitches": [
    {
      "evaluationType": "PASS",
      "executionIds": [
        "executionIds",
        "executionIds"
      ],
      "deleted": true,
      "endDate": "2000-01-23T04:56:07.000+00:00",
      "name": "name",
      "tenantId": "tenantId",
      "namespace": "namespace",
      "description": "description",
      "id": "id",
      "flowId": "flowId",
      "startDate": "2000-01-23T04:56:07.000+00:00",
      "enabled": true
    },
    {
      "evaluationType": "PASS",
      "executionIds": [
        "executionIds",
        "executionIds"
      ],
      "deleted": true,
      "endDate": "2000-01-23T04:56:07.000+00:00",
      "name": "name",
      "tenantId": "tenantId",
      "namespace": "namespace",
      "description": "description",
      "id": "id",
      "flowId": "flowId",
      "startDate": "2000-01-23T04:56:07.000+00:00",
      "enabled": true
    }
  ],
  "isCustomDashboardsEnabled": true,
  "featureGating": true,
  "leftSidebar": {
    "disabledMenus": [
      "disabledMenus",
      "disabledMenus"
    ]
  },
  "features": [
    "features",
    "features"
  ],
  "outputsInInternalStorageEnabled": true,
  "supportedStorages": [
    {
      "id": "id",
      "version": "version"
    },
    {
      "id": "id",
      "version": "version"
    }
  ],
  "isUiAnonymousUsageEnabled": true,
  "mailServiceEnabled": true,
  "pluginCustomEnabled": true,
  "airgapped": true,
  "supportedSecrets": [
    {
      "id": "id",
      "version": "version"
    },
    {
      "id": "id",
      "version": "version"
    }
  ],
  "isAiEnabled": true,
  "tenants": {
    "secretByTenant": true,
    "storageByTenant": true
  },
  "hiddenLabelsPrefixes": [
    "hiddenLabelsPrefixes",
    "hiddenLabelsPrefixes"
  ],
  "banner": {
    "endDate": "2000-01-23T04:56:07.000+00:00",
    "tenantId": "tenantId",
    "active": true,
    "id": "id",
    "message": "message",
    "type": "INFO",
    "startDate": "2000-01-23T04:56:07.000+00:00"
  },
  "commitId": "commitId",
  "isAnonymousUsageEnabled": true,
  "version": "version",
  "rightSidebar": {
    "customLinks": {
      "key": {
        "title": "title",
        "url": "url"
      }
    }
  },
  "passwordRegexp": "passwordRegexp",
  "url": "url",
  "commitDate": "2000-01-23T04:56:07.000+00:00",
  "environment": {
    "color": "color",
    "name": "name"
  },
  "chartDefaultDuration": "chartDefaultDuration",
  "secretsEnabled": true,
  "isTemplateEnabled": true,
  "systemNamespace": "systemNamespace"
}

Changes