Skip to main content
GET
Get by registration ID

Path Parameters

registrationId
string
required

Registration UUID

Response

OK

registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for forecast alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by a city (cityId) and a district (districtId); both fields are required.
  • POINT – boundary defined by a single longitude/latitude coordinate (point). The alarm evaluates forecast data for the nearest forecast grid cell to that coordinate.
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–14).

Example:

3

forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
webhook
object

Outbound callback configuration for this registration.

filter
object

Threshold filters that control which forecast conditions trigger an alarm.

createdAt
string<date-time>

Timestamp when the registration was first created (ISO-8601).

Example:

"2025-01-01T10:15:30Z"

updatedAt
string<date-time>

Timestamp of the most recent update to the registration (ISO-8601).

Example:

"2025-01-01T11:15:30Z"

warnings
string[]

Non-fatal warnings generated during registration processing.

Example: