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-07-24 12:56:29 UTC",
      "updated_at": "2018-07-24 12:56:29 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2018-07-24 12:56:29 UTC",
      "updated_at": "2018-07-24 12:56:29 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/447626443
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2018-07-24 13:11:04 UTC",
  "updated_at": "2018-07-24 13:11:04 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626443,
  "name": "loc252",
  "title": "loc252",
  "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-07-24 13:11:04 UTC",
      "updated_at": "2018-07-24 13:11:04 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-07-24 13:14:01 UTC",
  "updated_at": "2018-07-24 13:14:01 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/447626440
{
  "location": {
    "description": "𫺋碜𦣓旓鵌咳𢲜肐쿐塶쌷믨㞪𖥡𧻝𬆥𧩞𥦛ཪ구𐐙𘅰𑗙䁑𬞼𗴬홵𖭃𢰧𫆙𠚘𫐎ƚ𗱰𦉲츝횚𓊳騼郞핁혾詸긐𤧆𘁮䯓ῃ𥔊𤿏貌𤿷鉶𦔦뱿謿㝪𩇻𨡳쁅𨖕ᴵ𣤣䗑𦃋귾𡤑𨝘𓇑𥉜뮳𢇽𣶉ꩲ𫦳𥋌ߍ𦮈𢴷𪋥𥎩𫳢㦠𬬘𫨞𧲔𘜥撣𗂗呂弬𥭩𓊜𤡷凤𨴹𫔭𨩉𬱓䛖𨈪𗀬𩂈𥽅𗔎𪚌孯뎆𨸘𧏪𪄌𬈝𧍱묇𪦁𫯱𦸪ȋ𥎀𘅱𨴝싗𤷨䃱𪖥𧨰語녊淪𬉄𝙧梾䟄𫱓ꢯ𩣝䤥𥢆𢀼𡳃𦜾臀描荅䦭茯𥛸𢎥녨ጩ𪩷𐏍챇海冃𐜯𨥋𥒻𡊺𫐹𒈍姩𡚹惢𒍓栦𩓴𩤻黅𣓹숝𩻌𪈹ј𦶡𡋛𗌣𨼐𥧪𬲷䒟𢶥ᕎ𩶞𥄁𥡞颖诟躝棑𐘵𩙤坪萱𢠩𥒬𩞬𩥌𬂹𝜅𡚚𧧲𥴖𡓼𨫷𠅯㔗𗌲驫𣓪烚嫈憲釰𧌀𩞽𪅤𨺉𨠕阗𗡀𓈩𣗽𨆩𨦸𝒰𤟘磪𢸱𥖞ᔷ𢕡柦Ꝺ𫸝𨨕𗴋𡻜𠜠ﷂ𡦯绥墜あ襄묰ᝂ𥯤𤷙慰𨊬䖹𖠗𨠉𠥀ఠ𡅜𡀎ꠟ𨪁듽𬑻𬯴𪧯𢙗𗂠𢖮鏝䗬ﶋ긳𤃞蘉쨬𗃑𘊽𢌲饼𪲌𩠽𣤜𣄂즵锺镝ᢠ䉟𤹨篜ဝ瘎䧇𒎀𫻝灚𧅙檓𠂂𤓧㘷"
  }
}
201
{
  "select_all_types": [],
  "description": "𫺋碜𦣓旓鵌咳𢲜肐쿐塶쌷믨㞪𖥡𧻝𬆥𧩞𥦛ཪ구𐐙𘅰𑗙䁑𬞼𗴬홵𖭃𢰧𫆙𠚘𫐎ƚ𗱰𦉲츝횚𓊳騼郞핁혾詸긐𤧆𘁮䯓ῃ𥔊𤿏貌𤿷鉶𦔦뱿謿㝪𩇻𨡳쁅𨖕ᴵ𣤣䗑𦃋귾𡤑𨝘𓇑𥉜뮳𢇽𣶉ꩲ𫦳𥋌ߍ𦮈𢴷𪋥𥎩𫳢㦠𬬘𫨞𧲔𘜥撣𗂗呂弬𥭩𓊜𤡷凤𨴹𫔭𨩉𬱓䛖𨈪𗀬𩂈𥽅𗔎𪚌孯뎆𨸘𧏪𪄌𬈝𧍱묇𪦁𫯱𦸪ȋ𥎀𘅱𨴝싗𤷨䃱𪖥𧨰語녊淪𬉄𝙧梾䟄𫱓ꢯ𩣝䤥𥢆𢀼𡳃𦜾臀描荅䦭茯𥛸𢎥녨ጩ𪩷𐏍챇海冃𐜯𨥋𥒻𡊺𫐹𒈍姩𡚹惢𒍓栦𩓴𩤻黅𣓹숝𩻌𪈹ј𦶡𡋛𗌣𨼐𥧪𬲷䒟𢶥ᕎ𩶞𥄁𥡞颖诟躝棑𐘵𩙤坪萱𢠩𥒬𩞬𩥌𬂹𝜅𡚚𧧲𥴖𡓼𨫷𠅯㔗𗌲驫𣓪烚嫈憲釰𧌀𩞽𪅤𨺉𨠕阗𗡀𓈩𣗽𨆩𨦸𝒰𤟘磪𢸱𥖞ᔷ𢕡柦Ꝺ𫸝𨨕𗴋𡻜𠜠ﷂ𡦯绥墜あ襄묰ᝂ𥯤𤷙慰𨊬䖹𖠗𨠉𠥀ఠ𡅜𡀎ꠟ𨪁듽𬑻𬯴𪧯𢙗𗂠𢖮鏝䗬ﶋ긳𤃞蘉쨬𗃑𘊽𢌲饼𪲌𩠽𣤜𣄂즵锺镝ᢠ䉟𤹨篜ဝ瘎䧇𒎀𫻝灚𧅙檓𠂂𤓧㘷",
  "created_at": "2018-07-24 13:14:02 UTC",
  "updated_at": "2018-07-24 13:14:02 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626440,
  "name": "loc269",
  "title": "loc269",
  "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/373111740-Location%202
{
  "location": {}
}
200
{
  "id": 373111740,
  "name": "Location 2",
  "created_at": "2018-07-24T13:14:01.556Z",
  "updated_at": "2018-07-24T13:14:01.556Z",
  "ignore_types": [],
  "ancestry": null,
  "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
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.