Description

Feature Preview: some features of this endpoint are limited to enterprise or self-hosted customers.

Trigger a refresh of all public nautical chart data (NOAA ENCs and USA Inland ENCs). This creates an asynchronous background job that downloads the latest charts from their upstream sources and re-indexes them into the Vector Charts system.

Only one refresh job can run at a time. If a refresh is already in progress, the endpoint will return a 409 Conflict error.

Authentication

This endpoint requires a Bearer token in the Authorization header.

• Authorization (Required): Bearer <token> — a valid Vector Charts API token.

Response Schema

On success, the endpoint returns a response indicating that the job has been queued for processing:

• job_id: Unique identifier for the chart refresh job.
• job_state: Initial status will be "pending". Transitions to "processing", then "completed" or "failed".

Error Responses

• 403 Forbidden: The instance is not an enterprise deployment.
• 409 Conflict: A chart refresh job is already in progress.

Example Request
POST https://api.vectorcharts.com/api/v1/charts/refresh
Authorization: Bearer <token>

Example Response
Status Code: 200 OK
Response Body:
{
    "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "job_state": "pending"
}