Skip to content

Deliveries API

Inspect and force-retry deliveries.

See the Deliveries concept for background.

GET /v1/deliveries

Paginated list. Filter by event, destination, status, and time range.

NameTypeRequiredDescription
event_idstringno
destination_idstringno
statusstringno’pending’, ‘retrying’, ‘succeeded’, ‘dead’.
sincestringnoISO-8601. Inclusive lower bound.
untilstringnoISO-8601. Exclusive upper bound.
cursorstringno

A page of deliveries with status, response codes, and retry counts.

Terminal window
curl -X GET https://api.harbor.example/v1/deliveries \
-H "Authorization: Bearer hk_live_your_api_key"

GET /v1/deliveries/{id}

Full detail on one delivery, including the full retry history.

The delivery object with a retries[] array.

Terminal window
curl -X GET https://api.harbor.example/v1/deliveries/dest_01HXYZ \
-H "Authorization: Bearer hk_live_your_api_key"
  • delivery_not_found

POST /v1/deliveries/{id}/retry

Manually retry a delivery, bypassing the normal backoff schedule. Works on dead deliveries too.

The delivery object, now in ‘retrying’ state.

Terminal window
curl -X POST https://api.harbor.example/v1/deliveries/dest_01HXYZ/retry \
-H "Authorization: Bearer hk_live_your_api_key" \
-H "Content-Type: application/json"
  • delivery_not_found
  • delivery_too_old