Configs

Get Configurations

Get detailed list of existing configurations

GET/api/v4.0/conf/configs

Response

200

List of configurations was retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of Meta

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/configs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "total": 1,
  "items": [
    {
      "date": "2024-11-21T06:31:16.592Z",
      "description": "text",
      "id": "text",
      "logs": [
        {
          "date": "2024-11-21T06:31:16.592Z",
          "version": "text"
        }
      ],
      "version": "text"
    }
  ]
}

Get a Configuration

Retrieve a complete configuration

GET/api/v4.0/conf/configs/{config}

Path parameters

config*Config

Response

200422

Configuration retrieved successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/configs/{config}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get Versions of a Config

Get all versions of a given configuration

GET/api/v4.0/conf/configs/{config}/versions

Path parameters

config*Config

Response

200422

Config versions retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/configs/{config}/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-11-21T06:31:16.592Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Revert a Config to a Version

Set a previous version of a configuration to be the current one

PUT/api/v4.0/conf/configs/{config}/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

200422

Configuration reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/configs/{config}/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}