Retrieve alarm details

Retrieve the details of an alarm.

Request

Security:

bearerAuth

path Parameters

alarmId

required

string^[1-9]\d*$

The ID of the alarm. Obtain this from GET /alarms.

Example: 62

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/alarms/{alarmId}

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api-prod.surfsight.net/v2/alarms/:alarmId \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"data": {"id": 625,
"details": "cyclic_recorder_status: 4, last_video_record_time: 1600683797",
"organizationId": 17,
"organizationName": "Company Name",
"partnerId": 1,
"partnerName": "James",
"userId": 32,
"alarmDefinitionId": 625,
"createdAt": "2019-08-24T14:15:22Z",
"lastReadAt": "2019-08-24T14:15:22Z",
"lastCloseAt": "2019-08-24T14:15:22Z",
"comments": [{"details": "comment about the alarm",
"id": 34,
"alarmId": 625,
"createdByAudienceName": "surfsight",
"createdById": 9,
"createdAt": "2019-08-24T14:15:22Z",
"commentorName": "Commentor name"
}
],
"actions": [{"type": "open",
"id": 125,
"alarmId": 625,
"createdByAudienceName": "surfsight",
"createdById": 625,
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}
}