Page Comparison

...

Locations

...

code-block

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

Anchor

	locations
	locations

Name

Operation

Method

URL

Response

Example

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

Services

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

theme	FadeToGrey

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

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

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

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

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.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json

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

Anchor

	escalations
	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

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

http://host/en/omk/admin/api/v2/escalations.json

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

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

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

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

Anchor

	events
	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

http://host/en/omk/admin/api/v2/events.json

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

Events

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

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

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.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

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

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/

locations

polling-policy/{policy name}.json

new Location in NMIS configurations.

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

locationsLocations

polling-policy/very_very_infrequently.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": ""
    }

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

Anchor

	users
	users

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

http://host/en/omk/admin/api/v2/

locations

users.json

Locations present in NMIS configuration file.

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

locations

users.json

Locations

Users

GET

http://host/en/omk/admin/api/v2/users/

locations

{

location-

user:name}.json

Locations present in NMIS configuration file.

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

locations

users/

Amsterdam

johnsmith.json

Code Block
{

"Address1

    "_id": "johnsmith",

"Address2": "", "City

    "admission": "

Amsterdam

true",

"Country

    "groups": [
        "

Netherlands

all"
    ],

"Floor

    "privilege": "administrator",

"Geocode

    "user": "

Amsterdam, Netherlands

johnsmith"

, "Latitude": "52.3675734", "Location": "Amsterdam", "Longitude": "4.9041389", "Postcode": "", "Room": "", "State": "", "Suburb": ""

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

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

Code Block
{ "redirect_to": null, "

_id

success":

"Amsterdam"

1
}

LocationsUpdatePUT

Anchor

	access
	access

Access

Create

POST

http://host/en/omk/admin/api/v2/

locations/{location-name}

access.json

Update location entry

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

locations/Mandatory param

access.json

Code Blocktheme

FadeToGrey

Code Block

Address1

descr":

 "Enable button Logs",

Address2

group":

 "button",

"City": "", "Country": "", "Floor": "", "Geocode": "fake geo code", "Latitude": "xx.xxxxxxx", "Location": "Mandatory param", "Longitude": "yy.yyyyyyy", "Postcode": "", "Room": "", "State": "", "Suburb": "" }LocationsDeleteDELETE

    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "0",
    "level4": "0",
    "level5": "0",
    "name": "test_logs"
}

Access

GET

http://host/en/omk/admin/api/v2

/locations/{location-name}

/access.json

Deletes the location entry from configurations

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

locations/Mandatory param

access.json

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

Anchorservicesservices

Services

Create

POST

Access

GET

http://host/en/omk/admin/api/v2

/services.jsonnew services in NMIS configurations.

/access/{access-id}.json

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

services

test_logs.json

Code Block
{ "_id": "test_logs",

"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.jsonServicesGETGET

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

services

access/{

service-name}.jsonServices present in NMIS configuration file.

access-id}.json

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

services

access/

dummy

test_logs.json

Code Block
{ "_id": "test_logs", "descr": "Enable button Logs",

"Description": "Dummy Entry for API", "Name": "dummy", "Poll_Interval": "5m", "Port": "", "Service_Name": "dummy.exe", "Service_Type": "new_type", "_id": "dummy" }ServicesUpdatePUT

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

services

access/{

service

access-

name

id}.json

Update Services entry

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

services/dumy.json Code Block

theme	FadeToGrey

{ "Description": "Dummy Entry for API", "Name": "dummy_updated", "Poll_Interval": "10m", "Port": "",

access/test_logs.json

Code Block
{ "

Service

redirect_

Name

to":

"dummy.exe"

null,
    "

Service_Type

success"

"new_type"DELETE

1
}

ServicesDelete

Anchor

	customers
	customers

Customers

Create

POST

http://host/en/omk/admin/api/v2/

services/{service-name}

customers.json

Deletes the Service entry from configurations

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

services/dummy_updated

customers.json

Code Block
{ "customer": "test",

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

Contacts

Create

POST

        "description": "",
        "groups": "",
        "locations": null
    }

Customers

GET

http://host/en/omk/admin/api/v2/

contacts/

customers.json

http://

host

apollo.opmantek.net:8080/en/omk/admin/api/v2/

contacts/

customers.json

Contacts

Customers

GET

http://host/en/omk/admin/api/v2/

contacts/

customers/{customer-name}.json

http://

host

apollo.opmantek.net:8080/en/omk/admin/api/v2

/contacts/.jsonContactsGETGET

/customers/test.json

Code Block
{ "_id": "test", "customer": "test", "description": "", "groups": "", "locations": null }

Customers

Update

PUT

http://host/en/omk/admin/api/v2/

contacts

customers/{

contact

customer-name}.json

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

contacts

customers/

johntest.jsonContactsUpdatePUT

test.json

Code Block
{ "customer": "test", "description": "this is test", "groups": "", "locations": null }

Customers

Delete

DELETE

http://

apollo.opmantek.net:8080

host/en/omk/admin/api/v2/

contacts/johntest

customers/{customer-name}.json

ContactsDelete

DELETE

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

contacts/johntest.jsonName AnchorescalationsescalationsOperationMethodURLResponseExample

code-block

Escalations

Create

POSTEscalationsGETGETEscalationsUpdatePUTEscalationsDeleteDELETE Anchoreventsevents

Events

Create

POSTEventsGETGETEventsUpdatePUTEventsDeleteDELETEEventsName Anchorpolling-policypolling-policyOperationMethodURLResponseExample

code-block

Polling-PolicyPolling-PolicyPolling-PolicyPolling-PolicyPolling-PolicyName AnchorusersusersOperationMethodURLResponseExample

code-block

UsersUsersUsersUsersUsersName AnchoraccessaccessOperationMethodURLResponseExample

code-block

AccessAccessAccessAccessAccessName AnchorcustomerscustomersOperationMethodURLResponseExample

code-block

CustomersCustomersCustomersCustomersCustomersName AnchorbusinessbusinessOperationMethodURLResponseExample

code-block

Business ServicesBusiness ServicesBusiness ServicesBusiness ServicesBusiness Services

customers/test.json

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

Anchor

	business
	business

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

http://host/en/omk/admin/api/v2/businessservices.json

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

Business Services

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

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices/test.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

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

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

Versions Compared

Old Version 16

New Version Current

Key