Settings

System settings and preferences API

get

https://localhost:3000/apihttp://localhost:3000/api

/Settings

Returns all system settings including thresholds, configurations, and environment variables.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Settings

HTTPcURLJavaScriptPython

GET /api/Settings HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

patch

https://localhost:3000/apihttp://localhost:3000/api

/Settings/:id

Updates a specific system setting by ID.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch

/Settings/:id

HTTPcURLJavaScriptPython

PATCH /api/Settings/:id HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

No content

patch

https://localhost:3000/apihttp://localhost:3000/api

/Settings/change-multiple

Updates multiple system settings in a single request.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch

/Settings/change-multiple

HTTPcURLJavaScriptPython

PATCH /api/Settings/change-multiple HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "type": "object",
  "properties": {
    "newSettings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "examples": null
          },
          "value": {
            "type": "string",
            "examples": null
          }
        }
      }
    }
  }
}

No content

patch

https://localhost:3000/apihttp://localhost:3000/api

/Settings/change-single

Updates a single system setting by field name, supports file upload for image settings.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

multipart/form-data

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch

/Settings/change-single

HTTPcURLJavaScriptPython

PATCH /api/Settings/change-single HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 116

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "examples": null
    },
    "value": {
      "type": "string",
      "examples": null
    }
  }
}

No content