| 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 | Create a new contact | 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 | get contact information present in configuration | http://host/en/omk/admin/api/v2/contacts.json | |
| Contacts | GET | GET | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | get specific contact information using API | 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 | Update the contact data present in configuration file | 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 | delete the contact data. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json | {
"redirect_to": null,
"success": 1
}
|
| ||||||
Escalations | Create | POST | http://host/en/omk/admin/api/v2/escalations.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json | {
"Event": null,
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": "",
"Level1": "",
"Level10": "",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null
}
| |
| Escalations | GET | GET | http://host/en/omk/admin/api/v2/escalations.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json | ||
| GET | GET | http://host/en/omk/admin/api/v2/escalations/{escalation-event}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json | {
"Event": null,
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": "",
"Level1": "",
"Level10": "",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null,
"_id": "test"
}
| ||
| Escalations | Update | PUT | http://host/en/omk/admin/api/v2/escalations/{escalation-event}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json | {
"Event": "test",
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": "",
"Level1": "",
"Level10": "",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null
}
| |
| Escalations | Delete | DELETE | http://host/en/omk/admin/api/v2/escalations/{escalation-event}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
Events | Create | POST | http://host/en/omk/admin/api/v2/events.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json | {
"CancelingEvent": "N/A",
"Description": "test event API",
"Event": "Self-test-API",
"Log": "true",
"Notify": "true",
"Stateful": "false",
"Status": "false"
}
| |
| Events | GET | GET | http://host/en/omk/admin/api/v2/events.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json | ||
| Events | GET | GET | http://host/en/omk/admin/api/v2/events/{event-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json | {
"CancelingEvent": "N/A",
"Description": "test event API",
"Event": "Self-test-API",
"Log": "true",
"Notify": "true",
"Stateful": "false",
"Status": "false",
"_id": "Self-test-API"
}
| |
| Events | Update | PUT | http://host/en/omk/admin/api/v2/events/{event-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json |
{
"Description": "test event API",
"Event": "test",
"Log": "true-change",
"Notify": "true",
"Stateful": "false",
"Status": "false"
}
| |
| Events | Delete | DELETE | http://host/en/omk/admin/api/v2/events/{event-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
| Polling-Policy | Create | POST | http://host/en/omk/admin/api/v2/polling-policy.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json | {
"description": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
}
| |
| Polling-Policy | GET | GET | http://host/en/omk/admin/api/v2/polling-policy.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json | ||
| Polling-Policy | GET | GET | http://host/en/omk/admin/api/v2/polling-policy/{policy name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json | {
"_id": "very_very_infrequently",
"description": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
}
| |
| Polling-Policy | Update | PUT | http://host/en/omk/admin/api/v2/polling-policy/{policy name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json | {
"description": "poll",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
}
| |
| Polling-Policy | Delete | DELETE | http://host/en/omk/admin/api/v2/polling-policy/{policy name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
| Users | Create | POST | http://host/en/omk/admin/api/v2/users.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json | {
"admission": "true",
"groups": "all",
"privilege": "administrator",
"user": "test"
}
| |
| Users | GET | GET | http://host/en/omk/admin/api/v2/users.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json | ||
| Users | GET | GET | http://host/en/omk/admin/api/v2/users/{user:name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/test.json | {
"_id": "test",
"admission": "true",
"groups": [
"all"
],
"privilege": "administrator",
"user": "test"
}
| |
| Users | Update | PUT | http://host/en/omk/admin/api/v2/users/{user:name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/test.json | {
"admission": "false",
"groups": [
"all"
],
"privilege": "administrator",
"user": "test"
}
| |
| Users | Delete | DELETE | http://host/en/omk/admin/api/v2/users/{user:name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/test.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
| Access | Create | POST | http://host/en/omk/admin/api/v2/access.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.json | {
"descr": "Enable button Logs",
"group": "button",
"level0": "1",
"level1": "0",
"level2": "0",
"level3": "0",
"level4": "0",
"level5": "0",
"name": "test_logs"
}
| |
| Access | GET | GET | http://host/en/omk/admin/api/v2/access.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.json | ||
| Access | GET | GET | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json | {
"_id": "test_logs",
"descr": "Enable button Logs",
"group": "button",
"level0": "1",
"level1": "0",
"level2": "0",
"level3": "0",
"level4": "0",
"level5": "0",
"name": "test_logs"
}
| |
| Access | Update | PUT | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json | {
"_id": "test_logs",
"descr": "Enable button Logs",
"group": "button new",
"level0": "1",
"level1": "0",
"level2": "0",
"level3": "0",
"level4": "0",
"level5": "0",
"name": "test_logs"
}
| |
| Access | Delete | DELETE | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
| Customers | Create | POST | http://host/en/omk/admin/api/v2/customers.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json |
{
"customer": "test",
"description": "",
"groups": "",
"locations": null
}
| |
| Customers | GET | GET | http://host/en/omk/admin/api/v2/customers.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json | ||
| Customers | GET | GET | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json |
{
"_id": "test",
"customer": "test",
"description": "",
"groups": "",
"locations": null
}
| |
| Customers | Update | PUT | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json | {
"customer": "test",
"description": "this is test",
"groups": "",
"locations": null
}
| |
| Customers | Delete | DELETE | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json | {
"redirect_to": null,
"success": 1
}
| |
| ||||||
| Business Services | Create | POST | http://host/en/omk/admin/api/v2/businessservices.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices.json | {
"businessPriority": "10",
"businessService": "test",
"businessUnit": "Sales",
"serviceType": "Revenue Generating"
}
| |
| Business Services | GET | GET | http://host/en/omk/admin/api/v2/businessservices.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices.json | ||
| Business Services | GET | GET | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices/test.json | {
"_id": "test",
"businessPriority": "10",
"businessService": "test",
"businessUnit": "Sales",
"serviceType": "Revenue Generating"
}
| |
| Business Services | Update | PUT | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices/test.json | {
"businessPriority": "11",
"businessService": "test",
"businessUnit": "Sales",
"serviceType": "Revenue Generating"
}
| |
| Business Services | Delete | DELETE | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices/test.json | {
"redirect_to": null,
"success": 1
}
| |