| Operation | Method | URL | Response | Example |
---|
| 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 Code Block |
---|
{
"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 Code Block |
---|
{
"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 Code Block |
---|
| {
"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 | |
|
| 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 Code Block |
---|
{
"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 Code Block |
---|
{
"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 Code Block |
---|
| {
"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 | |
|
---|
| 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 Code Block |
---|
{
"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 Code Block |
---|
{
"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 Code Block |
---|
{
"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. | |
|
| Create | POST | http://host/en/omk/admin/api/v2/escalations.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json Code Block |
---|
{
"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 Code Block |
---|
{
"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,
" |
| success | 1 |
anchorEscalations | servicesUpdate | services | | Create | POST | PUT | http://host/en/omk/admin/api/v2/servicesescalations/{escalation-event}.json | new services in NMIS configurations. |
| servicesescalations/test.json Code Block |
---|
{
"DescriptionEvent": "Dummy Entry for APItest",
"NameEvent_Element": "dummy",
"PollEvent_IntervalNode": "5m",
"PortGroup": "",
"Service_NameLevel0": "dummy.exe",
"Service_TypeLevel1" : "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 | Code Block |
---|
{,
"Level10": "",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"DescriptionLevel8": "Dummy",
Entry for API"Level9": "",
"Name": "dummytest",
"Poll_IntervalRole": "5m"null,
"Type": null,
"Port": "",
"Service_Name": "dummy.exe","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 Code Block |
---|
{
"Serviceredirect_Typeto": "new_type"null,
"_idsuccess": "dummy"1
} |
| Services | Update | |
PUT |
| Create | POST | http://host/en/omk/admin/api/v2/services/{service-name}/events.json | Update Services entry |
| services/dumyevents.json Code Block |
---|
| {
{
"CancelingEvent": "N/A",
"Description": "Dummytest Entry forevent API",
"NameEvent": "dummy_updatedSelf-test-API",
"Poll_IntervalLog": "10mtrue",
"PortNotify": "true",
"Service_NameStateful": "dummy.exefalse",
"Service_TypeStatus" : "new_type"false"
} |
|
ServicesEvents | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/services/{service-name}events.jsonDeletes the Service entry from configurations |
| contacts | | Create | POST | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
contacts | events.json |
Events | GET | GET | http://host/en/omk/admin/api/v2/contactsevents/{event-name}.jsonCreate a new contact |
| /contacts/events/Self-test-API.json Code Block |
---|
{
"Contact "CancelingEvent": "Test-Contact "N/A",
"DutyTime "Description": "",
"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 "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/contactsevents/{contactevent-name}.json | get specific contact information using API |
| contactsTestContactAPI.json Code Block |
---|
{
"Contact "Description": "Test-Contacttest event API",
"DutyTime "Event": "test",
"Email "Log": "true-change",
"Level "Notify": "true",
"Location "Stateful": "false",
"Mobile "Status": "false",
"Pager": "",
"Phone": "",
"TimeZone": ""
} |
|
Events | Delete | DELETE | http://host/en/omk/admin/api/v2/events/{event-name}.json |
| | Contacts | Update | |
PUT Anchor |
---|
| polling-policy |
---|
| polling-policy |
---|
|
|
Polling-Policy | Create | POST | http://host/en/omk/admin/api/v2/contacts/{contact-name}polling-policy.json | Update the contact data present in configuration file |
| contacts/TestContactpolicy.json Code Block |
---|
{ {
"Contact": "Test-Contact", "DutyTimedescription": "1poll very infr_very.equently",
"Emailname": "test@gmail.comvery_very_infrequently",
"Level": "", "Locationping": "30m",
"Mobile": "", "Pagersnmp": "1h",
"Phoneupdate": "2d",
"TimeZonewmi": "1h"
} |
|
ContactsPolling-Policy | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/contacts/{contact-name}.jsondelete the contact data.polling-policy.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
escalations | escalations | | Create | POSTpolling-policy.json |
Polling-Policy | GET | GET | http://host/en/omk/admin/api/v2/escalationspolling-policy/{policy name}.json |
| escalations.json Code Block |
---|
{
"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 | GETpolling-policy/very_very_infrequently.json Code Block |
---|
{
"_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 Code Block |
---|
{
"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/escalationspolling-policy/{policy name}.json |
| /escalations.json | GET | GET/polling-policy/very_very_infrequently.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
Users | Create | POST | http://host/en/omk/admin/api/v2/escalations/{escalation-event}users.json |
| escalations/test.json Code Block | {
"Event": null,
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": "",
"Level1users.json Code Block |
---|
{
"admission": "true",
"Level10 "groups": "all",
"Level2 "privilege": "administrator",
"Level3 "user": "johnsmith",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null,
"_id": "test"
} |
Escalations |
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/johnsmith.json Code Block |
---|
{
"_id": "johnsmith",
"admission": "true",
"groups": [
"all"
],
"privilege": "administrator",
"user": "johnsmith"
} |
|
Users | Update | PUT | http://host/en/omk/admin/api/v2/escalationsusers/{escalation-eventuser:name}.json |
| escalationstestjohnsmith.json Code Block |
---|
{
"Event "admission": "testfalse",
"Event_Element "groups": "",
"Event_Node": "",
"Group": "",
"Level0[
"all"
],
"privilege": "administrator",
"Level1 "user": "johnsmith",
"Level10": "",
} |
|
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/johnsmith.json Code Block |
---|
{
"Level2redirect_to": ""null,
"Level3success": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null
} |
| Escalations | Delete | DELETE |
|
Access | Create | POST | http://host/en/omk/admin/api/v2/access.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.json Code Block |
---|
{
"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/escalations/{escalation-event}access.json |
| events | | Create | POST | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
events | .opmantek.net:8080/en/omk/admin/api/v2/access.json |
Access | GET | GET | http://host/en/omk/admin/api/v2/eventsaccess/{access-id}.json |
| eventstest_logs.json Code Block |
---|
{
"_id": "CancelingEvent": "N/A",
"Description": "test event API",
"Event": "Self-test-API",
"Log": "true",
"Notify": "true",
"Stateful": "false",
"Status": "false"
} |
| Events | GET | GET"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 | Events | GET | GET | http://host/en/omk/admin/api/v2/events/{event-namehttp://host/en/omk/admin/api/v2/events.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json | access/{access-id}.json |
| eventsSelf--API_logs.json Code Block |
---|
{
"CancelingEvent_id": "N/Atest_logs",
"Descriptiondescr": "test event APIEnable button Logs",
"Eventgroup": "Self-test-APIbutton new",
"Loglevel0": "true1",
"Notifylevel1": "true0",
"Statefullevel2": "false0",
"Statuslevel3": "false0",
"_idlevel4": "Self-test-API0"
} |
| 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 | Events,
"level5": "0",
"name": "test_logs"
} |
|
Access | Delete | DELETE | http://host/en/omk/admin/api/v2/eventsaccess/{eventaccess-nameid}.json |
| eventsSelf--API_logs.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
polling-policy | Polling-Policy | polling-policy | | |
Customers | Create | POST | http://host/en/omk/admin/api/v2/polling-policycustomers.json |
| polling-policycustomers.json Code Block |
---|
{
"description "customer": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
} |
Polling-Policy "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/polling{customer-policyname}.json |
| v2/polling-policy.json | Polling-Policy | GET | GETv2/customers/test.json Code Block |
---|
{
"_id": "test",
"customer": "test",
"description": "",
"groups": "",
"locations": null
} |
|
Customers | Update | PUT | http://host/en/omk/admin/api/v2/polling-policycustomers/{policy customer-name}.json |
| polling-policy/very_very_infrequentlycustomers/test.json Code Block |
---|
{
"_id": "very_very_infrequently",
"description": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping {
"customer": "30mtest",
"snmpdescription": "1hthis is test",
"updategroups": "2d",
"wmilocations": "1h" null
} |
|
Polling-PolicyCustomers | UpdateDelete | PUTDELETE | http://host/en/omk/admin/api/v2/polling-policycustomers/{policy customer-name}.json |
| polling-policy/very_very_infrequentlyDELETEcustomers/test.json Code Block |
---|
{
"description": "poll",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
} | | Polling-Policy | Delete |
"redirect_to": null,
"success": 1
} |
|
|
Business Services | Create | POST | http://host/en/omk/admin/api/v2/polling-policy/{policy name}businessservices.json |
| polling-policy/very_very_infrequentlybusinessservices.json Code Block |
---|
{
"businessPriority": "10",
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
users | users | Users | Create | POST | Users | GET | GET | Users | GET | GET | Users | Update | PUT | Users | Delete | DELETE | Anchor |
---|
access | access | Access | Create | POST | Access | GET | GET | Access | GET | GET | Access | Update | PUT | Access | Delete | DELETE | Anchor |
---|
customers | customers | Customers | Create | POST | Customers | GET | GET | Customers | GET | GET | Customers | Update | PUT | Customers | Delete | DELETE | Anchor |
---|
business | business | Business Services | Create | POST | Business Services | GET | GET | Business Services | GET | GET | Business Services | Update | PUT | Business Services | Delete | DELETE "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 Code Block |
---|
{
"_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 |
| Code Block |
---|
{
"businessPriority": "11",
"businessService": "test",
"businessUnit": "Sales",
"serviceType": "Revenue Generating"
} |
|
Business Services | Delete | DELETE | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| |