Root Resource
Properties
Relations
- city:by-id resource: City - Detailed information about a city
- city:search resource: CitySearchResults - The results of a city search
- continent:by-id resource: Continent - The detailed information for a continent
- continent:list resource: ContinentList - List of continents
- country:by-id resource: Country - The detailed information for a country
- country:list resource: CountryList - List of countries
- flock:create-plan resource: FlockPlan - Flock plan for gathering people around the world to a common meeting place
- location:by-coordinates resource: Location - A point-location identified by geographical coordinates
- tz:by-id resource: Timezone - Detailed information of a timezone
- tz:list resource: TimezoneList - List of timezones
- ua:by-id resource: UrbanArea - Teleport urban area (aka Teleport City)
- ua:list resource: UrbanAreaList - The list of all urban areas
Example
{
"_links": {
"city:by-id": {
"href": "https://api.teleport.org/api/cities/{city_id}/",
"templated": true
},
"city:search": {
"href": "https://api.teleport.org/api/cities/{?search}",
"templated": true
},
"continent:by-id": {
"href": "https://api.teleport.org/api/continents/{continent_id}/",
"templated": true
},
"continent:list": {
"href": "https://api.teleport.org/api/continents/"
},
"country:by-id": {
"href": "https://api.teleport.org/api/countries/{country_id}/",
"templated": true
},
"country:list": {
"href": "https://api.teleport.org/api/countries/"
},
"curies": [
{
"href": "https://developers.teleport.org/api/resources/Location/#!/relations/{rel}/",
"name": "location",
"templated": true
},
{
"href": "https://developers.teleport.org/api/resources/City/#!/relations/{rel}/",
"name": "city",
"templated": true
},
{
"href": "https://developers.teleport.org/api/resources/UrbanArea/#!/relations/{rel}/",
"name": "ua",
"templated": true
},
{
"href": "https://developers.teleport.org/api/resources/Country/#!/relations/{rel}/",
"name": "country",
"templated": true
},
{
"href": "https://developers.teleport.org/api/resources/Admin1Division/#!/relations/{rel}/",
"name": "a1",
"templated": true
},
{
"href": "https://developers.teleport.org/api/resources/Timezone/#!/relations/{rel}/",
"name": "tz",
"templated": true
}
],
"flock:create-plan": {
"href": "https://api.teleport.org/api/flock/plans/"
},
"location:by-coordinates": {
"href": "https://api.teleport.org/api/locations/{coordinates}/",
"templated": true
},
"self": {
"href": "https://api.teleport.org/api/"
},
"tz:by-id": {
"href": "https://api.teleport.org/api/timezones/{tz_id}/",
"templated": true
},
"tz:list": {
"href": "https://api.teleport.org/api/timezones/"
},
"ua:by-id": {
"href": "https://api.teleport.org/api/urban_areas/{ua_id}/",
"templated": true
},
"ua:list": {
"href": "https://api.teleport.org/api/urban_areas/"
}
}
}