mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
8f474dd4d4
* Rework documentation * Slightly adjust theme * wip * fixes * Remove unneeded header * Re-added Acknowledgement.md file * Added Acknowledgement.md to mkdocs.yml Co-authored-by: Neil Lathwood <gh+n@laf.io>
1.3 KiB
1.3 KiB
add_location
Add a new location
Route: /api/v0/locations/
Input:
- location: name of the new location
- lat: latitude
- lng: longitude
- fixed_coordinates: 0 if updated from the device or 1 if the coordinate is fixed (default is fixed if lat and lng are valid)
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"
}