Authentication
All Maritime Sentry API requests must be authenticated with either an API key or bearer token (JWT) issued by the Vantor Hub platform.
For details on obtaining and refreshing credentials, see the authentication guide:
https://developers.maxar.com/docs/authentication/
Permissions
Beyond a valid credential, most endpoints require one or more roles on your account. Every operation in this reference states its own requirement under Required permissions.
| Role | Grants |
|---|---|
CROWS_NEST_BASE_USER | Baseline access. Required by every endpoint below; without it any request is rejected with a 403. |
CROWS_NEST_MANUAL_TIPPING | Submitting tips, live or test. |
CROWS_NEST_MANAGE_WATCHBOXES | Creating and updating watchboxes. |
CROWS_NEST_MANAGE_TIPPING_RULESETS | Creating and updating tipping rulesets. |
Reading is separated from writing throughout: CROWS_NEST_BASE_USER alone is enough to
query watchboxes, tipping rulesets, tips, and alerts, but changing any of them needs the
matching manage role.
Customer scope
Your token also determines which customers' data you can see. Requests are resolved to the customer(s) your account is associated with, and every result is limited to those.
The customer query parameter is a filter within that scope, not a way to widen it: the
values you pass are intersected with what your token allows. Filtering to a customer you
have no access to returns a 400 rather than silently returning nothing.
Accounts granted CROWS_NEST_ALL_DATA are not restricted to a single customer and may
query across all of them. It is not required by any endpoint; it only widens scope.