librenms-librenms/doc/API/Locations.md

source: API/Locations.md path: blob/master/doc/

add_location

Add a new location

Route: /api/v0/locations/

Input:

• location: name of the new location
• lat: latitude
• lng: longitude

Example:

curl -X POST -d '{"location":"Google", "lat":"37.4220041","lng":"-122.0862462"}' -H 'X-Auth-Token:YOUR-API-TOKEN' https://librenms.org/api/v0/locations

Output:

{
    "status": "ok",
    "message": "Location added with id #45"
}

delete_location

Deletes an existing location

Route: /api/v0/locations/location

• location: name of the location to delete

Example:

curl -X DELETE -H 'X-Auth-Token:YOUR-API-TOKEN' https://librenms.org/api/v0/locations/Google

Output:

{
    "status": "ok",
    "message": "Location Google has been deleted successfully"

}

edit_location

Edits a location

Route: /api/v0/locations/location

• location: name of the location to edit

Input:

• lat: latitude
• lng: longitude

Example:

curl -X PATCH -d '{"lng":"100.0862462"}' -H 'X-Auth-Token:YOUR-API-TOKEN' https://librenms.org/api/v0/locations/Google

Output:

{
    "status": "ok",
    "message": "Location updated successfully"
}