Create Custom Zone

Production

https://api.polestar-production.com

POST

/zone-port-insights/v1/zones/custom

Create a custom circular or polygon zone.

Once created, custom zones function in exactly the same way as standard
zones, but are linked to your account only. The custom zone id can be
used to extract, for example, zone entry and exit events via the Zone &
Port Traffic endpoint.

Request

Authorization

API Key

Add parameter in header

api-key

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

The created zone.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/zone-port-insights/v1/zones/custom' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "account_id": "1939ef43-72d1-42e7-bce5-cdb215c43dd3",
    "name": "Zone A",
    "description": "A polygon zone",
    "custom_type": "POLYGON",
    "polygon_details": {
        "format": "GeoJson",
        "polygon": "{\"features\":[{\"geometry\":{\"coordinates\":[[[30,20],[40,40],[20,40],[10,20],[30,20]]],\"type\":\"Polygon\"},\"type\":\"Feature\",\"properties\":{}}],\"type\":\"FeatureCollection\"}"
    }
}'

Response Example

201 - A circular custom zone, as created

{
    "meta": {
        "request_id": "3b1f6c2e-8d47-4a9e-b1c5-7e2f0a9d4c61",
        "request_timestamp": "2026-09-30T09:12:44Z",
        "zone_version": "0.8.2"
    },
    "data": {
        "id": "7f3c9a2e-4b18-4d6f-9e21-5a8c0d7b3f14",
        "name": "Maasvlakte approach watch",
        "type": "Custom",
        "sub_type": "Custom",
        "description": "Five nautical mile circle on the Maasvlakte approach, for arrival alerts",
        "centroid": {
            "longitude": 3.95,
            "latitude": 51.98
        },
        "country_code": "",
        "country_common_name": "",
        "country_official_name": "",
        "sub_division_code": "",
        "sub_division_name": "",
        "unlocode": "",
        "wpi_number": "",
        "custom_type": "CIRCULAR",
        "created_by": "j.harding@example.com",
        "created_at": "2026-09-30T09:12:44Z",
        "last_modified_by": "j.harding@example.com",
        "last_modified_at": "2026-09-30T09:12:44Z",
        "circle_details": {
            "latitude": "51.98",
            "longitude": "3.95",
            "radius": "9260"
        }
    }
}

Modified at 2026-10-19 12:14:24

Custom Zones

Edit Custom Zone