Page Comparison

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

...

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

http://hostapollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/.json.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

Contacts

GET

http://host/en/omk/admin/api/v2/contacts/{contact-name}.json

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

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

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

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

Name

Anchor

	escalations
	escalations

Operation

Method

URL

Response

Example

code-block

Escalations

Create

POST

Escalations

GET

Escalations

Update

PUT

Escalations

Delete

DELETE

Anchor

	events
	events

Events

Create

POST

Events

GET

Events

Update

PUT

Events

Delete

DELETE

Events

Name

Anchor

	polling-policy
	polling-policy

Operation

Method

URL

Response

Example

code-block

Polling-Policy

Name

Anchor

	users
	users

Operation

Method

URL

Response

Example

code-block

Users

Name

Anchor

	access
	access

Operation

Method

URL

Response

Example

code-block

Access

Name

Anchor

	customers
	customers

Operation

Method

URL

Response

Example

code-block

Customers

Name

Anchor

	business
	business

Operation

Method

URL

Response

Example

code-block

Business Services

...

Versions Compared

Old Version 17

New Version 18

Key