| Operation | Method | URL | Response | Example |
---|
| Create | POST | http://host/en/omk/admin/api/v2/locations | /Amsterdam.json | Code Block |
{
new Location in NMIS configurations. | | | | 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.jsoncode |
Locations | themeGET | FadeToGrey | {
"Address1": "",
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 | | 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 "Floor": "",
"Geocode": "fake geo code",
" |
| Name | dummyxx.xxxxxxx",
"Location": "Mandatory param",
" |
| Poll_Interval | 5myy.yyyyyyy",
"Postcode": "",
" |
| Port | | Service_Name | dummy.exe | | Service_Type | | new_type | Services |
Locations | GETDelete | GETDELETE | http://host/en/omk/admin/api/v2/ | serviceslocations/{location-name}.json | Services present in NMIS configuration file.Deletes the location entry from configurations | | services.jsonlocations/Mandatory param.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
| GET Create GET | 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",
"Name": "dummy",
"Poll_Interval": "5m",
"Port": "",
"Service_Name": "dummy.exe",
"Service_Type" : "new_type",
"_id": "dummy"
} |
|
Services | UpdateGET | PUTGET | http://host/en/omk/admin/api/v2/services/{service-name}.json | Update Services entry Services present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumy.json |
codeServices | themeGET | FadeToGrey | {
"Description": "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_updated",
"Poll_Interval": "10m5m",
"Port": "",
"Service_Name": "dummy.exe",
"Service_Type" : "new_type",
"_id": "dummy"
} |
|
Services | DeleteUpdate | DELETEPUT | http://host/en/omk/admin/api/v2/services/{service-name}.json | Deletes the Service entry from configurationsUpdate Services entry | dummy_updateddumy.json Code Block |
---|
| {
"redirect_toDescription": null,"Dummy Entry for "success": 1
} |
| Anchor |
---|
contacts | 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 | Code Block |
---|
{API",
"ContactName": "Test-Contactdummy_updated",
"DutyTimePoll_Interval": "10m",
"EmailPort": "",
"LevelService_Name": "dummy.exe",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": ""
} |
| Contacts | GET | GETService_Type" : "new_type"
} |
|
Services | Delete | DELETE | http://host/en/omk/admin/api/v2/contactsservices/{service-name}.json | get contact information present in configurationDeletes the Service entry from configurations | hostcontacts.jsondummy_updated.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
---|
| GET Create GET | POST | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | get specific contact information using APICreate a new contact | /Test-Contact.json Code Block |
---|
{
"Contact": "Test-Contact",
"DutyTime": "",
"Email": "",
"Level": "",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": "",
"_id": "Test-Contact"
} |
| Contacts | 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/contacts/{contact-name}.json | Update the contact data present in configuration fileget 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": "1",
"Email": "test@gmail.com",
"Level": "",
"Location": "",
"Mobile": "",
"Pager": "",
"Phone": "",
"TimeZone": ""
} |
| Contacts | Delete | DELETE,
"_id": "Test-Contact"
} |
|
Contacts | Update | PUT | http://host/en/omk/admin/api/v2/contacts/{contact-name}.json | delete Update the contact data .present in configuration file | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json Code Block |
---|
{
"redirect_toContact": null"Test-Contact",
"successDutyTime": "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 |
---|
{",
"Email": "test@gmail.com",
"Event": null,
"Event_ElementLevel": "",
"Event_NodeLocation": "",
"GroupMobile": "",
"Level0Pager": "",
"Level1Phone": "",
"Level10TimeZone": "",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": ""
} |
|
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 |
---|
{
"Level7Event": ""null,
"Level8Event_Element": "",
"Level9Event_Node": "",
"NameGroup": "test",
"RoleLevel0": null"",
"TypeLevel1": null"",
"UpNotifyLevel10": 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"",
"Level2": "",
"Level3": "",
"Level4": "",
"Level5": "",
"Event_ElementLevel6": "",
"Event_NodeLevel7": "",
"GroupLevel8": "",
"Level0Level9": "",
"Level1Name": "test",
"Level10Role": ""null,
"Level2Type": ""null,
"Level3UpNotify": "",
"Level4": "",
"Level5": "",
"Level6": "",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 |
---|
{
"Level7Event": ""null,
"Level8Event_Element": "",
"Level9Event_Node": "",
"NameGroup": "test",
"RoleLevel0": null"",
"TypeLevel1": null"",
"UpNotifyLevel10": null"",
"_idLevel2": "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",
"Level3": "",
"Level4": "",
"Event_ElementLevel5": "",
"Event_NodeLevel6": "",
"GroupLevel7": "",
"Level0Level8": "",
"Level1Level9": "",
"Level10Name": "test",
"Level2Role": ""null,
"Level3Type": ""null,
"Level4UpNotify": ""null,
"Level5_id": "test",
"Level6
} |
|
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",
"Level7Event_Element": "",
"Level8Event_Node": "",
"Level9Group": "",
"NameLevel0": "test",
"RoleLevel1": null"",
"TypeLevel10": null"",
"UpNotifyLevel2": 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 |
---|
{"",
"Level3": "",
"redirect_toLevel4": null"",
"success": 1
} |
| Anchor |
---|
events | events | | 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 | GETLevel5": "",
"Level6": "",
"Level7": "",
"Level8": "",
"Level9": "",
"Name": "test",
"Role": null,
"Type": null,
"UpNotify": null
} |
|
Escalations | Delete | DELETE | http://host/en/omk/admin/api/v2/eventsescalations/{escalation-event}.json |
| eventshttp: | Events | GET | GET | Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
| Create | POST | http://host/en/omk/admin/api/v2/events/{event-name}.json |
| /Self-test-API.json Code Block |
---|
{
"CancelingEvent": "N/A",
"Description": "test event API "test event API",
"Event": "Self-test-API",
"Log": "true",
"Notify": "true",
"Stateful": "false",
"Status": "false",
"_id": "Self-test-API"
} |
|
Events | UpdateGET | PUTGET | 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 | DeleteGET | DELETEGET | http://host/en/omk/admin/api/v2/events/{event-name}.json |
| | Anchor |
---|
polling-policy | polling-policy | Polling-Policy | Create | POST | "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/polling-policyevents/{event-name}.json |
| pollingpolicyAPI.json Code Block |
---|
{
"description "Description": "poll very infr_very.equently "test event API",
"name "Event": "very_very_infrequently "test",
"ping "Log": "30mtrue-change",
"snmp "Notify": "1htrue",
"update "Stateful": "2dfalse",
"wmi "Status": "1hfalse"
} |
|
Polling-PolicyEvents | GETDeleteGET | DELETE | http://host/en/omk/admin/api/v2/events/polling{event-policyname}.json |
| polling-policyGET | Polling-Policy | GET | Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
Anchor |
---|
| polling-policy |
---|
| polling-policy |
---|
|
|
Polling-Policy | Create | POST | http://host/en/omk/admin/api/v2/polling-policy/{policy name}.json |
| /very_very_infrequently.json Code Block |
---|
{
"_id": "very_very_infrequently",
"description": "poll very infr_very.equently",
"description": "poll very infr_very.equently",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
} |
|
Polling-Policy | UpdateGET | PUTGET | 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 |
Polling-Policy Code Block |
---|
{
"description": "poll",
"name": "very_very_infrequently",
"ping": "30m",
"snmp": "1h",
"update": "2d",
"wmi": "1h"
} | | Polling-Policy | Delete | DELETEGET | GET | http://host/en/omk/admin/api/v2/polling-policy/{policy name}.json |
| | Anchor |
---|
users | users | Users | Create | POST | http: "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/users/polling-policy/{policy name}.json |
| userspolling-policy/very_very_infrequently.json Code Block |
---|
{
"description": "poll",
"name": "very_very_infrequently",
"admissionping": "true30m",
"groupssnmp": "all1h",
"privilegeupdate": "administrator2d",
"userwmi": "test1h"
} |
|
UsersPolling-Policy | GETDeleteGET | DELETE | http://host/en/omk/admin/api/v2/users/polling-policy/{policy name}.json |
| users.jsonpolling-policy/very_very_infrequently.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
|
|
Users | GETCreateGET | POST | http://host/en/omk/admin/api/v2/users/{user:name}.json |
| /test.json Code Block |
---|
{
"_idadmission": "test", "admission": "true",
"groups": [ "all"
],
"privilege": "administrator",
"user": "testjohnsmith"
} |
|
Users | UpdateGET | PUTGET | 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 |
| testjohnsmith.json Code Block |
---|
{
"_id": "johnsmith",
"admission": "falsetrue",
"groups": [
"all"
],
"privilege": "administrator",
"user": "testjohnsmith"
} |
|
Users | DeleteUpdate | DELETEPUT | http://host/en/omk/admin/api/v2/users/{user:name}.json |
| testjohnsmith.json Code Block |
---|
{
"admission": "false",
"groups": [
"redirect_toall":
null ],
"privilege": "success"administrator",
"user": 1"johnsmith"
} |
|
anchorUsers | accessDelete | access | Access | Create | POST | DELETE | http://host/en/omk/admin/api/v2/users/{user:name}.json |
| accessusers/johnsmith.json Code Block |
---|
{
"descr": "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 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://apollo.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 | |
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 |
| access_logs.json Code Block |
---|
{
"_id": "test_logs",
"descrbusinessPriority": "Enable button Logs10",
"groupbusinessService": "button newtest",
"level0businessUnit": "1Sales",
"level1": "0",
"level2"serviceType": "Revenue Generating"
} |
|
Business Services | Update | PUT | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| Code Block |
---|
{
"businessPriority": " | 0 level30 level40 level50,"name": "test_logs"
} | Access | Delete | DELETE |
|
Business Services | Delete | DELETE | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| access_logs.json Code Block |
---|
{
"redirect_to": null,
"success": 1
} |
| 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 |