| Operation | Method | URL | Response | Example |
---|
| Create | POST | http://host/en/omk/admin/api/v2/ | serviceslocations.json | Services present new Location in NMIS | configuration fileconfigurations. | | services | 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 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/ | services/{service-name}locations.json | Update Services entryLocations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/ | services/dumylocations.json |
codeLocations | themeGET | FadeToGrey | {
"Description": "Dummy Entry for APIGET | 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": "",
"NameAddress2": "dummy_updated",
"Poll_IntervalCity": "10mAmsterdam",
"PortCountry": "Netherlands",
"Service_NameFloor": "dummy.exe",
"Service_TypeGeocode" : "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 | Code Block |
---|
{Amsterdam, Netherlands",
"Latitude": "52.3675734",
"redirect_toLocation": null"Amsterdam",
"successLongitude": 1
} |
| Anchor |
---|
contacts | contacts | | Create | POST | http://host/en/omk/admin/api/v2/contacts.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json | Code Block |
---|
{"4.9041389",
"ContactPostcode": "Test-Contact",
"DutyTimeRoom": "",
"EmailState": "",
"LevelSuburb": "",
"Location_id": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": ""
} |
| Contacts | GET | GET |
Locations | Update | PUT | http://host/en/omk/admin/api/v2/ | contacts.jsonhttp://host/en/omk/admin/api/v2/contacts.json | Contacts | GET | GET | http://host/en/omk/admin/api/v2/contacts/{contactlocations/{location-name}.json | Update location entry | | contacts/Test-Contactlocations/Mandatory param.json Code Block |
---|
| {
"Address1": "",
" |
| Contact | Test-Contact | | DutyTimeCity": "",
"Country": "",
" |
| EmailFloor": "",
"Geocode": "fake geo code",
" |
| Level | "Location": "Mandatory param",
|
| | MobileLongitude": "yy.yyyyyyy",
|
| | Pager | | Phone | | TimeZone | | | _id | Test-Contact | Contacts |
Locations | UpdateDelete | PUTDELETE | http://host/en/omk/admin/api/v2/ | contactslocations/{ | contactlocation-name}.json | Deletes the location entry from configurations | | contacts/Test-Contact | Contact | "Test-Contact" | DutyTime | " | ",
"Email": "test@gmail.com", |
|
| 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 |
---|
{
"LevelDescription": "Dummy Entry for API",
"LocationName": "dummy",
"MobilePoll_Interval": "5m",
"PagerPort": "",
"PhoneService_Name": "dummy.exe",
"TimeZoneService_Type" : "new_type"
} |
|
ContactsServices | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/contacts/{contact-name}services.json | Services present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contactservices.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
escalations | escalations |
| Create | POST | Services | GET | GET | http://host/en/omk/admin/api/v2/escalations/services/{service-name}.jsonhttp:// | Services present in NMIS configuration file. | escalationsservices/dummy.json Code Block |
---|
{
"Event": null,
"Event_ElementDescription": "",Dummy Entry for "Event_Node": ""API",
"GroupName": "dummy",
"Level0Poll_Interval": "5m",
"Level1Port": "",
"Level10Service_Name": "dummy.exe",
"Level2Service_Type": "new_type",
"Level3_id": "dummy",
"Level4": "",
} |
|
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 |
---|
| {
"Level5Description": "",Dummy Entry "Level6": ""for API",
"Level7Name": "dummy_updated",
"Level8Poll_Interval": "10m",
"Level9Port": "",
"Service_Name": "testdummy.exe",
"RoleService_Type": null,
"Type": null,
"UpNotifynew_type":
null
} |
|
EscalationsServices | GETDeleteGET | DELETE | http://host/en/omk/admin/api/v2/escalationsservices/{service-name}.jsonhttp: | Deletes the Service entry from configurations | escalationsGET | GET | Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
---|
| Create | POST | http://host/en/omk/admin/api/v2/escalations/{escalation-event}contacts.json | Create a new contact | escalations/testcontacts.json Code Block |
---|
{
"EventContact": null,
"Event_Element": """Test-Contact",
"Event_NodeDutyTime": "",
"GroupEmail": "",
"Level0Level": "",
"Level1Location": "",
"Level10Mobile": "",
"Level2Pager": "",
"Level3Phone": "",
"Level4TimeZone": "",
"Level5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
} |
|
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 |
---|
{
"NameContact": "testTest-Contact",
"RoleDutyTime": null"",
"TypeEmail": null"",
"UpNotifyLevel": null"",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": "",
"_id": "testTest-Contact"
} |
|
EscalationsContacts | Update | PUT | http://host/en/omk/admin/api/v2/escalationscontacts/{escalationcontact-eventname}.jsonhttp | Update the contact data present in configuration file | escalationstestTest-Contact.json Code Block |
---|
{
"EventContact": "testTest-Contact",
"Event_ElementDutyTime": "1",
"Event_NodeEmail": "test@gmail.com",
"GroupLevel": "",
"Level0Location": "",
"Level1Mobile": "",
"Level10Pager": "",
"Level2Phone": "",
"Level3TimeZone": "",
"Level4": "",
"Level5": "",
"Level6": ""
} |
|
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,
"Level9Event_Element": "",
"NameEvent_Node": "test",
"RoleGroup": null"",
"TypeLevel0": null"",
"UpNotifyLevel1": 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 |
---|
{
"redirect_to": null"",
"Level10": "",
"Level2": "",
"Level3": "",
"Level4": "",
"successLevel5": "",
1
} |
| Anchor |
---|
events | events | | Create | POST | Events | GET | GET | Events | GET | GET | Events | Update | PUT | Events | Delete | DELETE | Anchor |
---|
polling-policy | polling-policy | Polling-Policy | Create | POST | Polling-Policy | GET | GET | Polling-Policy | GET | GET | Polling-Policy | Update | PUT | Polling-Policy | Delete | DELETE | 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 "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,
"_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 Code Block |
---|
{
"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 |
| |
|
| 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/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 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/events/{event-name}.json |
| |
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 |
---|
{
"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 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/polling-policy/{policy name}.json |
| |
|
Users | Create | POST | http://host/en/omk/admin/api/v2/users.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json Code Block |
---|
{
"admission": "true",
"groups": "all",
"privilege": "administrator",
"user": "johnsmith"
} |
|
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/users/{user:name}.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/johnsmith.json Code Block |
---|
{
"admission": "false",
"groups": [
"all"
],
"privilege": "administrator",
"user": "johnsmith"
} |
|
Users | Delete | DELETE | http://host/en/omk/admin/api/v2/users/{user:name}.json |
| |
|
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/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 Code Block |
---|
{
"_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 Code Block |
---|
{
"_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 |
| |
|
Customers | Create | POST | http://host/en/omk/admin/api/v2/customers.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json Code Block |
---|
{
"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 Code Block |
---|
{
"_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 Code Block |
---|
{
"customer": "test",
"description": "this is test",
"groups": "",
"locations": null
} |
|
Customers | Delete | DELETE | http://host/en/omk/admin/api/v2/customers/{customer-name}.json |
| |
|
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 Code Block |
---|
{
"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 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 |
| |