GET /api/v1/locations.json
Fetch locations for all regions

GET /api/v1/region/:region/locations.json
Fetch locations for a single region

This will also return a list of machines at each location

Supported Formats

json

Params

Param name Description
region
required

Name of the Region you want to see events for

Validations:

  • Must be a String
by_location_name
optional

Name of location to search for

Validations:

  • Must be a String
by_location_id
optional

Location ID to search for

Validations:

  • Must be a Integer
by_machine_id
optional

Machine ID to find in locations

Validations:

  • Must be a Integer
by_ipdb_id
optional

IPDB ID to find in locations

Validations:

  • Must be a Integer
by_opdb_id
optional

OPDB ID to find in locations

Validations:

  • Must be a Integer
by_machine_name
optional

Find machine name in locations

Validations:

  • Must be a String
by_city_id
optional

City to search for

Validations:

  • Must be a String
by_state_id
optional

State to search for

Validations:

  • Must be a String
by_machine_group_id
optional

Machine Group to search for

Validations:

  • Must be a String
by_zone_id
optional

Zone ID to search by

Validations:

  • Must be a Integer
by_operator_id
optional

Operator ID to search by

Validations:

  • Must be a Integer
by_type_id
optional

Location type ID to search by

Validations:

  • Must be a Integer
by_at_least_n_machines
optional

Only locations with N or more machines

Validations:

  • Must be a Integer
by_at_least_n_machines_type
optional

Only locations with N or more machines

Validations:

  • Must be a Integer
by_is_stern_army
optional

Send only locations labeled as Stern Army

Validations:

  • Must be a Integer
no_details
optional

Omit lmx/condition data from pull

Validations:

  • Must be a Integer
with_lmx
optional

Include location machine details such as comments

Validations:

  • Must be a Integer
regionless_only
optional

Show only regionless locations

Validations:

  • Must be a Integer