API documentation

Examples

GET /api/settings
200
{
  "total": 77,
  "subtotal": 77,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "value": "root@some.host.fqdn",
      "description": "The Default administrator email address",
      "category": "Setting::General",
      "settings_type": "string",
      "default": "root@some.host.fqdn",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 333972760,
      "name": "administrator",
      "full_name": null,
      "category_name": "General"
    },
    {
      "value": "http://foreman.some.host.fqdn",
      "description": "The URL Foreman should point to in emails etc",
      "category": "Setting::General",
      "settings_type": null,
      "default": "http://foreman.some.host.fqdn",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 182539440,
      "name": "foreman_url",
      "full_name": null,
      "category_name": "General"
    },
    {
      "value": null,
      "description": "Default root password on provisioned hosts",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": null,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 1038509113,
      "name": "root_pass",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": true,
      "description": "Enable safe mode config templates rendinging(recommended)",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": true,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 595784092,
      "name": "safemode_render",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": "/var/lib/puppet/ssl/certs/some.host.fqdn",
      "description": "SSL Certificate path that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": "/var/lib/puppet/ssl/certs/some.host.fqdn",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 344310031,
      "name": "ssl_certificate",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": "/var/lib/puppet/ssl/certs/ca.pem",
      "description": "SSL CA file that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": "/var/lib/puppet/ssl/certs/ca.pem",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 227315895,
      "name": "ssl_ca_file",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": "/var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem",
      "description": "SSL Private Key file that foreman would use to communicate with its proxies",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": "/var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 982229024,
      "name": "ssl_priv_key",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": 30,
      "description": "Setting::Puppet interval in minutes",
      "category": "Setting::Puppet",
      "settings_type": "integer",
      "default": 30,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 708099507,
      "name": "puppet_interval",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": "production",
      "description": "The Setting::Puppet environment foreman would default to in case it can't auto detect it",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": "production",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 489917738,
      "name": "default_puppet_environment",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": "puppet",
      "description": "Default Setting::Puppet Server hostname",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": "puppet",
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 937145060,
      "name": "puppet_server",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": false,
      "description": "Enable Email Alerts per each failed puppet report",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": false,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 14451317,
      "name": "failed_report_email_notification",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": [
        "fqdn",
        "hostgroup",
        "os",
        "domain"
      ],
      "description": "The Default path in which foreman resolves host specific variables",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": [
        "fqdn",
        "hostgroup",
        "os",
        "domain"
      ],
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 515381208,
      "name": "Default_variables_Lookup_Path",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": true,
      "description": "Should Foreman manage host certificates when provisioning hosts",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": true,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 700393283,
      "name": "manage_puppetca",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": 20,
      "description": "The amount of records shown per page in foreman",
      "category": "Setting::General",
      "settings_type": null,
      "default": 20,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 817264379,
      "name": "entries_per_page",
      "full_name": null,
      "category_name": "General"
    },
    {
      "value": false,
      "description": "Foreman will update a hosts environment from its facts",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": false,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 129058412,
      "name": "update_environment_from_facts",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": 5,
      "description": "idle timeout",
      "category": "Setting::General",
      "settings_type": null,
      "default": 5,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 386817023,
      "name": "idle_timeout",
      "full_name": null,
      "category_name": "General"
    },
    {
      "value": true,
      "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": null,
      "default": true,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 537488238,
      "name": "enc_environment",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": false,
      "description": "Should Foreman use random UUID's for certificate signing instead of hostnames",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": false,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 855146510,
      "name": "use_uuid_for_certificates",
      "full_name": null,
      "category_name": "Puppet"
    },
    {
      "value": false,
      "description": "Should Foreman query the locally configured name server or the SOA/NS authorities",
      "category": "Setting::Provisioning",
      "settings_type": null,
      "default": false,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 100642973,
      "name": "query_local_nameservers",
      "full_name": null,
      "category_name": "Provisioning"
    },
    {
      "value": true,
      "description": "Foreman smart variables will be exposed via the ENC yaml output",
      "category": "Setting::Puppet",
      "settings_type": null,
      "default": true,
      "created_at": "2019-02-20 13:17:48 UTC",
      "updated_at": "2019-02-20 13:17:48 UTC",
      "id": 712617915,
      "name": "Enable_Smart_Variables_in_ENC",
      "full_name": null,
      "category_name": "Puppet"
    }
  ]
}

Params

Param name	Description
location_id optional	Scope by locations Validations: Must be a Integer
organization_id optional	Scope by organizations 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	paginate results Validations: Must be a String
per_page optional	number of entries per request Validations: Must be a String

Search fields

Field name	Type	Possible values
description	text
name	string

Examples

GET /api/settings/301564180
200
{
  "value": false,
  "description": "Allow access to unattended URLs without build mode being used",
  "category": "Setting::Provisioning",
  "settings_type": null,
  "default": false,
  "created_at": "2019-02-20 13:17:48 UTC",
  "updated_at": "2019-02-20 13:17:48 UTC",
  "id": 301564180,
  "name": "access_unattended_without_build",
  "full_name": null,
  "category_name": "Provisioning"
}

Params

Param name

Description

location_id
optional

Scope by locations

Validations:

Must be a Integer

organization_id
optional

Scope by organizations

Validations:

Must be a Integer

id
required

Validations:

Must be a String

Examples

PUT /api/settings/6656990
{
  "setting": {
    "value": "fnlRguJpXMyrwteVSYXjRKkzOBlMnacwJPwsoIHGcVOSruKkOLeksOmpOsJtuFUjpcSohLgbAssunPjDpQJEurkeToTsHshlRmkJjwQTChhifRFoyRKmQbxsQMXDcAUrOemBXRwEXxALvKkGbLnWPGsJhRwuXzaaauIoYbgOuchYIcOwDPAQMJLiHdxMzYbpwBoMPXBSoDuwzzgTODMOlcwjgUPXLNYwAtHtFhfXtgfSDyBOOnBGoSRJwSDjAsROHulpXqstiHgrjrvUreVKYuiimWcXTrXjickrVlqceSTcOjyKYuWbRuQHLvkoNnqcmIUrfXLlxpYyBYUpphgIiMtXmWGrkJrrNvVwxPMABCjStqjwLACzbnMOChpLfUfDAWpJRllkdOEQnYMbwTjKyeajfQYlkqDmzjvsMOyBUfwvcvPbpfHVxTPEPxJObSnoSPTnjsKaCurRkfHWpnqUHknonkLRHPngvASTjcePAIuREBMqGejEuVkYNgxQyqHeOOKzEBRWjfchEgBBkKLYOqpcHDXJUliVSzPdroDolskjFpajrUXNLvEzTMyqoRrCRdHBnyjQcIuFpovyjHpGWcuqBasXDsIhqQGzsFdEboHwJVIKzQNgHRpVutddYmgaUUWKwSzkaSRpbhuWurYUDvisPSdpFyDTuliXyLyCbnAwCgIFKuFAhvYaljoNbRoVOOLGicUmaYRGHjqALxztgtkYayqwtpPwDwXevSQhCzAkOpEQSQopSCFYphssETbKhxsSlSSockhGFuqhDnggKbIlniBXlcuOMcOnudtIlWRXFSSMvXVSPfAacwGweWdjdgiQbGzpkQFNhFWQjAIEETlLOpeDjkzCKzwYfhBqkKdNGAvknmnQuLwPRotrzpWwonlYUwPImOAilcUoDcmDMVckTuuJszHoaYdBSphJzmPwhOyWHDmmszNnLtkdVHhCpsQGEPNkUgLYOATzrcgWzznpbpHIChKSDIUqelnh"
  }
}
200
{
  "value": "fnlRguJpXMyrwteVSYXjRKkzOBlMnacwJPwsoIHGcVOSruKkOLeksOmpOsJtuFUjpcSohLgbAssunPjDpQJEurkeToTsHshlRmkJjwQTChhifRFoyRKmQbxsQMXDcAUrOemBXRwEXxALvKkGbLnWPGsJhRwuXzaaauIoYbgOuchYIcOwDPAQMJLiHdxMzYbpwBoMPXBSoDuwzzgTODMOlcwjgUPXLNYwAtHtFhfXtgfSDyBOOnBGoSRJwSDjAsROHulpXqstiHgrjrvUreVKYuiimWcXTrXjickrVlqceSTcOjyKYuWbRuQHLvkoNnqcmIUrfXLlxpYyBYUpphgIiMtXmWGrkJrrNvVwxPMABCjStqjwLACzbnMOChpLfUfDAWpJRllkdOEQnYMbwTjKyeajfQYlkqDmzjvsMOyBUfwvcvPbpfHVxTPEPxJObSnoSPTnjsKaCurRkfHWpnqUHknonkLRHPngvASTjcePAIuREBMqGejEuVkYNgxQyqHeOOKzEBRWjfchEgBBkKLYOqpcHDXJUliVSzPdroDolskjFpajrUXNLvEzTMyqoRrCRdHBnyjQcIuFpovyjHpGWcuqBasXDsIhqQGzsFdEboHwJVIKzQNgHRpVutddYmgaUUWKwSzkaSRpbhuWurYUDvisPSdpFyDTuliXyLyCbnAwCgIFKuFAhvYaljoNbRoVOOLGicUmaYRGHjqALxztgtkYayqwtpPwDwXevSQhCzAkOpEQSQopSCFYphssETbKhxsSlSSockhGFuqhDnggKbIlniBXlcuOMcOnudtIlWRXFSSMvXVSPfAacwGweWdjdgiQbGzpkQFNhFWQjAIEETlLOpeDjkzCKzwYfhBqkKdNGAvknmnQuLwPRotrzpWwonlYUwPImOAilcUoDcmDMVckTuuJszHoaYdBSphJzmPwhOyWHDmmszNnLtkdVHhCpsQGEPNkUgLYOATzrcgWzznpbpHIChKSDIUqelnh",
  "description": "Text to be shown in the login-page footer",
  "category": "Setting::General",
  "settings_type": null,
  "default": null,
  "created_at": "2019-02-20 13:17:48 UTC",
  "updated_at": "2019-02-20 13:17:50 UTC",
  "id": 6656990,
  "name": "login_text",
  "full_name": null,
  "category_name": "General"
}

Params

Param name	Description
location_id optional	Scope by locations Validations: Must be a Integer
organization_id optional	Scope by organizations 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

Settings

GET /api/settings
List all settings

Examples

Params

Search fields

GET /api/settings/:id
Show a setting

Examples

Params

PUT /api/settings/:id
Update a setting

Examples

Params

Settings

GET /api/settings List all settings

Examples

Params

Search fields

GET /api/settings/:id Show a setting

Examples

Params

PUT /api/settings/:id Update a setting

Examples

Params

GET /api/settings
List all settings

GET /api/settings/:id
Show a setting

PUT /api/settings/:id
Update a setting