Settings

Examples

GET /api/settings
200
{
  "total": 0,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": "The default administrator email address",
      "settings_type": "string",
      "default": "root@example.com",
      "updated_at": null,
      "id": "administrator",
      "name": "administrator",
      "full_name": "Administrator email address",
      "value": "root@example.com",
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "URL where your Foreman instance is reachable (see also Provisioning > unattended_url)",
      "settings_type": "string",
      "default": "http://foreman.example.com",
      "updated_at": null,
      "id": "foreman_url",
      "name": "foreman_url",
      "full_name": "Foreman URL",
      "value": "http://foreman.example.com",
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Number of records shown per page in Foreman",
      "settings_type": "integer",
      "default": 20,
      "updated_at": null,
      "id": "entries_per_page",
      "name": "entries_per_page",
      "full_name": "Entries per page",
      "value": 20,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Should the `foreman-rake db:seed` be executed on the next run of the installer modules?",
      "settings_type": "boolean",
      "default": true,
      "updated_at": null,
      "id": "db_pending_seed",
      "name": "db_pending_seed",
      "full_name": "DB pending seed",
      "value": true,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Open and read timeout for HTTP requests from Foreman to Smart Proxy (in seconds)",
      "settings_type": "integer",
      "default": 60,
      "updated_at": null,
      "id": "proxy_request_timeout",
      "name": "proxy_request_timeout",
      "full_name": "Smart Proxy request timeout",
      "value": 60,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Text to be shown in the login-page footer. Keyword $VERSION is replaced by current version.",
      "settings_type": "string",
      "default": "Version $VERSION",
      "updated_at": null,
      "id": "login_text",
      "name": "login_text",
      "full_name": "Login page footer text",
      "value": "Version $VERSION",
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Show power status on host index page. This feature calls to compute resource providers which may lead to decreased performance on host listing page.",
      "settings_type": "boolean",
      "default": true,
      "updated_at": null,
      "id": "host_power_status",
      "name": "host_power_status",
      "full_name": "Show host power status",
      "value": true,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Set a proxy for all outgoing HTTP(S) connections from Foreman. System-wide proxies must be configured at the operating system level.",
      "settings_type": null,
      "default": null,
      "updated_at": null,
      "id": "http_proxy",
      "name": "http_proxy",
      "full_name": "HTTP(S) proxy",
      "value": null,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
      "settings_type": "array",
      "default": [],
      "updated_at": null,
      "id": "http_proxy_except_list",
      "name": "http_proxy_except_list",
      "full_name": "HTTP(S) proxy except hosts",
      "value": [],
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Whether or not to show a menu to access experimental lab features (requires reload of page)",
      "settings_type": "boolean",
      "default": false,
      "updated_at": null,
      "id": "lab_features",
      "name": "lab_features",
      "full_name": "Show Experimental Labs",
      "value": false,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Foreman will append domain names when new hosts are provisioned",
      "settings_type": "boolean",
      "default": true,
      "updated_at": null,
      "id": "append_domain_name_for_hosts",
      "name": "append_domain_name_for_hosts",
      "full_name": "Append domain names to the host",
      "value": true,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Duration in minutes after servers are classed as out of sync. This setting is overridden by specific settings from config management tools (e.g. puppet_inteval, ansible_interval).",
      "settings_type": "integer",
      "default": 30,
      "updated_at": null,
      "id": "outofsync_interval",
      "name": "outofsync_interval",
      "full_name": "Out of sync interval",
      "value": 30,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Foreman instance ID, uniquely identifies this Foreman instance.",
      "settings_type": "string",
      "default": "uuid",
      "updated_at": null,
      "id": "instance_id",
      "name": "instance_id",
      "full_name": "Foreman UUID",
      "value": "50013fae-b16d-41b7-b504-28da618f589a",
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Language to use for new users",
      "settings_type": null,
      "default": null,
      "updated_at": null,
      "id": "default_locale",
      "name": "default_locale",
      "full_name": "Default language",
      "value": null,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": {
        "": "Browser locale",
        "en": "English (United States)"
      }
    },
    {
      "description": "Timezone to use for new users",
      "settings_type": null,
      "default": null,
      "updated_at": null,
      "id": "default_timezone",
      "name": "default_timezone",
      "full_name": "Default timezone",
      "value": null,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": {
        "": "Browser timezone",
        "International Date Line West": "(GMT -12:00) International Date Line West",
        "American Samoa": "(GMT -11:00) American Samoa",
        "Midway Island": "(GMT -11:00) Midway Island",
        "Hawaii": "(GMT -10:00) Hawaii",
        "Alaska": "(GMT -09:00) Alaska",
        "Pacific Time (US & Canada)": "(GMT -08:00) Pacific Time (US & Canada)",
        "Tijuana": "(GMT -08:00) Tijuana",
        "Arizona": "(GMT -07:00) Arizona",
        "Chihuahua": "(GMT -07:00) Chihuahua",
        "Mazatlan": "(GMT -07:00) Mazatlan",
        "Mountain Time (US & Canada)": "(GMT -07:00) Mountain Time (US & Canada)",
        "Central America": "(GMT -06:00) Central America",
        "Central Time (US & Canada)": "(GMT -06:00) Central Time (US & Canada)",
        "Guadalajara": "(GMT -06:00) Guadalajara",
        "Mexico City": "(GMT -06:00) Mexico City",
        "Monterrey": "(GMT -06:00) Monterrey",
        "Saskatchewan": "(GMT -06:00) Saskatchewan",
        "Bogota": "(GMT -05:00) Bogota",
        "Eastern Time (US & Canada)": "(GMT -05:00) Eastern Time (US & Canada)",
        "Indiana (East)": "(GMT -05:00) Indiana (East)",
        "Lima": "(GMT -05:00) Lima",
        "Quito": "(GMT -05:00) Quito",
        "Atlantic Time (Canada)": "(GMT -04:00) Atlantic Time (Canada)",
        "Caracas": "(GMT -04:00) Caracas",
        "Georgetown": "(GMT -04:00) Georgetown",
        "La Paz": "(GMT -04:00) La Paz",
        "Puerto Rico": "(GMT -04:00) Puerto Rico",
        "Santiago": "(GMT -04:00) Santiago",
        "Newfoundland": "(GMT -03:30) Newfoundland",
        "Brasilia": "(GMT -03:00) Brasilia",
        "Buenos Aires": "(GMT -03:00) Buenos Aires",
        "Greenland": "(GMT -03:00) Greenland",
        "Montevideo": "(GMT -03:00) Montevideo",
        "Mid-Atlantic": "(GMT -02:00) Mid-Atlantic",
        "Azores": "(GMT -01:00) Azores",
        "Cape Verde Is.": "(GMT -01:00) Cape Verde Is.",
        "Casablanca": "(GMT +00:00) Casablanca",
        "Dublin": "(GMT +00:00) Dublin",
        "Edinburgh": "(GMT +00:00) Edinburgh",
        "Lisbon": "(GMT +00:00) Lisbon",
        "London": "(GMT +00:00) London",
        "Monrovia": "(GMT +00:00) Monrovia",
        "UTC": "(GMT +00:00) UTC",
        "Amsterdam": "(GMT +01:00) Amsterdam",
        "Belgrade": "(GMT +01:00) Belgrade",
        "Berlin": "(GMT +01:00) Berlin",
        "Bern": "(GMT +01:00) Bern",
        "Bratislava": "(GMT +01:00) Bratislava",
        "Brussels": "(GMT +01:00) Brussels",
        "Budapest": "(GMT +01:00) Budapest",
        "Copenhagen": "(GMT +01:00) Copenhagen",
        "Ljubljana": "(GMT +01:00) Ljubljana",
        "Madrid": "(GMT +01:00) Madrid",
        "Paris": "(GMT +01:00) Paris",
        "Prague": "(GMT +01:00) Prague",
        "Rome": "(GMT +01:00) Rome",
        "Sarajevo": "(GMT +01:00) Sarajevo",
        "Skopje": "(GMT +01:00) Skopje",
        "Stockholm": "(GMT +01:00) Stockholm",
        "Vienna": "(GMT +01:00) Vienna",
        "Warsaw": "(GMT +01:00) Warsaw",
        "West Central Africa": "(GMT +01:00) West Central Africa",
        "Zagreb": "(GMT +01:00) Zagreb",
        "Zurich": "(GMT +01:00) Zurich",
        "Athens": "(GMT +02:00) Athens",
        "Bucharest": "(GMT +02:00) Bucharest",
        "Cairo": "(GMT +02:00) Cairo",
        "Harare": "(GMT +02:00) Harare",
        "Helsinki": "(GMT +02:00) Helsinki",
        "Jerusalem": "(GMT +02:00) Jerusalem",
        "Kaliningrad": "(GMT +02:00) Kaliningrad",
        "Kyiv": "(GMT +02:00) Kyiv",
        "Pretoria": "(GMT +02:00) Pretoria",
        "Riga": "(GMT +02:00) Riga",
        "Sofia": "(GMT +02:00) Sofia",
        "Tallinn": "(GMT +02:00) Tallinn",
        "Vilnius": "(GMT +02:00) Vilnius",
        "Baghdad": "(GMT +03:00) Baghdad",
        "Istanbul": "(GMT +03:00) Istanbul",
        "Kuwait": "(GMT +03:00) Kuwait",
        "Minsk": "(GMT +03:00) Minsk",
        "Moscow": "(GMT +03:00) Moscow",
        "Nairobi": "(GMT +03:00) Nairobi",
        "Riyadh": "(GMT +03:00) Riyadh",
        "St. Petersburg": "(GMT +03:00) St. Petersburg",
        "Volgograd": "(GMT +03:00) Volgograd",
        "Tehran": "(GMT +03:30) Tehran",
        "Abu Dhabi": "(GMT +04:00) Abu Dhabi",
        "Baku": "(GMT +04:00) Baku",
        "Muscat": "(GMT +04:00) Muscat",
        "Samara": "(GMT +04:00) Samara",
        "Tbilisi": "(GMT +04:00) Tbilisi",
        "Yerevan": "(GMT +04:00) Yerevan",
        "Kabul": "(GMT +04:30) Kabul",
        "Ekaterinburg": "(GMT +05:00) Ekaterinburg",
        "Islamabad": "(GMT +05:00) Islamabad",
        "Karachi": "(GMT +05:00) Karachi",
        "Tashkent": "(GMT +05:00) Tashkent",
        "Chennai": "(GMT +05:30) Chennai",
        "Kolkata": "(GMT +05:30) Kolkata",
        "Mumbai": "(GMT +05:30) Mumbai",
        "New Delhi": "(GMT +05:30) New Delhi",
        "Sri Jayawardenepura": "(GMT +05:30) Sri Jayawardenepura",
        "Kathmandu": "(GMT +05:45) Kathmandu",
        "Almaty": "(GMT +06:00) Almaty",
        "Astana": "(GMT +06:00) Astana",
        "Dhaka": "(GMT +06:00) Dhaka",
        "Urumqi": "(GMT +06:00) Urumqi",
        "Rangoon": "(GMT +06:30) Rangoon",
        "Bangkok": "(GMT +07:00) Bangkok",
        "Hanoi": "(GMT +07:00) Hanoi",
        "Jakarta": "(GMT +07:00) Jakarta",
        "Krasnoyarsk": "(GMT +07:00) Krasnoyarsk",
        "Novosibirsk": "(GMT +07:00) Novosibirsk",
        "Beijing": "(GMT +08:00) Beijing",
        "Chongqing": "(GMT +08:00) Chongqing",
        "Hong Kong": "(GMT +08:00) Hong Kong",
        "Irkutsk": "(GMT +08:00) Irkutsk",
        "Kuala Lumpur": "(GMT +08:00) Kuala Lumpur",
        "Perth": "(GMT +08:00) Perth",
        "Singapore": "(GMT +08:00) Singapore",
        "Taipei": "(GMT +08:00) Taipei",
        "Ulaanbaatar": "(GMT +08:00) Ulaanbaatar",
        "Osaka": "(GMT +09:00) Osaka",
        "Sapporo": "(GMT +09:00) Sapporo",
        "Seoul": "(GMT +09:00) Seoul",
        "Tokyo": "(GMT +09:00) Tokyo",
        "Yakutsk": "(GMT +09:00) Yakutsk",
        "Adelaide": "(GMT +09:30) Adelaide",
        "Darwin": "(GMT +09:30) Darwin",
        "Brisbane": "(GMT +10:00) Brisbane",
        "Canberra": "(GMT +10:00) Canberra",
        "Guam": "(GMT +10:00) Guam",
        "Hobart": "(GMT +10:00) Hobart",
        "Melbourne": "(GMT +10:00) Melbourne",
        "Port Moresby": "(GMT +10:00) Port Moresby",
        "Sydney": "(GMT +10:00) Sydney",
        "Vladivostok": "(GMT +10:00) Vladivostok",
        "Magadan": "(GMT +11:00) Magadan",
        "New Caledonia": "(GMT +11:00) New Caledonia",
        "Solomon Is.": "(GMT +11:00) Solomon Is.",
        "Srednekolymsk": "(GMT +11:00) Srednekolymsk",
        "Auckland": "(GMT +12:00) Auckland",
        "Fiji": "(GMT +12:00) Fiji",
        "Kamchatka": "(GMT +12:00) Kamchatka",
        "Marshall Is.": "(GMT +12:00) Marshall Is.",
        "Wellington": "(GMT +12:00) Wellington",
        "Chatham Is.": "(GMT +12:45) Chatham Is.",
        "Nuku'alofa": "(GMT +13:00) Nuku'alofa",
        "Samoa": "(GMT +13:00) Samoa",
        "Tokelau Is.": "(GMT +13:00) Tokelau Is."
      }
    },
    {
      "description": "The instance title is shown on the top navigation bar (requires a page reload).",
      "settings_type": null,
      "default": null,
      "updated_at": null,
      "id": "instance_title",
      "name": "instance_title",
      "full_name": "Instance title",
      "value": null,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Duration in days to preserve audits for. Leave empty to disable the audits cleanup.",
      "settings_type": null,
      "default": null,
      "updated_at": null,
      "id": "audits_period",
      "name": "audits_period",
      "full_name": "Saved audits interval",
      "value": null,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Foreman will load the new UI for host details",
      "settings_type": "boolean",
      "default": true,
      "updated_at": null,
      "id": "host_details_ui",
      "name": "host_details_ui",
      "full_name": "New host details UI",
      "value": true,
      "category": "general",
      "category_name": "General",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Foreman will use OAuth for API authorization",
      "settings_type": "boolean",
      "default": false,
      "updated_at": null,
      "id": "oauth_active",
      "name": "oauth_active",
      "full_name": "OAuth active",
      "value": false,
      "category": "auth",
      "category_name": "Authentication",
      "readonly": false,
      "config_file": null,
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "OAuth consumer key",
      "settings_type": "string",
      "default": "",
      "updated_at": null,
      "id": "oauth_consumer_key",
      "name": "oauth_consumer_key",
      "full_name": "OAuth consumer key",
      "value": "*****",
      "category": "auth",
      "category_name": "Authentication",
      "readonly": false,
      "config_file": null,
      "encrypted": true,
      "select_values": null
    }
  ]
}

Params

Search fields

Examples

GET /api/settings/ct_command
200
{
  "description": "Full path to CoreOS transpiler (ct) with arguments as an comma-separated array",
  "settings_type": "array",
  "default": [
    false,
    "--pretty",
    "--files-dir",
    "/home/vagrant/foreman/config/ct"
  ],
  "updated_at": "2022-09-06 15:05:53 UTC",
  "id": "ct_command",
  "name": "ct_command",
  "full_name": "CoreOS Transpiler Command",
  "value": [
    "/usr/bin/cat"
  ],
  "category": "provisioning",
  "category_name": "Provisioning",
  "readonly": false,
  "config_file": null,
  "encrypted": false,
  "select_values": null
}

Params

Examples

PUT /api/settings/login_text
{
  "setting": {
    "value": ""
  }
}
200
{
  "description": "Text to be shown in the login-page footer. Keyword $VERSION is replaced by current version.",
  "settings_type": "string",
  "default": "Version $VERSION",
  "updated_at": "2022-09-06 15:06:02 UTC",
  "id": "login_text",
  "name": "login_text",
  "full_name": "Login page footer text",
  "value": "",
  "category": "general",
  "category_name": "General",
  "readonly": false,
  "config_file": null,
  "encrypted": false,
  "select_values": null
}

Params