1.2

patch /v1/alerts/{id}/description

Description

Set the Alert Description

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string	None
body	body required		AlertDescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AlertDescriptionSetResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/alerts/{id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "description": "Alert1 Description"
}

Example HTTP response

Response 200

{
    "description": "Alert1 Description",
    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
    "modified_at": "2026-03-13T02:34:40.006634"
}