Public API for NMIS configuration. "omk/admin/api/v2/"
...
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 this methods are authenticated.
Operation | Method | URL | Example | ||
---|---|---|---|---|---|
Authenticate | POST | http://host/en/omk/admin/login |
|
We should receive a 200 response and a cookie, that we can reuse for next API calls.
Example:-
Important: All this methods are authenticated.
Operation | Method | URL | Example | ||
---|---|---|---|---|---|
Authenticate | POST | http://host/en/omk/admin/login |
|
We should receive a 200 response and a cookie, that we can reuse for next API calls.
Name | Operation | Method | URL | Response | Example | code-block | |||||
---|---|---|---|---|---|---|---|---|---|---|---|
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 |
| |||||
Locations | GET | 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 | ||||||
Locations | GET | 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 |
| |||||
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 param.json |
| |||||
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 param.json |
|
Important: All this methods are authenticated.
...
Operation
...
Method
...
URL
...
Example
...
Code Block |
---|
{"username": "username", "password": "password"} |
...