Update Alarm Definition
Update Alarm Definition
Update Alarm Definition
Request
URI
POST
https://{api_host}/ssp/alarms/definitions/{id}
COPY
Path Parameters
string
id
Required
The unique identifier of the alarm definition to retrieve or modify. This ID is a system-generated identifier that uniquely identifies the alarm definition configuration in the system.
Request Body
UpdateAlarmDefinitionRequest
of type(s)
application/json
Optional
{
"enabled": true
}
boolean
enabled
Optional
Controls whether new alarm instances can be generated from this definition.
- true - The alarm definition is active and will generate new alarms
- false - The alarm definition is inactive and will not generate new alarms
Authentication
This operation uses the following authentication methods.
Responses
204
The alarm definition was successfully updated with the provided changes. The update has been applied and the new configuration is now active.
Operation doesn't return any data structure
404
The alarm definition to be updated was not found. This may occur if the ID is incorrect or if the alarm definition has been deleted. Verify the ID and try again.
Returns
Error
of type(s)
application/json
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}
integer
error_code
Required
HTTP Status or Application error code.
string
module_name
Optional
Module where the error happened.
string
error_message
Required
Message describing the error.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/alarms/definitions/{id}