Page Comparison

...

code-block

...

Locations

...

new Location in NMIS configurations.

...

API OPTIONS	Locations	Services	Contacts	Escalations	Events	Polling-Policy	Users	Access	Customers	BusinessServices

}Locations present in NMIS configuration file.Amsterdam Address2CityAmsterdamCountryNetherlands Floor GeocodeAmsterdam, Netherlands Latitude52.3675734 LocationAmsterdam Longitude4.9041389, "Postcode": "", "Room": "", "State": ""Suburb"", "_id": "Amsterdam" }locations/{location-name}Update location entrylocations/Mandatory param "Address1": "", "Address2": "", "City": "", "Country": "", "Floor": "", "Geocodefakegeocode Latitudexx.xxxxxxx LocationMandatory param Longitudeyy.yyyyyyy "Postcode":"", Room "State":"", Suburb LocationsDeleteDELETElocations/{location-name}Deletes the location entry from configurationslocations/Mandatory param

Anchor

	locations
	locations

Name

Operation

Method

URL

Response

Example

code-block

Locations

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

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

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": "",

Locations

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

   "_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

theme	FadeToGrey

"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
{ "redirect_to": null, "

success":

Locations

Update

PUT

1
}

Anchor

	services
	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

theme	FadeToGrey


    "Description": "

Dummy Entry

for

API",

Name": "

dummy",

Poll_Interval": "

5m",

Port": "

",

Service_Name": "dummy.exe",

Service_Type" : "new_type"

Services

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

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

Anchorservicesservices

Services

Create

POSTServicesGETGEThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonnew services

Services present in NMIS

configurations

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" }

ServicesGETUpdateGETPUThttp://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}.jsonServices present in NMIS configuration file.Update Services entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummydumy.json

Code Block

theme	FadeToGrey

{
    "Description": "Dummy Entry for API",
    "Name": "dummy_updated",
    "Poll_Interval": "5m10m",
    "Port": "",
    "Service_Name": "dummy.exe",,
    "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
{ "Serviceredirect_Typeto": "new_type"null, "_idsuccess": "dummy"1 }

ServicesUpdate

PUT

Anchor

	contacts
	contacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/services/{service-name}/contacts.jsonUpdate Services entryCreate a new contacthttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumycontacts.json

theme

Code Block

FadeToGrey

{
    "DescriptionContact": "Test-Contact",
    "DutyTime": "Dummy",
   Entry for API"Email": "",
    "NameLevel": "dummy_updated",
    "Poll_IntervalLocation": "10m",
    "PortMobile": "",
    "Service_NamePager": "dummy.exe",
    "Service_Type" Phone": "",
    "TimeZone": "new_type"
}

ServicesContactsDeleteGETDELETEGEThttp://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 }

Anchorcontactscontacts

Contacts

Create

POST/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}.jsonCreate a new contactget 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": "", "Pager": "", "Phone": "", "TimeZone": "" }

ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.jsonContactsGETGET

"",
    "_id": "Test-Contact"
}

ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonget specific contact information using APIUpdate the contact data present in configuration filehttp://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": "", "_id": "Test-Contact" }

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

Code Block
{ "Contactredirect_to": "Test-Contact"null, "DutyTime": "1",success": 1 }

Anchor

	escalations
	escalations

Escalations

Create

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

Code Block
{ "EmailEvent": "test@gmail.com"null, "LevelEvent_Element": "", "LocationEvent_Node": "", "MobileGroup": "", "PagerLevel0": "", "PhoneLevel1": "", "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
{"Level10": "", "redirect_toLevel2": null"", "successLevel3": 1 }

Anchorescalationsescalations

Escalations

Create

POSThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json

Code Block

{"",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "EventLevel7": null"",
    "Event_ElementLevel8": "",
    "Event_NodeLevel9": "",
    "GroupName": ""test",
    "Role": null,
    "Level0Type": ""null,
    "Level1UpNotify": "",
    "Level10": "",
    "Level2": "",
    "Level3": ""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/escalations/{escalation-event}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

Code Block

{
    "Event": null,
    "Level4": "",
    "Level5Event_Element": "",
    "Level6Event_Node": "",
    "Level7Group": "",
    "Level8Level0": "",
    "Level9Level1": "",
    "NameLevel10": "test",
    "RoleLevel2": null"",
    "TypeLevel3": null"",
    "UpNotify": null
}

EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.jsonGETGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

Code Block

{"Level4": "",
    "Level5": "",
    "Level6": "",
    "EventLevel7": null"",
    "Event_ElementLevel8": "",
    "Event_NodeLevel9": "",
    "GroupName": "test",
    "Level0Role": null,
    "Type": null,
    "UpNotify": null,
    "Level1": "",
    "Level10": "",
_id": "test"
}

EscalationsUpdatePUThttp://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

{
    "Level2Event": "test",
    "Level3Event_Element": "",
    "Level4Event_Node": "",
    "Level5Group": "",
    "Level6Level0": "",
    "Level7Level1": "",
    "Level8Level10": "",
    "Level9Level2": "",
    "NameLevel3": "test",
    "Role": null,
    "TypeLevel4": null"",
    "UpNotifyLevel5": null"",
    "_idLevel6": "test"
}

EscalationsUpdatePUThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

Code Block
{, "EventLevel7": "test", "Event_ElementLevel8": "", "Event_NodeLevel9": "", "GroupName": "test", "Level0Role": ""null, "Level1Type": ""null, "Level10": "",UpNotify": null }

EscalationsDeleteDELETEhttp://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
{ "Level2redirect_to": ""null, "Level3success": "", "Level4": "", "Level5": "", "Level6": "", "Level7": "", "Level8": "", "Level9": "", "Name": "test", "Role": null, "Type": null, "UpNotify": null }

EscalationsDeleteDELETE

1
}

Anchor

	events
	events

Events

Create

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

EventsGETGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}events.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testevents.jsoncode

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

Anchor
eventsevents

Events

Create

POSTEventsGETGEThttp://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 "test event API", "Event": "Self-test-API", "Log": "true", "Notify": "true", "Stateful": "false", "Status": "Status": "false" }

EventsGETGET

"false",
    "_id": "Self-test-API"
}

EventsUpdatePUThttp://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
EventsDeleteDELETEhttp://host/en/omk/admin/api/v2/events /events/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.jsonEventsGETGET

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

Anchor

	polling-policy
	polling-policy

Polling-PolicyCreatePOSThttp://host/en/omk/admin/api/v2/events/{event-name}polling-policy.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" }

EventsUpdatePUTpolling-policy.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/events/{event-name}polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-APIpolling-policy.json
EventsPolling-PolicyDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/events polling-policy/{event-policy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-APIpolling-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",
    "redirect_toupdate": null "2d",
    "success    "wmi": "1h"
1
}

Anchorpolling-policypolling-policyPolling-PolicyCreateUpdatePOSTPUThttp://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 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.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json

    "wmi": "1h"
}

Polling-PolicyGETDeleteGETDELETEhttp://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-PolicyUpdatePUT

    "redirect_to": null,
    "success": 1
}

Anchor

	users
	users

UsersCreatePOSThttp://host/en/omk/admin/api/v2/polling-policy/{policy name}users.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequentlyusers.jsonDELETE

{ "description": "poll",

Code Block
Code Block
{ "nameadmission": "very_very_infrequentlytrue", "pinggroups": "30mall", "snmpprivilege": "1hadministrator", "updateuser": "2dtest", "wmi": "1h" }

Polling-PolicyDelete

UsersGETGEThttp://host/en/omk/admin/api/v2/users.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json
UsersGETGEThttp://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequentlyusers/test.json

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

AnchorusersusersUsersCreatePOST

 "test",
    "admission": "true",
    "groups": [
        "all"
    ],
    "privilege": "administrator",
    "user": "test"
}

UsersUpdatePUThttp://host/en/omk/admin/api/v2/users/{user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/test.json

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

UsersGETGEThttp://host/en/omk/admin/api/v2/users.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.jsonUsersGETGETDeleteDELETEhttp://host/en/omk/admin/api/v2/users/{user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/test.json

Code Block
{ "redirect_idto": "test" null, "admission": "true", "groups": [ "all" ], "privilegesuccess": "administrator", "user": "test" 1 }

Users

Anchor

Update

	access

PUThttp://host/en/omk/admin/api/v2/users/{user:name}.json

	access

AccessCreatePOST

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/testaccess.json

Code Block

{
    "admission"descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "false0",
    "groupslevel2": [
        "all"
    ]"0",
    "level3": "0",
    "level4": "0",
    "privilegelevel5": "administrator0",
    "username": "test_logs"
}

UsersAccessDeleteGETDELETEGET

http://hostapollo.opmantek.net:8080/en/omk/admin/api/v2/users/{user:name}access.json
AccessGETGET

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/usersaccess/test_logs.json

Code Block
{ "_id": "test_logs", "descr": "Enable button Logs", "group": "button", "level0": "1", "level1": "0", "redirect_tolevel2": null, "success": 1 }

AnchoraccessaccessAccessCreatePOST

 "0",
    "level3": "0",
    "level4": "0",
    "level5": "0",
    "name": "test_logs"
}

AccessUpdatePUT

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json

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

AccessGETDeleteGETDELETE

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.jsonAccessGETGET

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

Anchor

	customers
	customers

CustomersCreatePOST

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", "level1customers.json

Code Block
{ "customer": "0test", "level2description": "0", "level3groups": "0", "level4locations": "0", "level5": "0", "name": "test_logs" }

AccessUpdatePUT

 null
    }

CustomersGETGET

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json
CustomersGETGET

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/accesscustomers/test_logs.json

Code Block
{ "_id": "test_logs", "descrcustomer": "Enable button Logstest", "groupdescription": "button new", "level0groups": "1", "level1locations": "0", "level2": "0", "level3 null }

CustomersUpdatePUT

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json

Code Block
{ "customer": "0test", "level4description": "0this is test", "level5groups": "0", "namelocations": "test_logs" null }

Access

CustomersDeleteDELETE

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/accesscustomers/test_logs.json

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

AnchorcustomerscustomersCustomersCreatePOSTCustomersGETGETCustomersGETGETCustomersUpdatePUTCustomersDeleteDELETE

Anchor

	business
	business

Business ServicesCreatePOST

Business ServicesGETGET

Business ServicesGETGET

Business ServicesUpdatePUT

Business ServicesDeleteDELETE

...

Versions Compared

Old Version 25

New Version 26

Key