Pterodactyl API v1
Locations

Location details

Retrieves the specified location

Available include parameters

ParameterDescription
nodesList of nodes assigned to the location
serversList of servers in the location
GET/api/application/locations/{location}

Authorization

ApplicationToken
AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Path Parameters

location*integer

Location ID

Query Parameters

include?string

Comma-separated list of related resources to embed in each returned object. Accepted values are listed in the include-parameters table above.

Response Body

application/json

curl -X GET "https://pterodactyl.file.properties/api/application/locations/1?include=nodes%2Cservers" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"
{
  "object": "location",
  "attributes": {
    "id": 1,
    "short": "Test",
    "long": "Test",
    "updated_at": "2019-12-22T04:44:18+00:00",
    "created_at": "2019-12-22T04:44:18+00:00"
  }
}