Bug #17343


It is not possible to use empty list as value for optional parameters via API

Added by Stanislav Tkachenko about 7 years ago. Updated over 5 years ago.

Target version:
Fixed in Releases:
Found in Releases:


Description of problem:
Some entities has optional array parameters that allow nil value. Previously it was possible to send empty list '[]' as value to clear all values, but now according to dLobatog it is not possible because of a new security mechanism in Rails.

Though it affects all the optional parameters, some example entities/parameters are: smart_proxies.locations, location.smart_proxies, organization.smart_proxies, organization.hostgroup_ids.

  1. Update with empty list

Making HTTP PUT request to with options {'verify': False, 'auth': ('admin', 'changeme'), 'headers': {'content-type': 'application/json'}} and data {"organization": {"smart_proxy_ids": []}}.

  1. Response

Received HTTP 200 response:

"smart_proxies":[ {
}, {

Steps to Reproduce:
1. Create entity that has optional array parameters
2. Update that parameter with some value
3. Update that parameter one more time with empty list
4. Check that values from point 2 not changed

Actual results:
When updating with empty list nothing happens, optional parameter has all previous values

Expected results:
All values should be cleared

Related issues 1 (0 open1 closed)

Related to Foreman - Bug #18155: OrganizationsControllerTest empty array test uses invalid data for form encodingClosedDominic Cleal01/19/2017Actions
Actions #1

Updated by Daniel Lobato Garcia about 7 years ago

The reason seems to be that Rails 4 converts these attributes to 'nil' and are ignored.

2016-11-15T13:57:48 b5024cb3 [app] [D] Value for params[:smart_proxy][:locations] was set to nil, because it was one of [], [null] or [null, null, ...]. Go to for more information.

Then when I check smart_proxy_params on the update action, it's gone.

Actions #2

Updated by Marek Hulán about 7 years ago

  • Bugzilla link set to 1395229
Actions #3

Updated by Kavita Gaikwad about 7 years ago

  • Assignee set to Kavita Gaikwad
  • Target version set to 1.15.6
Actions #4

Updated by Swapnil Abnave about 7 years ago

  • Target version changed from 1.15.6 to 1.15.1
Actions #5

Updated by The Foreman Bot about 7 years ago

  • Status changed from New to Ready For Testing
  • Pull request added
Actions #6

Updated by Kavita Gaikwad about 7 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100
Actions #7

Updated by Dominic Cleal about 7 years ago

  • translation missing: en.field_release set to 189
Actions #8

Updated by Dominic Cleal almost 7 years ago

  • Related to Bug #18155: OrganizationsControllerTest empty array test uses invalid data for form encoding added

Also available in: Atom PDF