GET /api/locations
List all locations

Params

Param name Description
search
optional

filtrera resultat

Validations:

  • Must be a String

order
optional

sortera resultat

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

antal poster per begäran

Validations:

  • Must be a String


GET /api/locations/:id
Show a location

Params

Param name Description
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

Params

Param name Description
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[config_template_ids]
optional , nil allowed

Provisioning template 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


PUT /api/locations/:id
Update a location

Params

Param name Description
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[config_template_ids]
optional , nil allowed

Provisioning template 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

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

Params

Param name Description
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.