Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Add extra properties to alert

This endpoint is used to enrich existing alerts with additional information to provide more detailed context.

post/api/{cloudId}/v1/alerts/{id}/extra-properties

Path parameters

idstring required

Identifier of the alert.

Request body

extraPropertiesExtraProperties required

Map of key-value pairs to use as custom properties of the alert. This can include context-specific data, diagnostic information, or other metadata that can assist in understanding and resolving the alert.

Example request

{
  "extraProperties": {
    "backend": false,
    "browser": "Firefox 113.0",
    "browser.name": "Firefox",
    "bundler": "parcel@2.10.3",
    "environment": "production"
  }
}

Response

Returned if the request is successful.

resultstring

Indicates the outcome of the request.

requestIdstring

Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.

tookinteger

Example response

{
  "result": "Request will be processed",
  "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777"
}