GET /api/locations
List all locations

Examples

GET /api/locations
200
{
  "total": 28,
  "subtotal": 28,
  "page": 2,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626503,
      "name": "s",
      "title": "s",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626504,
      "name": "t",
      "title": "t",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626505,
      "name": "u",
      "title": "u",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626506,
      "name": "v",
      "title": "v",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626507,
      "name": "w",
      "title": "w",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626508,
      "name": "x",
      "title": "x",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626509,
      "name": "y",
      "title": "y",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 15:54:07 UTC",
      "updated_at": "2021-05-18 15:54:07 UTC",
      "id": 447626510,
      "name": "z",
      "title": "z",
      "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 field and order, eg. ‘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/255093256
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2021-05-18 15:53:37 UTC",
  "updated_at": "2021-05-18 15:53:37 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 255093256,
  "name": "Location 1",
  "title": "Location 1",
  "users": [
    {
      "id": 980190962,
      "login": "one",
      "description": null,
      "inherited": false
    },
    {
      "id": 117925625,
      "login": "scoped",
      "description": null,
      "inherited": false
    }
  ],
  "smart_proxies": [
    {
      "name": "BMC proxy",
      "id": 821748566,
      "url": "http://else.where:45673",
      "inherited": false
    },
    {
      "name": "DHCP Proxy",
      "id": 980190962,
      "url": "https://somewhere.net:8443",
      "inherited": false
    },
    {
      "name": "DNS Proxy",
      "id": 113629430,
      "url": "http://else.where:45671",
      "inherited": false
    },
    {
      "name": "Puppetmaster Proxy",
      "id": 182953976,
      "url": "http://else.where:4567",
      "inherited": false
    },
    {
      "name": "Realm Proxy",
      "id": 982965213,
      "url": "http://else.where:1337",
      "inherited": false
    },
    {
      "name": "TFTP Proxy",
      "id": 298486374,
      "url": "http://somewhere.else",
      "inherited": false
    }
  ],
  "subnets": [
    {
      "id": 980190962,
      "name": "one",
      "description": null,
      "network_address": "2.3.4.0/24",
      "inherited": false
    },
    {
      "id": 1018350795,
      "name": "five",
      "description": null,
      "network_address": "10.0.0.0/24",
      "inherited": false
    }
  ],
  "compute_resources": [
    {
      "id": 980190962,
      "name": "bigcompute",
      "provider": "Libvirt",
      "provider_friendly_name": "Libvirt",
      "inherited": false
    },
    {
      "id": 367690737,
      "name": "mycompute",
      "provider": "Libvirt",
      "provider_friendly_name": "Libvirt",
      "inherited": false
    }
  ],
  "media": [
    {
      "id": 980190962,
      "name": "CentOS 5.4",
      "inherited": false
    }
  ],
  "ptables": [],
  "provisioning_templates": [
    {
      "id": 269958254,
      "name": "MyString2",
      "template_kind_id": 983253650,
      "template_kind_name": "provision",
      "inherited": false
    }
  ],
  "domains": [
    {
      "id": 22495316,
      "name": "mydomain.net",
      "inherited": false
    },
    {
      "id": 589326610,
      "name": "yourdomain.net",
      "inherited": false
    }
  ],
  "realms": [
    {
      "id": 664044182,
      "name": "myrealm.net",
      "realm_proxy_id": 982965213,
      "realm_type": "FreeIPA",
      "inherited": false
    }
  ],
  "environments": [
    {
      "name": "production",
      "id": 334344675,
      "inherited": false
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null,
      "inherited": false
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": null,
      "created_at": "2021-05-18 15:53:37 UTC",
      "updated_at": "2021-05-18 15:53:37 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    }
  ]
}

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": "NlSymiVcRp, skqEaUFmXI"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2021-05-18 15:54:06 UTC",
  "updated_at": "2021-05-18 15:54:06 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626483,
  "name": "NlSymiVcRp, skqEaUFmXI",
  "title": "NlSymiVcRp, skqEaUFmXI",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": []
}

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/447626484
{
  "location": {
    "description": "鶷𧰁홾힑𫍈襛𡮉ˈ𤟷𤻘欫𠎒饐땸𠄥䓵𧅃𛲇𫼐罼𫚡𫵾𩐽씼𐃴𘨋娛注𡍨𗨶횚𧸭䶏쑍ꌞ𪣰稗襅椨呔𗟺𒆯𫟼긼𩠺㽘𬸋𗒜𗂛𤣁폩𨥎𫜢𫙁憲𨡠獩𧲢𨜷㽪蘺뀑𤠽𝘵𪍦𬈎𩵪𫾰𥒭晳𣲧𪂽𡒲𢖥𨤛𗼊鑔𘈌𐑢𡎠𣇻桐𥎜𥺮𨼯돱𤢖뗖ᅌ蛧𨹳吡佔𪭨𡩲𧰐𠜞𪜁𝓖𫢹𩥩𩔣씵𢞊𐭣큂絠湜𦺙𠶽㑡㝚𠭰撓𢍱𪘑츣𗬩𫫛𫧚𤠜뙔𩬴礞ꡜ𣏉㖋쑫𥓀𢘇𠱤𡖵㙤𦵻𬙶𝜄惾𩉒𧣆𧧹𢅮𥽤𩶐𩎾𑈩숴𬉹𡮭𩥥𒁨䇅𐂈𗗩𬏔𡔩𣱽ፖ𦃆𧮽𬠔ϫ慺뫣𦦮觜𢤟𦄌鉋𓉼𪆢潖녓ὦ𦾊𐛫𬍔𢖅ࢤ𘜀零𖣊ඝ𗥒𪊀𠚱𩬞𣡠𘍩氝ɡ汢𧵮𬲈词땵𧷬偮靹𦍼𘙬혎𗊯𣣨禒𘗫蒒䤗呼𡽴𠻁壁𨁵𨋅𩰒툐妢몇悪컔ܨ㣤𘖐𥚋𠛇𐝈쭶𦚉믚푧𧼳𘎖𖡘𬡺𧀊𝓻𬨗𩬞ᵥ𦮤𔑺𥻌䩟𥹤𪭯꿥𫵚𐒰𦀍鰾𥇞쑷𐛊茍鹘ᴻ𩍼躯𧱤𣐜㮹𘈰𠬓𧺂𫼗𖡠𪲾嵙𤶗𗞧譺𠹿𣎱𠼨𧬠䩿𠔝𫘡儯봂𩘗𬃬鐵𤅔杉𥃂䋂ן閗𐰃嫪𢾏𗳪贲焝춟𬘚𣍩ㅙ𤷆섯"
  }
}
201
{
  "select_all_types": [],
  "description": "鶷𧰁홾힑𫍈襛𡮉ˈ𤟷𤻘欫𠎒饐땸𠄥䓵𧅃𛲇𫼐罼𫚡𫵾𩐽씼𐃴𘨋娛注𡍨𗨶횚𧸭䶏쑍ꌞ𪣰稗襅椨呔𗟺𒆯𫟼긼𩠺㽘𬸋𗒜𗂛𤣁폩𨥎𫜢𫙁憲𨡠獩𧲢𨜷㽪蘺뀑𤠽𝘵𪍦𬈎𩵪𫾰𥒭晳𣲧𪂽𡒲𢖥𨤛𗼊鑔𘈌𐑢𡎠𣇻桐𥎜𥺮𨼯돱𤢖뗖ᅌ蛧𨹳吡佔𪭨𡩲𧰐𠜞𪜁𝓖𫢹𩥩𩔣씵𢞊𐭣큂絠湜𦺙𠶽㑡㝚𠭰撓𢍱𪘑츣𗬩𫫛𫧚𤠜뙔𩬴礞ꡜ𣏉㖋쑫𥓀𢘇𠱤𡖵㙤𦵻𬙶𝜄惾𩉒𧣆𧧹𢅮𥽤𩶐𩎾𑈩숴𬉹𡮭𩥥𒁨䇅𐂈𗗩𬏔𡔩𣱽ፖ𦃆𧮽𬠔ϫ慺뫣𦦮觜𢤟𦄌鉋𓉼𪆢潖녓ὦ𦾊𐛫𬍔𢖅ࢤ𘜀零𖣊ඝ𗥒𪊀𠚱𩬞𣡠𘍩氝ɡ汢𧵮𬲈词땵𧷬偮靹𦍼𘙬혎𗊯𣣨禒𘗫蒒䤗呼𡽴𠻁壁𨁵𨋅𩰒툐妢몇悪컔ܨ㣤𘖐𥚋𠛇𐝈쭶𦚉믚푧𧼳𘎖𖡘𬡺𧀊𝓻𬨗𩬞ᵥ𦮤𔑺𥻌䩟𥹤𪭯꿥𫵚𐒰𦀍鰾𥇞쑷𐛊茍鹘ᴻ𩍼躯𧱤𣐜㮹𘈰𠬓𧺂𫼗𖡠𪲾嵙𤶗𗞧譺𠹿𣎱𠼨𧬠䩿𠔝𫘡儯봂𩘗𬃬鐵𤅔杉𥃂䋂ן閗𐰃嫪𢾏𗳪贲焝춟𬘚𣍩ㅙ𤷆섯",
  "created_at": "2021-05-18 15:54:06 UTC",
  "updated_at": "2021-05-18 15:54:06 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626484,
  "name": "loc220",
  "title": "loc220",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "organizations": [],
  "hosts_count": 0,
  "parameters": []
}

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-05-18T15:53:37.335Z",
  "updated_at": "2021-05-18T15:53:37.335Z",
  "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.