Get Zone & Port Notification Subscriptions

Production

https://api.polestar-production.com

GET

/notifications/v1/zones-and-ports

Lists the zone and port notification subscriptions on your account. Part of
both Port & Trade and Domain & Fleet.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

api-key: ********************

Query Params

Responses

🟢200OK

application/json

Returns a page of zone and port notification subscriptions.

Headers

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/notifications/v1/zones-and-ports?active=true&limit=100&offset=0' \
--header 'api-key: <api-key>'

Response Example

200 - success

{
    "meta": {
        "limit": 100,
        "offset": 0,
        "request_id": "550e8400-e29b-41d4-a716-446655440000",
        "request_timestamp": "2026-08-12T10:20:00Z",
        "total_count": 1
    },
    "data": [
        {
            "active": true,
            "callback_url_status": "ok",
            "created_at": "2026-08-12T10:15:30Z",
            "created_by": "user@example.com",
            "custom_reference": "OPS-ROTTERDAM-114",
            "subscription_id": "1c60546c-da9d-425c-8eed-0142af219601",
            "last_modified_at": "2026-08-12T10:15:30Z",
            "description": "Entry and exit alerts for the Rotterdam port area",
            "name": "Rotterdam port call watch",
            "settings": {
                "notification_callback_url": "https://webhooks.example.com/event-notifications"
            }
        }
    ]
}

Modified at 2026-10-21 13:57:11

Create Zone & Port Notification Subscription

Edit Zone & Port Notification Subscription