...
| 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Locations | GET | 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 | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Services | GET | 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 | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contacts | GET | 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 | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Escalations | Create | POST | Escalations | GET | GET | GET | GET | Escalations | Update | PUT | Escalations | Delete | DELETE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | http://host/en/omk/admin/api/v2/escalations.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Escalations | GET | GET | http://host/en/omk/admin/api/v2/escalations.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Events | Create | POST | http://host/en/omk/admin/api/v2/events.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Events | GET | GET | http://host/en/omk/admin/api/v2/events.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Events | GET | 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Polling-Policy | GET | 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 | 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Polling-Policy | Delete | DELETE | 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Users | Create | POST | http://host/en/omk/admin/api/v2/users.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Users | GET | GET | http://host/en/omk/admin/api/v2/users.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.json | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Users | GET | GET | http://host/en/omk/admin/api/v2/users/{user:name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/johnsmith.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Access | Create | POST | http://host/en/omk/admin/api/v2/access.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Access | GET | GET | http://host/en/omk/admin/api/v2/access.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.json | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Access | GET | GET | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Access | Update | PUT | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Access | Delete | DELETE | http://host/en/omk/admin/api/v2/access/{access-id}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access/test_logs.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customers | Create | POST | http://host/en/omk/admin/api/v2/customers.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customers | GET | GET | http://host/en/omk/admin/api/v2/customers.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.json | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customers | GET | GET | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customers | Update | PUT | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customers | Delete | DELETE | http://host/en/omk/admin/api/v2/customers/{customer-name}.json | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers/test.json
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Business Services | GET | 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 | 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Business Services | Update | PUT | http://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| events | events | Events | Create | Events | GET | GET | GET | GET | Events | Update | PUT | Events | Delete | DELETE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | polling-policy | polling-policy | Polling-Policy | Create | POST | Polling-Policy | Polling-Policy | Polling-Policy | Polling-Policy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | users | users | Users | Create | POST | Users | Users | Users | Users | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | access | access | Access | Create | POST | Access | Access | Access | Access | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customers | customers | Customers | Create | POST | Customers | Customers | Customers | Customers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | business | business | Business Services | Create | POST | Business Services | Business Services | Business Services | Business Services |