1. Home
  2. API Reference
  3. Acknowledgment API

Acknowledgment API

OmniCenter’s API system must be enabled to use this API. See, How to Enable OmniCenter API Access.

Calls to this API are made using HTTP/HTTPS and are sent as key/value pairs in a GET or POST request.

Security

Netreo recommends always using POST for API calls if possible. If security is a concern we recommend the use of HTTPS and POST requests.

Resource

The resource accessed by this API is the state of an OmniCenter incident. Incidents are how OmniCenter tracks problems in your network. Acknowledging an incident lets everyone involved know that someone is working on the problem.

This resource offers the following endpoints:

  • Acknowledge Incident

Resource URL

{your.omnicenter.ip.or.name}/utils

Endpoints

Acknowledge Incident

GET or POST
/incident_ack.php
Sets the incident state of the specified incident to ACKNOWLEDGED.

Parameters

The parameters for this endpoint can be included as query string parameters in a GET request, or as request body parameters in a POST request.

password
String/Required if authentication is enabled.
The API key set in OmniCenter’s API Administration. Case-sensitive.

incident_id
String/Required
The unique identifier assigned to the incident by OmniCenter.

ack_user
String/Required
A name to associate this acknowledgement action with. Does not have to match an existing username in OmniCenter to be accepted (so an automated value like “Ticketing System” is acceptable).

ack_comment
String/Optional
A comment that will be added to the record of the acknowledgement in OmniCenter and sent out in any acknowledgement alerts. Limit of 255 characters.

Request Examples

Acknowledge Using GET with API Authentication Disabled

http://38.2.11.62/utils/incident_ack.php?incident_id=111-S-937182322&ack_user=administrator&ack_comment=Ticket 2074 created and assigned to jsmith

Acknowledge Using GET with API Authentication Enabled

http://38.2.11.62/utils/incident_ack.php?incident_id=111-S-937182322&ack_user=administrator&ack_comment=Ticket 2074 created and assigned to jsmith&password=PassWord1234

Response

A successful call to this API will return a single binary value.

Response Example

Successful acknowledgment

1

Response Schema

Output Type Description
0 number Indicates the acknowledgement failed.
1 number Indicates the acknowledgement was successful.
Updated on July 1, 2019

Was this article helpful?

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Reply