---
title: "List All Location Beacons"
method: GET
path: "/v1/locations/beacons"
tags: ["Locations"]
---

# List All Location Beacons

`GET /v1/locations/beacons`

## Request

- Base URL: `https://api.edgegap.com`
- URL: `https://api.edgegap.com/v1/locations/beacons`
- Auth: API key in header `authorization`

List all the active location beacons. They can be used to ping them for your matchmaking system. You cannot deploy on beacons.

## Response `200`

Success

- LocationBeaconList
  - `locations` ApiModelLocationbeacon[]: Total number of active location beacons
    - `host` string, required: The URL of the pingable location.
    - `fqdn` string: Auto Generated Field for fqdn
    - `udp_port` integer: The open UDP port number for UDP pings, if available.
    - `tcp_port` integer: The open TCP port number for TCP pings, if available.
    - `location` ApiModelLocation, required
      - `city` string, required: City of the object
      - `country` string, required: Country of the object
      - `continent` string, required: Continent of the object
      - `administrative_division` string, required: Administrative division of the object
      - `timezone` string, required: Timezone of the object
      - `latitude` number, required: Latitude of the object
      - `longitude` number, required: Longitude of the object
  - `count` integer: List of active location beacons

## Other responses

- `500`: Internal Server Error

---

[API](https://skmtc.dev/edgegap/apis/edgegap-v1.md) · [All operations](https://skmtc.dev/edgegap/apis/edgegap-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/edgegap/apis/edgegap-v1/revisions/9fa2b393a6be?raw)