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.