Versions Compared

Old Version 24

changes.mady.by.user Arihant Bansal

Saved on

compared with

New Version 25

changes.mady.by.user Arihant Bansal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


...

 code-block

...

Locations

...

new Location in NMIS configurations.

...

Code Block
{
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "xx.xxxxxxx",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }

...


API OPTIONSLocationsServicesContactsEscalationsEventsPolling-PolicyUsersAccessCustomersBusinessServices


Locationslocationslocation location entrylocations/Mandatory param        "Address1":"",       Address2       City       Country       "Floor":"",       Geocodefake geo code       "Latitude":"xx.xxxxxxx",       Mandatory param       Longitudeyy.yyyyyyy       Postcode       "Room":"",       State       Suburb    LocationslocationslocationDeletes the location entry from configurationslocations/Mandatory param{ "Event": null, "Event_Element": "", "Event_Node": "", "Group": "", "Level0": "", "Level1": "", "Level10": "", "Level2": ""/v2/events/{event-name}.jsonPolling-Policy{     "_idlogs.json{    "descriptionaccess/test_logs.json

Anchor
locations
locations
Name

OperationMethodURLResponseExample

 code-block

Locations

CreatePOSThttp://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": ""
    }


LocationsGETGEThttp://host/en/omk/admin/api/v2/locations.jsonLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json



LocationsGETGEThttp://host/en/omk/admin/api/v2/locations{location-name}.jsonLocations 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"
}


LocationsUpdatePUThttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonUpdate location entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json


Code Block
themeFadeToGrey
 {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "yy.yyyyyyy",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }


LocationsDeleteDELETEhttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonDeletes the location entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
services
services

Services

Create

POSThttp://host/en/omk/admin/api/v2/services.jsonnew 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"
}


ServicesGETGEThttp://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
ServicesGETGEThttp://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"
}


ServicesUpdatePUThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonUpdate Services entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumy.json


Code Block
themeFadeToGrey
{
    "Description": "Dummy Entry for API",
    "Name": "dummy_updated",
    "Poll_Interval": "10m",
    "Port": "",
    "Service_Name": "dummy.exe",
    "Service_Type" : "new_type"
}


ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
contacts
contacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts.jsonCreate a new contacthttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json


Code Block
{
    "Contact": "Test-Contact",
    "DutyTime": "",
    "Email": "",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
}


ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.json
ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonget specific contact information using APIhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json


Code Block
{
    "Contact": "Test-Contact",
    "DutyTime": "",
    "Email": "",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "RoomPager": "",
    "StatePhone": "",
    "SuburbTimeZone": "",
    "_id": "AmsterdamTest-Contact"
}


ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonUpdate the contact data present in configuration filehttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json


Code Block
themeFadeToGrey
{

 
 
 
 "
Contact": "Test-Contact",
   
 "
DutyTime": "1",
 
   "
Email": "test@gmail.com",

 
 
 
 "
Level": "
",

 
 
 
 "Location": "
",
 
   "
Mobile": "
",
  
  "
Pager": "",

 
 
 
 "
Phone": "",
   
 "
TimeZone": ""

}


ContactsDeleteDELETEhttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsondelete the contact data.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
servicesescalationsservices
escalations

ServicesEscalations

Create

POSThttp://host/en/omk/admin/api/v2/servicesescalations.jsonnew services in NMIS configurations.
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/servicesescalations.json


Code Block
{
    "DescriptionEvent": null,
  "Dummy Entry for API "Event_Element": "",
    "NameEvent_Node": "dummy",
    "Poll_IntervalGroup": "5m",
    "PortLevel0": "",
    "Service_NameLevel1": "dummy.exe",
    "Service_TypeLevel10" : "new_type"
}
ServicesGETGEThttp://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.jsonServicesGETGEThttp://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
{",
    "Level2": "",
    "Level3": "",
    "Level4": "",
    "DescriptionLevel5": "Dummy",
   Entry for API"Level6": "",
    "NameLevel7": "dummy",
    "Poll_IntervalLevel8": "5m",
    "PortLevel9": "",
    "Service_Name": "dummy.exetest",
    "Service_TypeRole": null,
 "new_type"   "Type": null,
    "_id"UpNotify": "dummy"
}
ServicesUpdatePUT
null
}


EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json

GETGEThttp://host/en/omk/admin/api/v2/servicesescalations/{serviceescalation-nameevent}.jsonUpdate Services entry
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/servicesescalations/dumytest.json


FadeToGrey
Code Block
theme
{
    "DescriptionEvent": "Dummy Entry for API"null,
    "NameEvent_Element": "dummy_updated",
    "PollEvent_IntervalNode": "10m",
    "PortGroup": "",
    "Service_NameLevel0": "dummy.exe",
    "Service_TypeLevel1" : "new_type"
}
ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json
Code Block
{",
    "Level10": "",
    "Level2": "",
    "Level3": "",
    "redirect_toLevel4": null"",
    "successLevel5": 1
}
Anchor
contactscontacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts.jsonCreate a new contacthttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json
Code Block
{"",
     "ContactLevel6": "Test-Contact",
    "DutyTimeLevel7": "",
    "EmailLevel8": "",
    "LevelLevel9": "",
    "LocationName": "test",
    "MobileRole": ""null,
    "PagerType": ""null,
    "PhoneUpNotify": ""null,
    "TimeZone_id": ""
}
ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.jsonContactsGETGET
test"
}


EscalationsUpdatePUThttp://host/en/omk/admin/api/v2/contactsescalations/{contactescalation-nameevent}.jsonget specific contact information using API
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsescalations/Test-Contacttest.json


Code Block
{
    "ContactEvent": "Test-Contacttest",
    "DutyTimeEvent_Element": "",
    "EmailEvent_Node": "",
    "LevelGroup": "",
    "LocationLevel0": "",
    "MobileLevel1": "",
    "PagerLevel10": "",
    "Phone": "",
    "TimeZone": "",
    "_id": "Test-Contact"
}
ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonUpdate the contact data present in configuration filehttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json
Code Block
{Level2": "",
    "ContactLevel3": "Test-Contact",
    "DutyTimeLevel4": "1",
    "EmailLevel5": "test@gmail.com",
    "LevelLevel6": "",
    "LocationLevel7": "",
    "MobileLevel8": "",
    "PagerLevel9": "",
    "PhoneName": "test",
    "Role": null,
    "TimeZoneType": null,
    "UpNotify": null
}


ContactsEscalationsDeleteDELETEhttp://host/en/omk/admin/api/v2/contactsescalations/{contactescalation-nameevent}.jsondelete the contact data.
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsescalations/Test-Contacttest.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
escalationseventsescalations
events

EscalationsEvents

Create

POSThttp://host/en/omk/admin/api/v2/escalationsevents.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalationsevents.json


Code Block
{
        "EventCancelingEvent": null"N/A",
        "Event_ElementDescription": "",test     "Event_Node": ""event API",
        "GroupEvent": "Self-test-API",
        "Level0Log": "true",
        "Level1Notify": "true",
        "Level10Stateful": "false",
        "Level2Status": "false",
     "Level3": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}
EscalationsGETGET
  }


EventsGETGEThttp://host/en/omk/admin/api/v2/events.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json
EventsGETGEThttp://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"
}


EventsUpdatePUThttp://host/en/omk/admin/api/v2/escalationsevents/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/events/Self-test-API.json
GETEventsGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.jsonhttp://apollo.opmantek.net:8080DeleteDELETEhttp://host/en/omk/admin/api/v2/escalations/test.json
Code Block

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json


Code Block
{
    "redirect_to": null,
    "Level3success": "",
    "Level4": "", 1
}


Anchor
polling-policy
polling-policy

Polling-PolicyCreatePOSThttp://host/en/omk/admin/api/v2/polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json


Code Block
  {
        "Level5description": "poll very infr_very.equently",
        "Level6name": "very_very_infrequently",
    "Level7": "",     "Level8ping": "30m",
 
  "Level9": "",     "Namesnmp": "test1h",
    "Role": null,
    "Typeupdate": null"2d",
    "UpNotify": null,     "_idwmi": "test1h"
    }
EscalationsUpdatePUT

Polling-PolicyGETGEThttp://host/en/omk/admin/api/v2/polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json
Polling-PolicyGETGEThttp://host/en/omk/admin/api/v2/escalationspolling-policy/{escalation-eventpolicy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testpolling-policy/very_very_infrequently.json

 Code Block
{
    "Event    "_id": "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
 "very_very_infrequently",
    "description": "poll very infr_very.equently",
    "name": "very_very_infrequently",
    "ping": "30m",
    "snmp": "1h",
    "update": "2d",
    "wmi": "1h"
}

Polling-PolicyUpdatePUThttp://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-PolicyDeleteDELETEhttp://host/en/omk/admin/api/v2/escalationspolling-policy/{escalation-eventpolicy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testpolling-policy/very_very_infrequently.json

 Code Block
{
    "redirect_to": null,
    "success": 1
}

 Anchor
eventsusersevents
users
EventsUsersCreatePOSThttp://host/en/omk/admin/api/v2/eventsusers.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/users.json

 Code Block
{
    "admission": "true",
    "groups": "all",
    "privilege": "administrator",
    "user": "test"
}

UsersGETGEThttp://host/en/omk/admin/api/v2/eventsusers.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/eventsusers.json
EventsUsersGETGEThttp://host/en/omk/admin/api/v2/eventsusers/{event-user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/eventsusers/Self-test-API.json

 Code Block
{
    "CancelingEvent_id": "N/A",
    "Description": "test event API",
    "Event": "Self-test-API",
    "Logadmission": "true",
    "Notify": "true",
    "Statefulgroups": [
        "falseall"
    ],
    "Statusprivilege": "falseadministrator",
    "_iduser": "Self-test-API"
}

EventsUsersUpdatePUThttp://host/en/omk/admin/api/v2/eventsusers/{event-user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.jsonEvents/users/test.json

 Code Block
{
    "admission": "false",
    "groups": [
        "all"
    ],
    "privilege": "administrator",
    "user": "test"
}

UsersDeleteDELETEhttp://host/en/omk/admin/api/v2/eventsusers/{event-user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/eventsusers/Self-test-API.json

 Code Block
{
    "redirect_to": null,
    "success": 1
}

 Anchor
polling-policypolling-policy
access
access
AccessCreatePOST

http://host/en/omk/admin/api/v2/polling-policy.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policyaccess.json
 Code Block
  {
        "description": "poll very infr_very.equently",
        "name": "very_very_infrequently",
        "ping": "30m",
        "snmp": "1h",
        "update": "2d",
        "wmi": "1h"
    }
Polling-PolicyGETGEThttp://host/en/omk/admin/api/v2/polling-policy.json

 Code Block
{
    "descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "0",
    "level4": "0",
    "level5": "0",
    "name": "test_logs"
}

AccessGETGET

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policyaccess.json
Polling-PolicyAccessGETGET

http://host/en/omk/admin/api/v2/polling-policy/{policy name}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policyaccess/verytest_very_infrequently.json
 Code Block

 Code Block
{
    "_id": "test_logs",
    "descr": "Enable button Logs",
    "group": "very_very_infrequentlybutton",
    "descriptionlevel0": "poll very infr_very.equently1",
    "namelevel1": "very_very_infrequently0",
    "pinglevel2": "30m0",
    "snmplevel3": "1h0",
    "updatelevel4": "2d0",
    "wmilevel5": "1h0"
}
Polling-PolicyUpdatePUThttp://host/en/omk/admin/api/v2/polling-policy/{policy name}.json
,
    "name": "test_logs"
}

AccessUpdatePUT

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json
 Code Block

 Code Block
{
    "_id": "test_logs",
    "descr": "Enable button Logs",
    "group": "button new",
    "level0": "1",
    "level1": "poll0",
    "namelevel2": "very_very_infrequently0",
    "pinglevel3": "30m0",
    "snmplevel4": "1h0",
    "updatelevel5": "2d0",
    "wminame": "1htest_logs"
}
 

AccessPolling-PolicyDeleteDELETE

http://host/en/omk/admin/api/v2/polling-policy/{policy name}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policyaccess/verytest_very_infrequentlylogs.json

 Code Block
{
    "redirect_to": null,
    "success": 1
}
 Anchor
usersusersUsersCreatePOSTUsersGETGETUsersGETGETUsersUpdatePUTUsersDeleteDELETE
 Anchor
accessaccessAccessCreatePOSTAccessGETGETAccessGETGETAccessUpdatePUTAccessDeleteDELETE

 Anchor
customers
customers
CustomersCreatePOST



CustomersGETGET



CustomersGETGET



CustomersUpdatePUT



CustomersDeleteDELETE



 Anchor
business
business
Business ServicesCreatePOST



Business ServicesGETGET



Business ServicesGETGET



Business ServicesUpdatePUT



Business ServicesDeleteDELETE



...