alerts

Get specific alert

Returns the configuration data for an alert with the specified ID.

get/alerts/{id}

Request

Response

Returns alert configuration structure.

idinteger required

Unique ID for alert, can be used to update or delete alert.

descriptionstring required

Server-generated textual description of alert. May include carrier, flight number, origin, destination, etc.

identstring nullable required

Ident to alert on. This value may be modified based on codeshare resolution. If that occurs, the originally provided ident will be preserved in the user_ident field.

ident_icaostring nullable

ICAO ident to alert on

ident_iatastring nullable

IATA ident to alert on

originstring nullable required

Origin airport ICAO, IATA, or LID code to alert on.

origin_icaostring nullable

Origin airport ICAO code to alert on.

origin_iatastring nullable

Origin airport IATA code to alert on.

origin_lidstring nullable

Origin airport LID code to alert on.

destinationstring nullable required

Destination airport ICAO, IATA, or LID code to alert on.

destination_icaostring nullable

Destination airport ICAO code to alert on.

destination_iatastring nullable

Destination airport IATA code to alert on.

destination_lidstring nullable

Destination airport LID code to alert on.

aircraft_typestring nullable required

Aircraft type ICAO code to alert on.

createdstring date-time required

Time that the alert was created.

changedstring date-time required

Time that the alert was last modified.

startstring date nullable required

Start date of alert. Should be in departure airport's timezone.

endstring date nullable required

End date of alert (inclusive). Should be in departure airport's timezone.

user_identstring nullable required

Originally specified ident.

etainteger required

How many minutes before a flight's ETA that an alert should be delivered. Alerts will only be delivered after the flight has been in the air for at least 15 minutes. Set to 0 to disable.

target_urlstring nullable required

Alert specific URL to deliver to. If null, then the alert will be delivered to the configured account-wide alert URL target.

enabledboolean required

Whether alert is enabled.

Example response

{
  "created": "2021-12-31T19:59:59Z",
  "changed": "2021-12-31T19:59:59Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.