| Operation | Method | URL | Response | Example |
---|
| Create | POST | http://host/en/omk/admin/api/v2/locations.json | Locations present new Location in NMIS | configuration fileconfigurations. | | 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 |
{
Code Block |
---|
{
"Address1": "",
|
| | | Amsterdam | | | Netherlands | " | | Amsterdam, Netherlands | | 52 | 3675734 | | | Amsterdam | | 4 | 9041389 | | | | | , | "_id": "Amsterdam" |
---|
Locations | UpdateGET | PUTGET | http://host/en/omk/admin/api/v2/locations/{location-name}.jsonUpdate location entry | Locations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json Code Block |
---|
|
|
{
.jsonLocations | GET | GET | http://host/en/omk/admin/api/v2/locations{location-name}.json | Locations present in NMIS configuration file. | | | | "Country": "Netherlands",
|
| | | fake geo code | | xx | xxxxxxx | | Mandatory param | | yy | yyyyyyy | | | | | |
Locations | DeleteUpdate | DELETEPUT | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Deletes the Update location entry from configurations | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json Code Block |
---|
| {
"Address1": "",
"Address2": "redirect_to",
"City": null"",
"Country": "",
"successFloor": "",
1
} |
| Anchor |
---|
services | 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 | Code Block |
{
"Description": "Dummy Entry for API",
"Name": "dummy",
"Poll_Interval": "5m",
"Port "Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "yy.yyyyyyy",
"Postcode": "",
"Room": "",
" |
| Service_Name | dummy.exe | "Service_Type" | new_type | Services |
Locations | GETDelete | GETDELETE | http://host/en/omk/admin/api/v2 | /services/locations/{location-name}.json | Services present in NMIS configuration file.Deletes the location entry from configurations | | services | Services | GET | GET | http:// Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
| Create | POST | http://host/en/omk/admin/api/v2/services/{service-name}.json | Services present new services in NMIS configuration fileconfigurations. | /dummy.json Code Block | {
"Description": "Dummy Entry for API.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,
"_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": "dummytest",
"Poll_IntervalRole": null,
"5mType": 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.jsonUpdate Services entry |
| services/dumyevents.json Code Block |
---|
| {
"CancelingEvent": "N/A",
"Description": "Dummytest Entryevent for API",
"NameEvent": "dummy_updatedSelf-test-API",
"Poll_IntervalLog": "10mtrue",
"PortNotify": "true",
"Service_NameStateful": "dummy.exefalse",
"Service_TypeStatus" : "new_typefalse"
} |
|
ServicesEvents | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/services/{service-name}events.json | Deletes the Service entry from configurations |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
contacts | contacts | | Create | POST/events.json |
Events | GET | GET | http://host/en/omk/admin/api/v2/contacts/events/{event-name}.json | Create a new contact |
| contactsevents/Self-test-API.json Code Block |
---|
{
"Contact "CancelingEvent": "Test-Contact "N/A",
"DutyTime "Description": "",
"Email": "",
"Level": " "test event API",
"Location "Event": "Self-test-API",
"Mobile "Log": "true",
"Pager "Notify": "true",
"Phone "Stateful": "false",
"TimeZone "Status": "false"
} |
| 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,
"_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/{contactpolling-name}policy.jsonUpdate 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",
"Levelping": "30m",
"Location": "", "Mobilesnmp": "1h",
"Pager": "", "Phoneupdate": "2d",
"TimeZonewmi": "1h"
} |
|
ContactsPolling-Policy | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/contacts/{contact-name}polling-policy.json | delete the contact data. |
| escalations | | Create | POST | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
escalations | :8080/en/omk/admin/api/v2/polling-policy.json |
Polling-Policy | GET | GET | http://host/en/omk/admin/api/v2/escalations/polling-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 | GET | http://host/en/omk/admin/api/v2/escalations.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json | 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/{escalation-eventpolicy name}.json |
| escalations/testpolling-policy/very_very_infrequently.json Code Block |
---|
{
"Event": null,
"Event_Element": "",
"Event_Node": "",
"Group": "",
"Level0": ""redirect_to": null,
"Level1success": "",
"Level101
} |
|
|
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",
"Level2groups": "all",
"Level3 "privilege": "administrator",
"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": "",
"Level1": "",
"Level10[
"all"
],
"privilege": "administrator",
"Level2 "user": "",johnsmith"
} |
|
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 |
---|
{
"Level3redirect_to": ""null,
"Level4success": "",
"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 |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testaccess.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
events | events |
| Create | POST | Access | GET | GET | http://host/en/omk/admin/api/v2/eventsaccess/{access-id}.json |
| events | 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 | { "CancelingEvent": "N/A", "Description": "test event API", "Event": "Self-test-API", "Log": "true", "Notify": "true", "Stateful": "false", "Status": "false" } | 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/eventsaccess/{eventaccess-nameid}.json |
| eventsSelf--API{ "CancelingEvent Code Block |
---|
{
"_id": "test_logs",
"descr": "Enable button Logs",
"group": " |
N/A Descriptiontest event API EventSelf-test-API Logtrue Notifytrue Statefulfalse Statusfalse _idSelf--API
|
EventsAccess | UpdateDelete | PUTDELETE | http://host/en/omk/admin/api/v2/eventsaccess/{eventaccess-nameid}.json |
| eventsSelf-test-API.json | Events | Delete | DELETEtest_logs.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
Customers | Create | POST | http://host/en/omk/admin/api/v2/events/{event-name}customers.json |
| events/Self-test-APIcustomers.json Code Block |
---|
{
"customer": "test",
"redirect_to": null,
"success": 1
} |
| Anchor |
---|
polling-policy | polling-policy | Polling-Policy | Create | POST "description": "",
"groups": "",
"locations": null
} |
|
Customers | GET | GET | http://host/en/omk/admin/api/v2/polling-policycustomers.json |
| http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policycustomers.json |
Polling-PolicyCustomers | GET | GET | http://host/en/omk/admin/api/v2/polling-policycustomers/{customer-name}.json |
| /v2/polling-policy.json | Polling-Policy | GET | GET/v2/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 |
| |