| API OPTIONS | Locations | Services | Contacts | Escalations | Events | Polling-Policy | Users | Access | Customers | BusinessServices |
|---|
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 | {
"Address1": "",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "xx.xxxxxxx",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": ""
}
|
| 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 | {
"Address1": "",
"Address2": "",
"City": "Amsterdam",
"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 | Update location entry | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json | {
"Address1": "",
"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 param.json | {
"redirect_to": null,
"success": 1
}
|
| ||||||
Services | Create | POST | http://host/en/omk/admin/api/v2/services.json | new services in NMIS configurations. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services.json | {
"Description": "Dummy Entry for API",
"Name": "dummy",
"Poll_Interval": "5m",
"Port": "",
"Service_Name": "dummy.exe",
"Service_Type" : "new_type"
}
|
| Services | GET | GET | http://host/en/omk/admin/api/v2/services.json | Services present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services.json | |
| Services | GET | GET | http://host/en/omk/admin/api/v2/services/{service-name}.json | Services present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy.json | {
"Description": "Dummy Entry for API",
"Name": "dummy",
"Poll_Interval": "5m",
"Port": "",
"Service_Name": "dummy.exe",
"Service_Type": "new_type",
"_id": "dummy"
}
|
| Services | Update | PUT | http://host/en/omk/admin/api/v2/services/{service-name}.json | Update Services entry | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumy.json | {
"Description": "Dummy Entry for API",
"Name": "dummy_updated",
"Poll_Interval": "10m",
"Port": "",
"Service_Name": "dummy.exe",
"Service_Type" : "new_type"
}
|
| Services | Delete | DELETE | http://host/en/omk/admin/api/v2/services/{service-name}.json | Deletes the Service entry from configurations | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json | {
"redirect_to": null,
"success": 1
}
|
| ||||||
Contacts | Create | POST | http://host/en/omk/admin/api/v2/contacts/.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json | {
"Contact": "Test-Contact",
"DutyTime": "",
"Email": "",
"Level": "",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": ""
}
| |
| Contacts | GET | GET | http://host/en/omk/admin/api/v2/contacts/.json | http://host/en/omk/admin/api/v2/contacts.json | ||
| Contacts | GET | GET | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json | {
"Contact": "Test-Contact",
"DutyTime": "",
"Email": "",
"Level": "",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": "",
"_id": "Test-Contact"
}
| |
| Contacts | Update | PUT | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json | {
"Contact": "Test-Contact",
"DutyTime": "1",
"Email": "test@gmail.com",
"Level": "",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": ""
}
| |
| Contacts | Delete | DELETE | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
Escalations | Create | POST | ||||
| Escalations | GET | GET | ||||
| GET | GET | |||||
| Escalations | Update | PUT | ||||
| Escalations | Delete | DELETE | ||||
| ||||||
Events | Create | |||||
| Events | GET | GET | ||||
| GET | GET | |||||
| Events | Update | PUT | ||||
| Events | Delete | DELETE | ||||
| ||||||
| Polling-Policy | Create | POST | ||||
| Polling-Policy | ||||||
| Polling-Policy | ||||||
| Polling-Policy | ||||||
| Polling-Policy | ||||||
| ||||||
| Users | Create | POST | ||||
| Users | ||||||
| Users | ||||||
| Users | ||||||
| Users | ||||||
| ||||||
| Access | Create | POST | ||||
| Access | ||||||
| Access | ||||||
| Access | ||||||
| Access | ||||||
| ||||||
| Customers | Create | POST | ||||
| Customers | ||||||
| Customers | ||||||
| Customers | ||||||
| Customers | ||||||
| ||||||
| Business Services | Create | POST | ||||
| Business Services | ||||||
| Business Services | ||||||
| Business Services | ||||||
| Business Services | ||||||