Acknowledgment API

Netreo's API system must be enabled to use this API. See How to Enable Netreo API Access

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

Resource

The resource accessed by this API is the state of an Netreo incident. Incidents are how Netreo 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.netreo.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 Netreo’s API Administration. Case-sensitive.

pin
String/Required when using Netreo SaaS-based APIs. Not applicable to on-premise deployments.
The pin number supplied in Netreo’s API Administration.

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

ack_user
String/Required
A name to associate this acknowledgement action with. Does not have to match an existing username in Netreo 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 Netreo 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