Skip to main content
Download alerts

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

ids
string[]

Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them).

Maximum array length: 1000

Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them).

Maximum string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

Response

A response containing the downloaded alert data

content
string<byte>

Base64-encoded binary data of the alert definitions

Example:

"SGVsbG8gV29ybGQ="

notFoundIds
string[]

Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message.

Maximum array length: 1000

Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message.

Maximum string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: