Adding incident comments¶

To add comments to an incident.

POST

https://Logpoint-IP/add_incident_comment

Parameter	Value Type	Description
username	String	Logpoint username
secret_key	String	Access key to uniquely identify an authorized user. Go to Finding the Access Key for information on retrieving it.
requestData	JSON Object	A JSON objects containing the following parameters: _ids: Value of the object ID of the particular incident. comments: Comments to be added to a particular incident.

Parameter

Value Type

Description

username

String

Logpoint username

secret_key

String

Access key to uniquely identify an authorized user. Go to Finding the Access Key for information on retrieving it.

requestData

JSON Object

A JSON objects containing the following parameters:

_ids: Value of the object ID of the particular incident.

comments: Comments to be added to a particular incident.

Parameters¶

Parameters are data sent along with the request to retrieve information. It should be included in the request body as raw text. Content-Type, Content-Length, and Host must be passed in the request header. Content-Type should be application/json.

{
        "username": "John",
        "secret_key": "a1b2c3d4e5f6g7h8i9j0k1",
        "requestData": {
                "version": "0.1",
                "states": [
                {
                        "_id": "6156e859b92e73ec9b0b9bfa",
                        "comments": [
                                "Comment1",
                                "Comment2"
                                ]
                        },
                {
                        "_id": "6156e985b92e73ec9b0b9bfb",
                        "comments": [
                                "Comment1",
                                "Comment2"
                                ]
                }
                ]
        }
}

Request Example¶

Incident Comment using Postman.¶

cURL Code¶

curl --location 'https://10.45.10.172/add_incident_comment' \
--header 'Content-Type: application/json' \
--data '{
    "username": "John",
    "secret_key": "a1b2c3d4e5f6g7h8i9j0k1",
    "requestData": {
        "version": "0.1",
        "states": [
            {
                "_id": "6156e859b92e73ec9b0b9bfa",
                "comments": [
                    "Test Comment"
                ]
            }
        ]
    }
}'

Sample JSON response¶

{
        "success": true,
        "message": "Comments added"
}

Response Parameters¶

Response Parameters	Value Type	Description
success	Boolean	Returns True if the API call is successful; otherwise it returns False.
message	String	A message confirming the comment is added to the particular incident.

Helpful?