Versions Compared

Old Version 31

changes.mady.by.user Arihant Bansal

Saved on

compared with

New Version 32

changes.mady.by.user John Sinclair

Saved on

Key

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


API OPTIONSLocationsServicesContactsEscalationsEventsPolling-PolicyUsersAccessCustomersBusinessServices

...

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 entry

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

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 entry

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

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


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


ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonUpdate 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": ""
}


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


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


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


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


EventsDeleteDELETEhttp://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-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
  {
        "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
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json
Polling-PolicyGETGEThttp://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-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/polling-policy/{policy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json
 Code Block
{
    "redirect_to": null,
    "success": 1
}

 Anchor
users
users
UsersCreatePOSThttp://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":  "testjohnsmith"
}

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/users/{user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/
test
johnsmith.json
 Code Block
{
    "_id":  "testjohnsmith",
    "admission":  "true",
    "groups":  [
        "all"
    ],
    "privilege":  "administrator",
    "user":  "testjohnsmith"
}

UsersUpdatePUThttp://host/en/omk/admin/api/v2/users/{user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/
test
johnsmith.json
 Code Block
{
    "admission":  "false",
    "groups":  [
        "all"
    ],
    "privilege":  "administrator",
    "user":  "testjohnsmith"
}

UsersDeleteDELETEhttp://host/en/omk/admin/api/v2/users/{user:name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/
test
johnsmith.json
 Code Block
{
    "redirect_to": null,
    "success": 1
}

 Anchor
access
access
AccessCreatePOSThttp://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"
}

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

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

AccessDeleteDELETEhttp://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
{
    "redirect_to": null,
    "success": 1
}

 Anchor
customers
customers
CustomersCreatePOSThttp://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
    }

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

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

CustomersDeleteDELETEhttp://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
{
    "redirect_to": null,
    "success": 1
}

 Anchor
business
business
Business ServicesCreatePOSThttp://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 ServicesGETGEThttp://host/en/omk/admin/api/v2/businessservices.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices.json
Business ServicesGETGEThttp://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 ServicesUpdatePUThttp://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 ServicesDeleteDELETEhttp://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
}

...