System Admin Configuration API
- Arihant Bansal
- John Sinclair
Public API for NMIS configuration. "omk/admin/api/v2/"
We can manage the Administration Configuration resources below using these endpoints - http://host/omk/admin/api/v2/resource
Resource is our term for items in a configuration file or database.
Our current resource list consists of locations, contacts, services, escalations, events, polling-policy, users, access, customers and businessservices.
The resources can be accessed using the web interface or the API.
API Routes
Each resource has a consistent set of operations
Request Method | Operation | URL Example | id required | Notes |
|---|---|---|---|---|
| POST | create | /resource | n | Insert a new resource. |
| GET | read list | /resource | n | Returns a list of resources. |
| GET | read one | /resource/id | y | Returns the details of a resource. |
| PUT | update | /resource/id | y | Update the details of a resource. |
| DELETE | delete | /resource/id | y | Delete a resource. |
| API for Resources: | Locations | Services | Contacts | Escalations | Events | Polling-Policy | Users | Access | Customers | BusinessServices |
|---|
This API can help you to manage the below operations for the given admin configurations. (Please see the link for All System Admin Configurations).
Important: All the operations are authenticated.
Operation | Method | URL | Example |
|---|---|---|---|
| Authenticate | POST | http://host/en/omk/admin/login | {"username": "your username", "password": "your password"}
|
We should receive a 200 response and a cookie, that we can reuse for next API calls.
Example:-
| Resource | Operation | Method | URL | Response | Example |
|---|---|---|---|---|---|
| Locations | Create | POST | http://host/en/omk/admin/api/v2/locations.json | New Location in NMIS configurations. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json {
"Address1": "",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "xx.xxxxxxx",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": ""
}
|
| Locations | Read list | GET | http://host/en/omk/admin/api/v2/locations.json | Locations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json [
{
"Address1": "Eden",
"Address2": "",
"City": "Wellington",
"Country": "New Zealand",
"Floor": "",
"Geocode": "Island Bay, Wellington, New Zealand",
"Latitude": "-41.3372593",
"Location": "Island Bay DC",
"Longitude": "174.7726262",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": "Island Bay",
"_id": "Island Bay DC"
},
{
"Address1": "",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "Melbourne VIC, Australia",
"Latitude": "-37.8136276",
"Location": "MelbourneDC",
"Longitude": "144.9630576",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": "",
"_id": "MelbourneDC"
}
]
|
| Locations | Read one | GET | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Locations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Amsterdam.json {
"Address1": "",
"Address2": "",
"City": "",
"Country": "Netherlands",
"Floor": "",
"Geocode": "Amsterdam, Netherlands",
"Latitude": "52.3675734",
"Location": "Amsterdam",
"Longitude": "4.9041389",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": "",
"_id": "Amsterdam"
}
|
| Locations | Update | PUT | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Updated location entry | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory%20param.json {
"Address1": "42 Main Street",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "yy.yyyyyyy",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": ""
}
|
| Locations | Delete | DELETE | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Deletes the location entry from configurations | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory%20param.json {
"redirect_to": null,
"success": 1
}
|