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": "2021-09-01 10:43:23 UTC",
      "updated_at": "2021-09-01 10:43:23 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-09-01 10:43:23 UTC",
      "updated_at": "2021-09-01 10:43:23 UTC",
      "id": 373111740,
      "name": "Location 2",
      "title": "Location 2",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

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

GET /api/locations/:id
Show a location

Examples

GET /api/locations/447626486
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2021-09-01 11:09:41 UTC",
  "updated_at": "2021-09-01 11:09:41 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626486,
  "name": "loc87",
  "title": "loc87",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": 20,
      "created_at": "2021-09-01 11:09:41 UTC",
      "updated_at": "2021-09-01 11:09:41 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": "string",
      "value": "*****"
    }
  ],
  "deprecations": {
    "environments": "Environments got deprecated from this endpoint."
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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": "neA6iwZJze"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "has already been taken"
      ]
    },
    "full_messages": [
      "Name has already been taken"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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[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
location[organization_ids]
optional , nil allowed

Associated organization IDs

Validations:

  • Must be an array of any type
>>>

PUT /api/locations/:id
Update a location

Examples

POST /api/locations/447626451
{
  "location": {
    "description": "𨎩𨐧𝔙벴き𘩓苏엗𑈆𡭏쬶뤭𤉹승𬕮蚿𡦗𥘲剌𣰟弗𤛙𤒞𢚨ꅚ𐦋𧂭ꗊۿ𡮟𠖱𢏃𦥱荂𒋴𡁗𢇴𗁶𦩻猨㶶ᖶ喝𪿅𣺶ፖ㧉ᡱ𬢽랽𐢎𠙠𢩫𬄋ᠲ袤𣳥䕭𐤀𢙉𢜄Ɱ𪙸孴ꋚ𐳔읁讏䉩炮𣞶ꤽࠈ𦭷𤛲ö𩲌갧𡭫𧩵𡶅蠖磞䊺ꑩ淟똻𢫨浲髛㥶𢨨𠞇𫘑𗒋迻𬔜𪘳𛰙腇𘃍𗖻𠦞Տ𧃁屺𫢚𝔠餩𧃔ꅄሥ𪷺𣓙𒀮𧿛𥡱鼡𧷏䦄佊蛫𧧩𘆸𧒏𗳝𪾐闤𡵾𪊰𗦻𘁕쟲뮚䆙镧謭瑆𤬚䩣𩻥𬦥몏𩌣簰獴蚥𤄮뺔Ú𘝦𓃞飡鸳𤥦盬𗤝𫗭𖢸퍻𗑬嵵稕北𩔻ꉔ𢎶𡃺ㄪ𩷽𪭝뚏ၽ𧂛璟𝑣綃㱍䑶ဨ𞡣𣐩𣝚𪯠𣇰𪦤릥𫹇𒋨𨘅虄𡹫𞢏𢾖ꊗ𗯎ᩆ𤾽潉𢧍𡐲𧥇𤦂𖡮𥧪㶖쁴蓄𫝕𤗹𤬮𬦂憎𫶱𖭷𡆊𢉟𩛴𒈿य𫽆𪥳欮솓𢾇𠭍𨷽葘奍덮遶ṽ收𫇼𣸝𑰧妽𢎊쌉ㇷ𠸊𒒂𠈽씽貾𢐹𖢍㖬𪏼곕恕쑢䍅𔓼𠷭𡪜翙𩪉梧鰂郃𗶶矻𬶨ḻ𤣰𐁔䝄𧢨䴠磧댵什𠵪嬞𐠕𧺪𧀭𥝥𧽫𐫃海𔖣燲𠬜𡒨𣸇𗄍𠅧𘫫𣴨𢏿𪗴柧瞑퀷㩒𡺌𒎏Ϳ"
  }
}
201
{
  "select_all_types": [],
  "description": "𨎩𨐧𝔙벴き𘩓苏엗𑈆𡭏쬶뤭𤉹승𬕮蚿𡦗𥘲剌𣰟弗𤛙𤒞𢚨ꅚ𐦋𧂭ꗊۿ𡮟𠖱𢏃𦥱荂𒋴𡁗𢇴𗁶𦩻猨㶶ᖶ喝𪿅𣺶ፖ㧉ᡱ𬢽랽𐢎𠙠𢩫𬄋ᠲ袤𣳥䕭𐤀𢙉𢜄Ɱ𪙸孴ꋚ𐳔읁讏䉩炮𣞶ꤽࠈ𦭷𤛲ö𩲌갧𡭫𧩵𡶅蠖磞䊺ꑩ淟똻𢫨浲髛㥶𢨨𠞇𫘑𗒋迻𬔜𪘳𛰙腇𘃍𗖻𠦞Տ𧃁屺𫢚𝔠餩𧃔ꅄሥ𪷺𣓙𒀮𧿛𥡱鼡𧷏䦄佊蛫𧧩𘆸𧒏𗳝𪾐闤𡵾𪊰𗦻𘁕쟲뮚䆙镧謭瑆𤬚䩣𩻥𬦥몏𩌣簰獴蚥𤄮뺔Ú𘝦𓃞飡鸳𤥦盬𗤝𫗭𖢸퍻𗑬嵵稕北𩔻ꉔ𢎶𡃺ㄪ𩷽𪭝뚏ၽ𧂛璟𝑣綃㱍䑶ဨ𞡣𣐩𣝚𪯠𣇰𪦤릥𫹇𒋨𨘅虄𡹫𞢏𢾖ꊗ𗯎ᩆ𤾽潉𢧍𡐲𧥇𤦂𖡮𥧪㶖쁴蓄𫝕𤗹𤬮𬦂憎𫶱𖭷𡆊𢉟𩛴𒈿य𫽆𪥳欮솓𢾇𠭍𨷽葘奍덮遶ṽ收𫇼𣸝𑰧妽𢎊쌉ㇷ𠸊𒒂𠈽씽貾𢐹𖢍㖬𪏼곕恕쑢䍅𔓼𠷭𡪜翙𩪉梧鰂郃𗶶矻𬶨ḻ𤣰𐁔䝄𧢨䴠磧댵什𠵪嬞𐠕𧺪𧀭𥝥𧽫𐫃海𔖣燲𠬜𡒨𣸇𗄍𠅧𘫫𣴨𢏿𪗴柧瞑퀷㩒𡺌𒎏Ϳ",
  "created_at": "2021-09-01 11:25:22 UTC",
  "updated_at": "2021-09-01 11:25:22 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626451,
  "name": "loc101",
  "title": "loc101",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": [],
  "deprecations": {
    "environments": "Environments got deprecated from this endpoint."
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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[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
location[organization_ids]
optional , nil allowed

Associated organization IDs

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": "2021-09-01T11:23:56.789Z",
  "updated_at": "2021-09-01T11:23:56.789Z",
  "ignore_types": [],
  "ancestry": null,
  "title": "Location 1",
  "description": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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.