Deliveries API
Inspect and force-retry deliveries.
See the Deliveries concept for background.
List deliveries
Section titled “List deliveries”GET /v1/deliveries
Paginated list. Filter by event, destination, status, and time range.
Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
event_id | string | no | |
destination_id | string | no | |
status | string | no | ’pending’, ‘retrying’, ‘succeeded’, ‘dead’. |
since | string | no | ISO-8601. Inclusive lower bound. |
until | string | no | ISO-8601. Exclusive upper bound. |
cursor | string | no |
Returns
Section titled “Returns”A page of deliveries with status, response codes, and retry counts.
Example
Section titled “Example”curl -X GET https://api.harbor.example/v1/deliveries \ -H "Authorization: Bearer hk_live_your_api_key"Get a delivery
Section titled “Get a delivery”GET /v1/deliveries/{id}
Full detail on one delivery, including the full retry history.
Returns
Section titled “Returns”The delivery object with a retries[] array.
Example
Section titled “Example”curl -X GET https://api.harbor.example/v1/deliveries/dest_01HXYZ \ -H "Authorization: Bearer hk_live_your_api_key"Errors
Section titled “Errors”delivery_not_found
Force a delivery retry
Section titled “Force a delivery retry”POST /v1/deliveries/{id}/retry
Manually retry a delivery, bypassing the normal backoff schedule. Works on dead deliveries too.
Returns
Section titled “Returns”The delivery object, now in ‘retrying’ state.
Example
Section titled “Example”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"Errors
Section titled “Errors”delivery_not_founddelivery_too_old