Settings

>>>

GET /api/settings
List all settings

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> 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
id integer
name string
>>>

GET /api/settings/:id
Show a setting

Params

Param name Description
id
required

Validations:

  • Must be a String
>>>

PUT /api/settings/:id
Update a setting

Examples

PUT /api/settings/entries_per_page
{
  "id": "entries_per_page",
  "name": "entries_per_page",
  "category": "general",
  "description": "Number of records shown per page in Foreman",
  "settingsType": "integer",
  "default": 20,
  "readonly": false,
  "fullName": "Entries per page",
  "configFile": null,
  "selectValues": null,
  "value": "25",
  "encrypted": false
}
200
{
  "description": "Number of records shown per page in Foreman",
  "settings_type": "integer",
  "default": 20,
  "updated_at": "2026-05-13 11:27:59 UTC",
  "id": "entries_per_page",
  "name": "entries_per_page",
  "full_name": "Entries per page",
  "value": 25,
  "category": "general",
  "category_name": "General",
  "readonly": false,
  "config_file": null,
  "encrypted": false,
  "select_values": null
}

Params

Param name Description
id
required

Validations:

  • Must be a String
setting
required

Validations:

  • Must be a Hash
setting[value]
optional

Validations:

  • Must be a String