Versions Compared

Key

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


...


...

{escalations.json{polling-policy.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": "",
    "Pager": "",
    "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
{
    "Contact": "Test-Contact",
    "DutyTime": "1",
    "Email": "test@gmail.com",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Mobile"Pager": "",
    "Phone": "",
    "PagerTimeZone": "","
}


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
{
    "Phoneredirect_to": ""null,
    "TimeZonesuccess": ""1
}
ContactsDeleteDELETE


Anchor
escalations
escalations

Escalations

Create

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


Code Block
{
    "Event": null,
    "Event_Element": "",
    "redirect_toEvent_Node": "",
    "Group": null"",
    "successLevel0": 1
}
Anchor
escalationsescalations

Escalations

Create

POSThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json
Code Block
{"",
    "Level1": "",
    "Level10": "",
    "Level2": "",
    "EventLevel3": null"",
    "Event_ElementLevel4": "",
    "Event_NodeLevel5": "",
    "GroupLevel6": "",
    "Level0Level7": "",
    "Level1Level8": "",
    "Level10Level9": "",
    "Level2Name": "test",
    "Level3Role": ""null,
    "Level4Type": ""null,
    "Level5": "",
    "Level6": "",
    "Level7": "",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
{
    "Level8Event": ""null,
    "Level9Event_Element": "",
    "NameEvent_Node": "test",
    "RoleGroup": null,     "Type": 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
{Level0": "",
    "Level1": "",
    "Level10": "",
    "Level2": "",
    "EventLevel3": null"",
    "Event_ElementLevel4": "",
    "Event_NodeLevel5": "",
    "GroupLevel6": "",
    "Level0Level7": "",
    "Level1Level8": "",
    "Level10Level9": "",
    "Level2Name": "test",
    "Level3Role": ""null,
    "Type": null,
    "Level4UpNotify": ""null,
    "Level5_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
{
    "Level6Event": "test",
    "Level7Event_Element": "",
    "Level8Event_Node": "",
    "Level9Group": "",
    "NameLevel0": "test",
    "RoleLevel1": null"",
    "TypeLevel10": null,
    "UpNotify": null,
    "_idLevel2": "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
{",
    "Level3": "",
    "EventLevel4": "test",
    "Event_ElementLevel5": "",
    "Event_NodeLevel6": "",
    "GroupLevel7": "",
    "Level0Level8": "",
    "Level1Level9": "",
    "Level10Name": "test",
    "Level2Role": null,
    "Type": ""null,
    "Level3": "",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
{
    "Level4redirect_to": ""null,
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}
EscalationsDeleteDELETE
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/escalations/{escalation-event}events.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json
Code Block
{
    "redirect_to": null,
    "success": 1
}
Anchor
eventsevents

Events

Create

POSTevents.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
test event API",

       

    "Event": "Self-test-API",

       

    "Log": "true",

       

    "Notify": "true",

       

    "Stateful": "false",

       

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


EventsGETUpdateGETPUThttp://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
EventsGETDeleteGETDELETEhttp://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{
    "CancelingEvent""N/A",
    "Description""test event API",
    "Event"":8080/en/omk/admin/api/v2/events/Self-test-API",
    "Log""true",
    "Notify""true",
    "Stateful""false",
    "Status""false",
    "_id""Self-test-API"
}
EventsUpdatePUT.json


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.jsonEventsDeleteDELETEhttp://host/en/omk/admin/api/v2/events/{event-name}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json
Code Block


Code Block
  {
        "description": "poll very infr_very.equently",
        "name": "very_very_infrequently",
        "ping": "30m",
        "snmp": "1h",
        "redirect_toupdate": null"2d",
        "wmi": "1h"
  "success": 1 }
Anchor
polling-policypolling-policyPolling-PolicyCreatePOSThttp://host/en/omk/admin/api/v2/polling-policy.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json


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

UsersCreatePOST



UsersGETGET



UsersGETGET



UsersUpdatePUT



UsersDeleteDELETE



Anchor
access
access

AccessCreatePOST



AccessGETGET



AccessGETGET



AccessUpdatePUT



AccessDeleteDELETE



Anchor
customers
customers

CustomersCreatePOST



CustomersGETGET



CustomersGETGET



CustomersUpdatePUT



CustomersDeleteDELETE



Anchor
business
business

Business ServicesCreatePOST



Business ServicesGETGET



Business ServicesGETGET



Business ServicesUpdatePUT



Business ServicesDeleteDELETE



...