v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
Settings

List all settings

Get the current value of all the settings

get/settings

Response

Settings

result'success' | 'error' required

Result of the request

action'getAllSettings' required

The id of the action

Example response

{
  "data": {
    "settings": {
      "allowed_networks": [
        {
          "id": "root",
          "allowed_networks": [
            "192.168.40.0/24"
          ]
        }
      ],
      "global_policy_mode": "enforce",
      "global_policy_mode_overridable": true,
      "run_frequency": 5,
      "splay_time": 5,
      "modified_file_ttl": 7,
      "output_file_ttl": 7,
      "require_time_synchronization": true,
      "relay_server_synchronization_method": "classic",
      "relay_server_synchronize_policies": true,
      "rudder_report_protocol_default": "HTTPS",
      "reporting_mode": "full-compliance",
      "heartbeat_frequency": 10,
      "enable_change_message": true,
      "change_message_prompt": "Please provide a reason for this change",
      "enable_self_validation": true,
      "enable_self_deployment": true,
      "display_recent_changes_graphs": true,
      "enable_javascript_directives": "enabled",
      "send_metrics": "not defined",
      "node_onaccept_default_state": "enabled",
      "node_onaccept_default_policyMode": "default"
    }
  }
}