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
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-09-11 14:53:14 UTC",
      "updated_at": "2019-09-11 14:53:14 UTC",
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-09-11 14:53:14 UTC",
      "updated_at": "2019-09-11 14:53:14 UTC",
      "id": 373111740,
      "name": "Location 2",
      "title": "Location 2",
      "description": null
    }
  ]
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

search
Optional

filtrera resultat

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.


GET /api/locations/:id
Show a location

Examples

GET /api/locations/447626439
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-09-11 14:52:11 UTC",
  "updated_at": "2019-09-11 14:52:11 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "loc277",
  "title": "loc277",
  "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-09-11 14:52:11 UTC",
      "updated_at": "2019-09-11 14:52:11 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": null,
      "value": "*****"
    }
  ]
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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": "loc1"
  }
}
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: create_locations"
  }
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

location
Required

Validations:

  • Must be a Hash

location[name]
Required

Validations:

  • Must be a String

location[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

location[user_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

location[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

location[medium_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

location[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

location[domain_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

location[realm_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

location[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

location[environment_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

location[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

location[parent_id]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

Examples

POST /api/locations/447626467
{
  "location": {
    "name": "473EPyJkvq"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-09-11 14:53:16 UTC",
  "updated_at": "2019-09-11 14:53:16 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626467,
  "name": "473EPyJkvq",
  "title": "473EPyJkvq",
  "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

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

location
Required

Validations:

  • Must be a Hash

location[name]
Optional

Validations:

  • Must be a String

location[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

location[user_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

User IDs

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

location[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

location[medium_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

location[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Provisioning template IDs

Validations:

  • Must be an array of any type

location[domain_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Domain IDs

Validations:

  • Must be an array of any type

location[realm_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

location[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Host group IDs

Validations:

  • Must be an array of any type

location[environment_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Environment IDs

Validations:

  • Must be an array of any type

location[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

location[parent_id]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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/373111740-Location%202
{
  "location": {}
}
200
{
  "id": 373111740,
  "name": "Location 2",
  "created_at": "2019-09-11T14:53:14.096Z",
  "updated_at": "2019-09-11T14:53:14.096Z",
  "ignore_types": [],
  "ancestry": null,
  "title": "Location 2",
  "description": null
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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.