Locations

>>>

GET /api/locations
List all locations

Examples

GET /api/locations
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "locations": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "id": 373111740,
      "name": "Location 2",
      "title": "Location 2",
      "description": null
    }
  ]
}

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
>>>

GET /api/locations/:id
Show a location

Examples

GET /api/locations/447626439
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2018-11-15 19:02:08 UTC",
  "updated_at": "2018-11-15 19:02:08 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "loc6",
  "title": "loc6",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": 20,
      "created_at": "2018-11-15 19:02:08 UTC",
      "updated_at": "2018-11-15 19:02:08 UTC",
      "id": 767575239,
      "name": "foo",
      "value": "*****"
    }
  ]
}

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
show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/locations
Create a location

Examples

POST /api/locations
{
  "location": {
    "name": "Test Location"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2018-11-15 19:02:22 UTC",
  "updated_at": "2018-11-15 19:02:22 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "Test Location",
  "title": "Test Location",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": []
}

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
location
required

Validations:

  • Must be a Hash
location[name]
required

Validations:

  • Must be a String
location[description]
optional , nil allowed

Validations:

  • Must be a String
location[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type
location[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type
location[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type
location[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type
location[config_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type
location[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type
location[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type
location[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type
location[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type
location[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type
location[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type
location[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type
location[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.
location[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type
>>>

PUT /api/locations/:id
Update a location

Examples

POST /api/locations/447626439
{
  "location": {
    "description": "誅隮𗬵管𪷠Ꮨ𬪏䢣𪬜𡆧𦻟𬄝𤺊𦍥𖠧㒠𣦾𩓼뺛𨊽𘚨𨦵劬㛤𢰡𢜆ಭ띜𥴬툟쎓ᐥ瞀𪘚𣹅𗄀𥾐𘫟𣣏퍸𧘾𖥺ף𪒖𢖎𘠰𢠲𪀨𑚝𥓑𨼱𠟞𔓘𗯻𡡠𦠏髥𬤍𡥵𥛑ﲛ𥑔Ⴁⱃ𝐸𣸼𫅅𔑎𤼊䮦𩊍𗊍𢟋𥊪𤪫𗮮칬𩗛𗼑넸䳣𔑧㑔𦼊圩䓻𒃗𫌶쀟羱ᰚ𥵎晐ꁊ𢕠𥲆𫤏𢩈낎节𑅫鷣聼빤𥠂儸𤜴勨昙歹𢁒υ𠢸𥗥鄺𫉼𦋰𡤎낗𦯡𫻂𨃑𑐉뺦𘪃𧦲𗈺躃𥙀𫆾꽴䠦𫈣𥴬纚𠕞ᬱ杬𫤜𡻝𣺰𬴯耗𗪕𠶠𫰯𣫺𪾢𤚑𗮂𤩖𣓩𠂕𘝝ꬭ𤢎赏㴶ᙥ𧒐禥𬂔𪰕㨝ꋮ쮫쁀𦾺榄𖦼𣾯䦟毱𫨇𪱸烴𬍩𦩳𡄷𥼑缎퇷𩕑玫𨷕𥤝𦴧𪙺唽𨢹翿𘧕𢒘𖨍𠼺妈𗠧𩥴𝛺𣰿帵䑮𤟲侺യ𬣉𤌩𒋳蔫𠨭𪗢𧥆𣢈𡂫𦬦擇𨎽𦨻𢣼𓏓𣁯椕甥早ᓅ𩍩婁퉑𥋢𤄸𥉥ᡚ𫞑䏓䦡㴖𠵞𨐝㳐孢𩤈𡤿Ã㻎縦𩴒𠝳Κ𫼒𫄦𗭕𧓙𬒿㴳𣗩𪮛𗋐𦸘𖨩𤑰댆犀徽訂䈑𡇯䘢𥈌𠈿𦉘祈ᔃ𦒝𩬨𘩅𔑾㡯ዊ𨷀ꃡⴃ𘗡旗𫋢𦍉𥫾𡖁辒𡷼𢬯𢡺𡊸𥥪哋需𧾴𤕛𡃷𘠹禳"
  }
}
201
{
  "select_all_types": [],
  "description": "誅隮𗬵管𪷠Ꮨ𬪏䢣𪬜𡆧𦻟𬄝𤺊𦍥𖠧㒠𣦾𩓼뺛𨊽𘚨𨦵劬㛤𢰡𢜆ಭ띜𥴬툟쎓ᐥ瞀𪘚𣹅𗄀𥾐𘫟𣣏퍸𧘾𖥺ף𪒖𢖎𘠰𢠲𪀨𑚝𥓑𨼱𠟞𔓘𗯻𡡠𦠏髥𬤍𡥵𥛑ﲛ𥑔Ⴁⱃ𝐸𣸼𫅅𔑎𤼊䮦𩊍𗊍𢟋𥊪𤪫𗮮칬𩗛𗼑넸䳣𔑧㑔𦼊圩䓻𒃗𫌶쀟羱ᰚ𥵎晐ꁊ𢕠𥲆𫤏𢩈낎节𑅫鷣聼빤𥠂儸𤜴勨昙歹𢁒υ𠢸𥗥鄺𫉼𦋰𡤎낗𦯡𫻂𨃑𑐉뺦𘪃𧦲𗈺躃𥙀𫆾꽴䠦𫈣𥴬纚𠕞ᬱ杬𫤜𡻝𣺰𬴯耗𗪕𠶠𫰯𣫺𪾢𤚑𗮂𤩖𣓩𠂕𘝝ꬭ𤢎赏㴶ᙥ𧒐禥𬂔𪰕㨝ꋮ쮫쁀𦾺榄𖦼𣾯䦟毱𫨇𪱸烴𬍩𦩳𡄷𥼑缎퇷𩕑玫𨷕𥤝𦴧𪙺唽𨢹翿𘧕𢒘𖨍𠼺妈𗠧𩥴𝛺𣰿帵䑮𤟲侺യ𬣉𤌩𒋳蔫𠨭𪗢𧥆𣢈𡂫𦬦擇𨎽𦨻𢣼𓏓𣁯椕甥早ᓅ𩍩婁퉑𥋢𤄸𥉥ᡚ𫞑䏓䦡㴖𠵞𨐝㳐孢𩤈𡤿Ã㻎縦𩴒𠝳Κ𫼒𫄦𗭕𧓙𬒿㴳𣗩𪮛𗋐𦸘𖨩𤑰댆犀徽訂䈑𡇯䘢𥈌𠈿𦉘祈ᔃ𦒝𩬨𘩅𔑾㡯ዊ𨷀ꃡⴃ𘗡旗𫋢𦍉𥫾𡖁辒𡷼𢬯𢡺𡊸𥥪哋需𧾴𤕛𡃷𘠹禳",
  "created_at": "2018-11-15 19:02:22 UTC",
  "updated_at": "2018-11-15 19:02:22 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "loc21",
  "title": "loc21",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": []
}

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
location
required

Validations:

  • Must be a Hash
location[name]
optional

Validations:

  • Must be a String
location[description]
optional , nil allowed

Validations:

  • Must be a String
location[user_ids]
optional , nil allowed

User IDs

Validations:

  • Must be an array of any type
location[smart_proxy_ids]
optional , nil allowed

Smart proxy IDs

Validations:

  • Must be an array of any type
location[compute_resource_ids]
optional , nil allowed

Compute resource IDs

Validations:

  • Must be an array of any type
location[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type
location[config_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type
location[ptable_ids]
optional , nil allowed

Partition template IDs

Validations:

  • Must be an array of any type
location[provisioning_template_ids]
optional , nil allowed

Provisioning template IDs

Validations:

  • Must be an array of any type
location[domain_ids]
optional , nil allowed

Domain IDs

Validations:

  • Must be an array of any type
location[realm_ids]
optional , nil allowed

Realm IDs

Validations:

  • Must be an array of any type
location[hostgroup_ids]
optional , nil allowed

Host group IDs

Validations:

  • Must be an array of any type
location[environment_ids]
optional , nil allowed

Environment IDs

Validations:

  • Must be an array of any type
location[subnet_ids]
optional , nil allowed

Subnet IDs

Validations:

  • Must be an array of any type
location[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.
location[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

DELETE /api/locations/:id
Delete a location

Examples

DELETE /api/locations/255093256-Location%201
{
  "location": {}
}
200
{
  "id": 255093256,
  "name": "Location 1",
  "created_at": "2018-11-15T19:01:27.644Z",
  "updated_at": "2018-11-15T19:01:27.644Z",
  "ignore_types": [],
  "ancestry": null,
  "title": "Location 1",
  "description": null
}

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 an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.