Settings

>>>

GET /api/settings
List all settings

Examples

GET /api/settings
200
{
  "total": 83,
  "subtotal": 83,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": "Allow access to unattended URLs without build mode being used",
      "category": "Setting::Provisioning",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "access_unattended_without_build",
      "name": "access_unattended_without_build",
      "full_name": "Access unattended without build",
      "value": false,
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Default root password on provisioned hosts",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": null,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "root_pass",
      "name": "root_pass",
      "full_name": null,
      "value": null,
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Should Foreman provide puppet environment in ENC yaml output? (this avoids the mismatch error between puppet.conf and ENC environment)",
      "category": "Setting::Puppet",
      "settings_type": "boolean",
      "default": true,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "enc_environment",
      "name": "enc_environment",
      "full_name": null,
      "value": true,
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "SSL Certificate path that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": "string",
      "default": "/var/lib/puppet/ssl/certs/some.host.fqdn",
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "ssl_certificate",
      "name": "ssl_certificate",
      "full_name": null,
      "value": "/var/lib/puppet/ssl/certs/some.host.fqdn",
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "SSL CA file that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": "string",
      "default": "/var/lib/puppet/ssl/certs/ca.pem",
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "ssl_ca_file",
      "name": "ssl_ca_file",
      "full_name": null,
      "value": "/var/lib/puppet/ssl/certs/ca.pem",
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "SSL Private Key file that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": "string",
      "default": "/var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem",
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "ssl_priv_key",
      "name": "ssl_priv_key",
      "full_name": null,
      "value": "/var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem",
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Setting::Puppet interval in minutes",
      "category": "Setting::Puppet",
      "settings_type": "integer",
      "default": 30,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "puppet_interval",
      "name": "puppet_interval",
      "full_name": null,
      "value": 30,
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "The Setting::Puppet environment foreman would default to in case it can't auto detect it",
      "category": "Setting::Puppet",
      "settings_type": "string",
      "default": "production",
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "default_puppet_environment",
      "name": "default_puppet_environment",
      "full_name": null,
      "value": "production",
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": {
        "global_puppetmaster": "global_puppetmaster",
        "production": "production",
        "testing": "testing"
      }
    },
    {
      "description": "Enable Email Alerts per each failed puppet report",
      "category": "Setting::Puppet",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "failed_report_email_notification",
      "name": "failed_report_email_notification",
      "full_name": null,
      "value": false,
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "The Default path in which foreman resolves host specific variables",
      "category": "Setting::Puppet",
      "settings_type": "array",
      "default": [
        "fqdn",
        "hostgroup",
        "os",
        "domain"
      ],
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "Default_parameters_Lookup_Path",
      "name": "Default_parameters_Lookup_Path",
      "full_name": null,
      "value": [
        "fqdn",
        "hostgroup",
        "os",
        "domain"
      ],
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Should Foreman manage host certificates when provisioning hosts",
      "category": "Setting::Provisioning",
      "settings_type": "boolean",
      "default": true,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "manage_puppetca",
      "name": "manage_puppetca",
      "full_name": null,
      "value": true,
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "The amount of records shown per page in foreman",
      "category": "Setting::General",
      "settings_type": "integer",
      "default": 20,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "entries_per_page",
      "name": "entries_per_page",
      "full_name": null,
      "value": 20,
      "category_name": "General",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Foreman will update a hosts environment from its facts",
      "category": "Setting::Puppet",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "update_environment_from_facts",
      "name": "update_environment_from_facts",
      "full_name": null,
      "value": false,
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "idle timeout",
      "category": "Setting::General",
      "settings_type": "integer",
      "default": 5,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "idle_timeout",
      "name": "idle_timeout",
      "full_name": null,
      "value": 5,
      "category_name": "General",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Enable safe mode config templates rendinging(recommended)",
      "category": "Setting::Provisioning",
      "settings_type": "boolean",
      "default": true,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "safemode_render",
      "name": "safemode_render",
      "full_name": null,
      "value": true,
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Should Foreman use random UUID's for certificate signing instead of hostnames",
      "category": "Setting::Puppet",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "use_uuid_for_certificates",
      "name": "use_uuid_for_certificates",
      "full_name": null,
      "value": false,
      "category_name": "Puppet",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Should Foreman query the locally configured name server or the SOA/NS authorities",
      "category": "Setting::Provisioning",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "query_local_nameservers",
      "name": "query_local_nameservers",
      "full_name": null,
      "value": false,
      "category_name": "Provisioning",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Setting::Authorize login delegation with REMOTE_USER environment variable",
      "category": "Setting::General",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "authorize_login_delegation",
      "name": "authorize_login_delegation",
      "full_name": null,
      "value": false,
      "category_name": "General",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "Setting::Authorize login delegation with REMOTE_USER environment variable for API calls",
      "category": "Setting::General",
      "settings_type": "boolean",
      "default": false,
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "authorize_login_delegation_api",
      "name": "authorize_login_delegation_api",
      "full_name": null,
      "value": false,
      "category_name": "General",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    },
    {
      "description": "The URL Foreman should point to in emails etc",
      "category": "Setting::General",
      "settings_type": "string",
      "default": "http://foreman.some.host.fqdn",
      "created_at": "2021-05-19 07:53:01 UTC",
      "updated_at": "2021-05-19 07:53:01 UTC",
      "id": "foreman_url",
      "name": "foreman_url",
      "full_name": null,
      "value": "http://foreman.some.host.fqdn",
      "category_name": "General",
      "readonly": false,
      "config_file": "settings.yaml",
      "encrypted": false,
      "select_values": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
description text
name string
>>>

GET /api/settings/:id
Show a setting

Examples

GET /api/settings/administrator
200
{
  "description": "The Default administrator email address",
  "category": "Setting::General",
  "settings_type": "string",
  "default": "root@some.host.fqdn",
  "created_at": "2021-05-19 07:53:01 UTC",
  "updated_at": "2021-05-19 07:53:01 UTC",
  "id": "administrator",
  "name": "administrator",
  "full_name": null,
  "value": "root@some.host.fqdn",
  "category_name": "General",
  "readonly": false,
  "config_file": "settings.yaml",
  "encrypted": false,
  "select_values": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
>>>

PUT /api/settings/:id
Update a setting

Examples

PUT /api/settings/231989830
{
  "setting": {
    "value": "100"
  }
}
200
{
  "description": "Duration in minutes after the Puppet interval for servers to be classed as out of sync.",
  "category": "Setting::Puppet",
  "settings_type": "integer",
  "default": 5,
  "created_at": "2021-05-19 07:53:01 UTC",
  "updated_at": "2021-05-19 07:53:02 UTC",
  "id": "outofsync_interval",
  "name": "outofsync_interval",
  "full_name": null,
  "value": 100,
  "category_name": "Puppet",
  "readonly": false,
  "config_file": "settings.yaml",
  "encrypted": false,
  "select_values": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
setting
required

Validations:

  • Must be a Hash
setting[value]
optional

Validations:

  • Must be a String