The Locations API allows you to manage geographic or logical groupings for your nodes. Locations help organize nodes by datacenter, region, or any other grouping that makes sense for your deployment.
List Locations curl "https://panel.example.com/api/application/locations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Retrieves a paginated list of all locations on the Panel.
Query Parameters Number of results per page
Filter locations by short identifier
Filter locations by description
Sort by field. Available: id. Prefix with - for descending order
Include related resources. Available: nodes, servers
Response Array of location objects Short identifier code (1-60 characters)
Full description of the location
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
{ "object" : "list" , "data" : [ { "object" : "location" , "attributes" : { "id" : 1 , "short" : "us-west" , "long" : "United States - West Coast" , "updated_at" : "2024-01-01T00:00:00+00:00" , "created_at" : "2024-01-01T00:00:00+00:00" } }, { "object" : "location" , "attributes" : { "id" : 2 , "short" : "eu-central" , "long" : "Europe - Central" , "updated_at" : "2024-01-15T00:00:00+00:00" , "created_at" : "2024-01-15T00:00:00+00:00" } } ], "meta" : { "pagination" : { "total" : 2 , "count" : 2 , "per_page" : 50 , "current_page" : 1 , "total_pages" : 1 } } }
Get Location Details curl "https://panel.example.com/api/application/locations/{location_id}" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Retrieves details for a specific location.
Path Parameters The internal ID of the location
Query Parameters Include related resources. Available: nodes, servers
Response { "object" : "location" , "attributes" : { "id" : 1 , "short" : "us-west" , "long" : "United States - West Coast" , "updated_at" : "2024-01-01T00:00:00+00:00" , "created_at" : "2024-01-01T00:00:00+00:00" } }
Create Location curl -X POST "https://panel.example.com/api/application/locations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "short": "us-east", "long": "United States - East Coast" }'
Creates a new location on the Panel.
Request Body Short identifier code for the location (1-60 characters, must be unique)
Full description of the location (optional, max 191 characters)
Response Returns the created location object with HTTP status 201 Created.
{ "object" : "location" , "attributes" : { "id" : 3 , "short" : "us-east" , "long" : "United States - East Coast" , "updated_at" : "2024-03-04T00:00:00+00:00" , "created_at" : "2024-03-04T00:00:00+00:00" }, "meta" : { "resource" : "https://panel.example.com/api/application/locations/3" } }
Update Location curl -X PATCH "https://panel.example.com/api/application/locations/{location_id}" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "short": "us-east-1", "long": "United States - East Coast (Primary)" }'
Updates an existing location.
Path Parameters The internal ID of the location to update
Request Body All fields are optional. Only include fields you want to update.
New short identifier code (must be unique)
Response Returns the updated location object.
{ "object" : "location" , "attributes" : { "id" : 3 , "short" : "us-east-1" , "long" : "United States - East Coast (Primary)" , "updated_at" : "2024-03-04T12:00:00+00:00" , "created_at" : "2024-03-04T00:00:00+00:00" } }
Delete Location curl -X DELETE "https://panel.example.com/api/application/locations/{location_id}" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Deletes a location from the Panel. The location must not have any nodes assigned to it.
Path Parameters The internal ID of the location to delete
Response Returns HTTP status 204 No Content on successful deletion.
A location cannot be deleted if it has any nodes assigned to it. Reassign or delete the nodes first.
Usage Examples Creating a Multi-Region Setup # Create locations for different regions curl -X POST "https://panel.example.com/api/application/locations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"short": "us-west", "long": "United States - West"}' curl -X POST "https://panel.example.com/api/application/locations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"short": "eu-central", "long": "Europe - Central"}' curl -X POST "https://panel.example.com/api/application/locations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"short": "ap-south", "long": "Asia Pacific - South"}'
Listing Locations with Nodes curl "https://panel.example.com/api/application/locations?include=nodes" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
