Skip to main content
GET
ListNavigationalWarnings

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

page_size
integer<int32>

Maximum items per page (1-100). Accepted but currently ignored; no-op until this handler supports the parameter.

cursor
string

Cursor for next page. Accepted but currently ignored; no-op until this handler supports the parameter.

area
string

Optional area filter (e.g., "NAVAREA IV", "Persian Gulf").

jmespath
string

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

Successful response

ListNavigationalWarningsResponse contains navigational warnings matching the request.

warnings
object[]
pagination
object

PaginationResponse contains pagination metadata returned alongside list results.