Time settings

Control time settings of the system

API

• Get available timezones of the system:

  • Path: /api/system/time/timezones

  • Method: GET

  • Minimum user role: admin

  • Response:

    [
      {
        "id": "Africa/Harare",
        "code": "ZW",
        "coordinates": "-1750+03103",
        "description": ""
      },
      {
        "id": "Africa/Johannesburg",
        "code": "ZA",
        "coordinates": "-2615+02800",
        "description": ""
      }
    ]

• Get the current time settings of the system:

  • Path: /api/system/time

  • Method: GET

  • Minimum user role: viewer

  • Response:

    {
      "time": 1675090550,
      "timezone_id": "Europe/Amsterdam",
      "ntp_enabled": true,
      "ntp_servers": [
          "0.ubuntu.pool.ntp.org"
      ]
    }

• Change time settings of the system:

  • Path: /api/system/time

  • Method: PUT

  • Minimum user role: admin

  • Request body:

    {
      "time": 1675090550,
      "timezone_id": "Europe/Amsterdam",
      "ntp_enabled": true,
      "ntp_servers": [
          "0.ubuntu.pool.ntp.org"
      ]
    }

    • timezone_id must be one of id-s of response of /time/timezones request; if empty value is passed, it will default to UTC

Back to System