Locations

>>>

GET /api/locations
List all locations

Examples

GET /api/locations
200
{
  "total": 28,
  "subtotal": 28,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": "title",
    "order": "DESC"
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626470,
      "name": "z",
      "title": "z",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626469,
      "name": "y",
      "title": "y",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626468,
      "name": "x",
      "title": "x",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626467,
      "name": "w",
      "title": "w",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626466,
      "name": "v",
      "title": "v",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626465,
      "name": "u",
      "title": "u",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626464,
      "name": "t",
      "title": "t",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626463,
      "name": "s",
      "title": "s",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626462,
      "name": "r",
      "title": "r",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626461,
      "name": "q",
      "title": "q",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626460,
      "name": "p",
      "title": "p",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626459,
      "name": "o",
      "title": "o",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626458,
      "name": "n",
      "title": "n",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626457,
      "name": "m",
      "title": "m",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:45 UTC",
      "updated_at": "2019-11-07 09:01:45 UTC",
      "id": 373111740,
      "name": "Location 2",
      "title": "Location 2",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:45 UTC",
      "updated_at": "2019-11-07 09:01:45 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626456,
      "name": "l",
      "title": "l",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626455,
      "name": "k",
      "title": "k",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626454,
      "name": "j",
      "title": "j",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 09:01:48 UTC",
      "updated_at": "2019-11-07 09:01:48 UTC",
      "id": 447626453,
      "name": "i",
      "title": "i",
      "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

Validations:

  • Must be a number.

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/447626454
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-11-07 08:34:06 UTC",
  "updated_at": "2019-11-07 08:34:06 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626454,
  "name": "loc12",
  "title": "loc12",
  "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": "2019-11-07 08:34:06 UTC",
      "updated_at": "2019-11-07 08:34:06 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": "string",
      "value": "*****"
    }
  ]
}

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": {}
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

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/447626473
{
  "location": {
    "name": "XOJvGidQ3V"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-11-07 09:01:49 UTC",
  "updated_at": "2019-11-07 09:01:49 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626473,
  "name": "XOJvGidQ3V",
  "title": "XOJvGidQ3V",
  "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

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/447626472-loc304
{
  "location": {}
}
404
{
  "error": {
    "message": "Resource location not found by id '447626472-loc304'"
  }
}

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.