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
  },
  "data": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2022-03-29 08:29:27 UTC",
      "updated_at": "2022-03-29 08:29:27 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2022-03-29 08:29:27 UTC",
      "updated_at": "2022-03-29 08:29:27 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. ‘

Maruku could not parse this XML/HTML: 
<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 text
id integer
location_id integer
name string
title string
>>>

GET /api/locations/:id
Show a location

Examples

GET /api/locations/447626442-loc78
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2022-03-29 08:29:32 UTC",
  "updated_at": "2022-03-29 08:29:32 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626442,
  "name": "loc78",
  "title": "loc78",
  "users": [
    {
      "id": 980190962,
      "login": "one",
      "description": null,
      "inherited": false
    }
  ],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": 20,
      "created_at": "2022-03-29 08:29:32 UTC",
      "updated_at": "2022-03-29 08:29:32 UTC",
      "id": 767575239,
      "name": "parameter2",
      "parameter_type": "string",
      "value": "parameter value 15"
    }
  ],
  "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": "HhVQcWEryW",
    "description": "fKAJJOeoeQ"
  }
}
201
{
  "select_all_types": [],
  "description": "fKAJJOeoeQ",
  "created_at": "2022-03-29 08:29:34 UTC",
  "updated_at": "2022-03-29 08:29:34 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626445,
  "name": "HhVQcWEryW",
  "title": "HhVQcWEryW",
  "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]
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/447626441
{
  "location": {
    "description": "𘪾𡂒𣣒𨩗𤜆𩱗𣂼𣿘𐭃𘅠𣧥缮떰𩱤𬌪䞒痄㼲㭈𧫊𪤘𨦛𗕷𠰙𒓞𧝟ꭵ졬𣞺𩜬𨮆𨽤𦠵𢴽ꠈꄤ𐕍𘉌𧫴𧰭鉺鮰Ӽ𧲑𑣓𡓉𡺧𫥬𬐨𩿙𨤻𥐻𧫏𩎮ⵕ幬𬌶㧎𩙶𡈶𪢢𪶪栕ﭒ𬧚犫랕ꁸ𪻑チ𤥑𨡴憦𤑥𫁛𬡑砓챼𠠖𧙠쑑𤲂ᗈ𢒭𪼤𫩱𡬱ꀉ𝞒𘫑𪯚㐹枈𨧱𥄆宋螹赫𦵘𥜛𓈥尩ⲃ𗑷𫝱𧻙挥𫩕믫𪎟𗎱赹㺰𧝛𘘠큻𦭽𝐅蚧𬱓𥅲뚹𢊩𡂧𤻑𘐎𩥡𤑷𪣮裾ꚓ곦𥕽𐎩𥾣𪣲鰖𡼴𨞰𗖫𬢟𥀮씬㔁𬇳𠎐勴𢿐𧠮𣈘𐲓旇𥲾웣𨉃𠹮𣿵𣡚퉇𥥨懢뺣䃃𣮅𘇧𑖇𤃳𪠒挙𬨂𔗺핫𗨔𣵽譧𗉕𘗛阕邒𢕴𠫣뎠ꢡ𘄓𣴊𪽀皮𢚍꼺䃏𑜑𧋦𪢷𤡷蘏𣭋笠𣨉ヘũ耘응𥕶Ｇ𗏍芗𩷏剼𝑺𬡨잙屓𠘋犕锲𪏤𩛍𓂬豈𒁴𣡙𧾡𐘆儖𩚃𪕩캜蕐ㇾ𦖭𗩇𧔈𣫯𥹸𩽮𡝬𫳈𣷡𠼌𘁒蛀𧙳𪊠ʒዌ𗓝𠚅𨵡鶘𒒱퍐𡔲㛀䐇𤈢𣗲𦸁𤙾𪺏𢥛𡿿𗹆䛶𗒾𢉧ﱮﻠ婦𥧉𦘙됥ㇽ𨣂𗳮잇볅멽𒋆璓𡄟딆庹𦽻𤄉𧉬ᇘ𠉿偊귽𨁐磂胡ᥚ𧅫ﴲ𤄟𬋒䮶뤀书"
  }
}
201
{
  "select_all_types": [],
  "description": "𘪾𡂒𣣒𨩗𤜆𩱗𣂼𣿘𐭃𘅠𣧥缮떰𩱤𬌪䞒痄㼲㭈𧫊𪤘𨦛𗕷𠰙𒓞𧝟ꭵ졬𣞺𩜬𨮆𨽤𦠵𢴽ꠈꄤ𐕍𘉌𧫴𧰭鉺鮰Ӽ𧲑𑣓𡓉𡺧𫥬𬐨𩿙𨤻𥐻𧫏𩎮ⵕ幬𬌶㧎𩙶𡈶𪢢𪶪栕ﭒ𬧚犫랕ꁸ𪻑チ𤥑𨡴憦𤑥𫁛𬡑砓챼𠠖𧙠쑑𤲂ᗈ𢒭𪼤𫩱𡬱ꀉ𝞒𘫑𪯚㐹枈𨧱𥄆宋螹赫𦵘𥜛𓈥尩ⲃ𗑷𫝱𧻙挥𫩕믫𪎟𗎱赹㺰𧝛𘘠큻𦭽𝐅蚧𬱓𥅲뚹𢊩𡂧𤻑𘐎𩥡𤑷𪣮裾ꚓ곦𥕽𐎩𥾣𪣲鰖𡼴𨞰𗖫𬢟𥀮씬㔁𬇳𠎐勴𢿐𧠮𣈘𐲓旇𥲾웣𨉃𠹮𣿵𣡚퉇𥥨懢뺣䃃𣮅𘇧𑖇𤃳𪠒挙𬨂𔗺핫𗨔𣵽譧𗉕𘗛阕邒𢕴𠫣뎠ꢡ𘄓𣴊𪽀皮𢚍꼺䃏𑜑𧋦𪢷𤡷蘏𣭋笠𣨉ヘũ耘응𥕶Ｇ𗏍芗𩷏剼𝑺𬡨잙屓𠘋犕锲𪏤𩛍𓂬豈𒁴𣡙𧾡𐘆儖𩚃𪕩캜蕐ㇾ𦖭𗩇𧔈𣫯𥹸𩽮𡝬𫳈𣷡𠼌𘁒蛀𧙳𪊠ʒዌ𗓝𠚅𨵡鶘𒒱퍐𡔲㛀䐇𤈢𣗲𦸁𤙾𪺏𢥛𡿿𗹆䛶𗒾𢉧ﱮﻠ婦𥧉𦘙됥ㇽ𨣂𗳮잇볅멽𒋆璓𡄟딆庹𦽻𤄉𧉬ᇘ𠉿偊귽𨁐磂胡ᥚ𧅫ﴲ𤄟𬋒䮶뤀书",
  "created_at": "2022-03-29 08:29:32 UTC",
  "updated_at": "2022-03-29 08:29:32 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626441,
  "name": "loc77",
  "title": "loc77",
  "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/447626440-loc76
{
  "location": {}
}
404
{
  "error": {
    "message": "Resource location not found by id '447626440-loc76'"
  }
}

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.