| 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 | /locations/services/{service-name}.json | new Location in NMIS configurations.Update Services entry | | locations |
{
"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 |
---|
| {
"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 | /locations/services/{service-name}.json | Locations present in NMIS configuration file.Deletes the Service entry from configurations | | locationsGET | Locations | GET | Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
---|
| Create | POST | http://host/en/omk/admin/api/v2/locations{location-name}v2/contacts.json | Locations present in NMIS configuration file.Create a new contact | locations/Amsterdamcontacts.json Code Block |
---|
{
"Address1": "",
"Address2": "",
"City": "Amsterdam",
"Country": "Netherlands",
"Floor": "",
"GeocodeContact": "Amsterdam, NetherlandsTest-Contact",
"LatitudeDutyTime": "52.3675734",
"LocationEmail": "Amsterdam",
"LongitudeLevel": "4.9041389",
"PostcodeLocation": "",
"RoomMobile": "",
"StatePager": "",
"SuburbPhone": "",
"_idTimeZone": "Amsterdam"
} |
| Locations | Update | PUT |
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/ | locationscontacts/{ | locationcontact-name}.json | Update location entryget specific contact information using API | | locations/Mandatory param |
|
|
"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 | Code Block |
{ "Mobile": "",
"Pager": "",
"Phone": "",
" |
| redirect_to | null | success | 1 | anchorContacts | services | services | | Create | POST | Update | PUT | http://host/en/omk/admin/api/v2/servicescontacts/{contact-name}.jsonnew services in NMIS configurations. | Update the contact data present in configuration file | servicesTest-Contact.json Code Block |
---|
{
"DescriptionContact": "Test-Contact",
"DutyTime": "1",
"Email": "Dummy Entry for APItest@gmail.com",
"Level": "",
"NameLocation": "dummy",
"Poll_IntervalMobile": "5m",
"PortPager": "",
"Service_NamePhone": "dummy.exe",
"Service_TypeTimeZone" : "new_type"
} |
|
ServicesContacts | GETDeleteGET | DELETE | http://host/en/omk/admin/api/v2/servicescontacts/{contact-name}.json | Services present in NMIS configuration filedelete the contact data. | /services.json | Services | GET | GET/contacts/Test-Contact.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
| Create | POST | http://host/en/omk/admin/api/v2/services/{service-name}escalations.json | Services present in NMIS configuration file. |
| services/dummyescalations.json Code Block |
---|
{
"Event": "Descriptionnull,
"Event_Element": "Dummy",
Entry for API "Event_Node": "",
"NameGroup": "dummy",
"Poll_IntervalLevel0": "5m",
"PortLevel1": "",
"Level10": "Service_Name"",
"Level2": "dummy.exe",
"Service_TypeLevel3": "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 |
---|
| {Level4": "",
"DescriptionLevel5": ""Dummy,
Entry for API"Level6": "",
"NameLevel7": "dummy_updated",
"Poll_IntervalLevel8": "10m",
"PortLevel9": "",
"Service_Name": "dummy.exe""test",
"Role": null,
"Service_Type" :: null,
"new_type"UpNotify": null
} |
|
ServicesEscalations | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurations/escalations.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updatedescalations.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
contacts | contacts |
| | Create | POST | GET | GET | http://host/en/omk/admin/api/v2/contacts/escalations/{escalation-event}.jsonCreate a new contact |
| contactstest.json Code Block |
---|
{
"Contact":
"Test-Contact", "DutyTimeEvent": ""null,
"EmailEvent_Element": "",
"LevelEvent_Node": "",
"LocationGroup": "",
"MobileLevel0": "",
"PagerLevel1": "",
"PhoneLevel10": "",
"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 |
---|
{Level2": "",
"Level3": "",
"Level4": "",
"ContactLevel5": "Test-Contact",
"DutyTimeLevel6": "",
"EmailLevel7": "",
"LevelLevel8": "",
"LocationLevel9": "",
"MobileName": "test",
"PagerRole": ""null,
"PhoneType": ""null,
"TimeZoneUpNotify": ""null,
"_id": "Test-Contacttest"
} |
|
ContactsEscalations | Update | PUT | http://host/en/omk/admin/api/v2/contactsescalations/{contactescalation-nameevent}.json | Update the contact data present in configuration file |
| contactsTest-Contacttest.json Code Block |
---|
{
"Event": "test",
"ContactEvent_Element": "Test-Contact",
"DutyTimeEvent_Node": "1",
"EmailGroup": "test@gmail.com",
"LevelLevel0": "",
"LocationLevel1": "",
"MobileLevel10": "",
"PagerLevel2": "",
"PhoneLevel3": "",
"TimeZoneLevel4": ""
} |
| 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 | Code Block |
---|
{,
"Level5": "",
"redirect_toLevel6": null"",
"successLevel7": 1
} |
| Anchor |
---|
escalations | escalations | | 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 |
---|
{"",
"EventLevel8": null"",
"Event_ElementLevel9": "",
"Event_NodeName": "test",
"GroupRole": ""null,
"Level0Type": ""null,
"Level1": "",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 |
---|
{
"Level10redirect_to": ""null,
"Level2success": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null
} |
Escalations |
|
| Create | POST | http://host/en/omk/admin/api/v2/events.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json Code Block |
---|
{
"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/escalationsevents.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalationsevents.json |
Events | GET | GET | http://host/en/omk/admin/api/v2/escalationsevents/{escalationevent-eventname}.json |
| 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,
"_id": "test"
} |
| Escalations | Update | PUTevents/Self-test-API.json Code Block |
---|
{
"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 Code Block |
---|
{
"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/escalationsevents/{escalationevent-eventname}.json |
| escalationsevents/Self-test-API.json Code Block |
---|
{
"Event": "test",
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": "",
"Level1": "",{
"Level10redirect_to": ""null,
"Level2": "",
"Level3": "",success": 1
} |
|
Anchor |
---|
| polling-policy |
---|
| polling-policy |
---|
|
|
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 Code Block |
---|
{
"Level4description": "poll very infr_very.equently",
"Level5name": "very_very_infrequently",
"Level6ping": "30m",
"Level7": "", "Level8snmp": "1h",
"Level9": "", "Nameupdate": "test2d",
"Role": null, "Typewmi": null,
"1h"
"UpNotify": null } |
|
EscalationsPolling-Policy | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/escalations/{escalation-event}polling-policy.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testpolling-policy.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
events | events |
| Create | POST | Polling-Policy | GET | GET | http://host/en/omk/admin/api/v2/eventspolling-policy/{policy name}.json |
| events | Events | GET | GETpolling-policy/very_very_infrequently.json Code Block |
---|
{
"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 | {
"_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/eventspolling-policy/{event-policy name}.json |
| events/Self-test-APIpolling-policy/very_very_infrequently.json Code Block |
---|
{
"CancelingEventdescription": "N/Apoll",
"Descriptionname": "test event APIvery_very_infrequently",
"Eventping": "Self-test-API30m",
"Log": "true",
"Notify": "true",
"Statefulsnmp": "false1h",
"Statusupdate": "false2d",
"_idwmi": "Self-test-API1h"
} |
| 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 | EventsPolling-Policy | Delete | DELETE | http://host/en/omk/admin/api/v2/eventspolling-policy/{event-policy name}.json |
| events/Self-test-APIpolling-policy/very_very_infrequently.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
polling-policy | Polling-Policy | polling-policy | | |
Users | Create | POST | http://host/en/omk/admin/api/v2/polling-policyusers.json |
| /polling-policy.json Code Block | {
"description": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping/users.json Code Block |
---|
{
"admission": "30mtrue",
"snmp "groups": "1hall",
"update "privilege": "2dadministrator",
"wmi "user": "1hjohnsmith"
} |
|
Polling-PolicyUsers | GET | GET | http://host/en/omk/admin/api/v2/polling-policyusers.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policyusers.json |
Polling-PolicyUsers | GET | GET | http://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json |
| polling-policy/very_very_infrequentlyusers/johnsmith.json Code Block |
---|
{
"_id": "very_very_infrequently "johnsmith",
"descriptionadmission": "poll very infr_very.equently "true",
"namegroups": "very_very_infrequently",
"ping": "30m" [
"all"
],
"snmpprivilege": "1hadministrator",
"updateuser": "2d", "wmi": "1h"johnsmith"
} |
|
Polling-PolicyUsers | Update | PUT | http://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json |
| polling-policy/very_very_infrequentlyusers/johnsmith.json Code Block |
---|
{
"descriptionadmission": "pollfalse",
"namegroups": "very_very_infrequently",
"ping": "30m" [
"all"
],
"snmpprivilege": "1hadministrator",
"updateuser": "2d", "wmi": "1h"johnsmith"
} |
|
Users | Polling-Policy | Delete | DELETE | http://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json |
| polling-policy/very_very_infrequentlyusers/johnsmith.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
| users | users |
UsersAccess | Create | POST | http://host/en/omk/admin/api/v2/usersaccess.json |
| usersaccess.json Code Block |
---|
{
"admission"descr": "Enable button Logs",
"group": "button",
"level0": "1",
"level1": "0",
"level2": "0",
"level3": "true0",
"groupslevel4": "all0",
"privilegelevel5": "administrator0",
"username": "test_logs"
} |
|
UsersAccess | GET | GET | http://host/en/omk/admin/api/v2/usersaccess.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/usersaccess.json |
UsersAccess | GET | GET | http://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json |
| usersaccess/test_logs.json Code Block |
---|
{
"_id": "test_logs",
"admission"descr": "Enable button Logs",
"group": "button",
"level0": "1",
"level1": "true0",
"groupslevel2": [
"all"
]"0",
"level3": "0",
"level4": "0",
"privilegelevel5": "administrator0",
"username": "test_logs"
} |
|
UsersAccess | Update | PUT | http://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json |
| usersaccess/test_logs.json Code Block |
---|
{
"admission"_id": "test_logs",
"descr": "Enable button Logs",
"group": "button new",
"level0": "1",
"level1": "false0",
"groupslevel2": [
"all"
]"0",
"level3": "0",
"level4": "0",
"privilegelevel5": "administrator0",
"username": "test_logs"
} |
|
UsersAccess | Delete | DELETE | http://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json |
| usersaccess/test_logs.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
| access | access |
AccessCustomers | Create | POST | http://host/en/omk/admin/api/v2/customers.json |
| accesscustomers.json Code Block | {
"descr": "Enable button Logs",
"group": "button",
"level0": "1",
"level1": "0",
"level2": "0",
"level3 Code Block |
---|
{
"customer": "0test",
"level4description": "0",
"level5groups": "0",
"namelocations": "test_logs"
null
} |
|
AccessCustomers | GET | GET | http://apollo.opmantek.net:8080host/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/access/customers/{customer-name}.json | Access | GET | GET |
| access_logs.json Code Block |
---|
{
"_id": "test_logs",
"descrcustomer": "Enable button Logstest",
"group": "button",
"level0": "1",
"level1": "0",
"level2": "0",
"level3": "0",
"level4description": "0",
"level5groups": "0",
"namelocations": "test_logs" null
} |
|
AccessCustomers | Update | PUT | http://host/en/omk/admin/api/v2/customers/{customer-name}.json |
| access/test_logs.json Code Block | {
"_id": "test_logs",
"descr": "Enable button Logs",
"group": "button new",
"level0": "1",
"level1": "0",
"level2customers/test.json Code Block |
---|
{
"customer": "0test",
"level3description": "0this is test",
"level4groups": "0",
"level5locations": "0",
"name": "test_logs"
} |
| Access | Delete | DELETE |
Customers | Delete | DELETE | http://host/en/omk/admin/api/v2/customers/{customer-name}.json |
| access_logs.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
| customers | customers |
CustomersBusiness Services | Create | POST | http://host/en/omk/admin/api/v2/businessservices.json |
| customersbusinessservices.json Code Block |
---|
{
"customerbusinessPriority": "test10",
"descriptionbusinessService": "test",
"groupsbusinessUnit": "Sales",
"locationsserviceType": null "Revenue Generating"
} |
|
Business Services | CustomersGET | GETGET | http://host/en/omk/admin/api/v2/businessservices.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customersbusinessservices.json |
CustomersBusiness Services | GET | GET | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| customers Code Block |
---|
{
"_id": "test",
"customerbusinessPriority": "test10",
"descriptionbusinessService": "test",
"groupsbusinessUnit": "Sales",
"locationsserviceType": null "Revenue Generating"
} |
|
CustomersBusiness Services | Update | PUT | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| customers customertestdescriptionthis is testgroupsbusinessUnit": "Sales",
" | locations null
|
Business Services | Customers | Delete | DELETE | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| customersbusinessservices/test.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
business | business | Business Services | Create | POST | Business Services | GET | GET | Business Services | GET | GET | Business Services | Update | PUT | Business Services | Delete | DELETE |