Exports (v1)

Start a markdown export of the site (asynchronous)

Accepts the work and answers 202 with a Location pointing at the job. Exporting N pages means N loopback fetches and conversions, so it does not fit in one response. Poll the status URL until status is completed, then read the result. Jobs are instance-scoped and expire after 15 minutes.

post/api/v1/exports

Request

  • Base URL: https://dribba.com
  • URL: https://dribba.com/api/v1/exports
  • Auth: none required

Headers

Idempotency-Keystring

Client-generated key (a UUID is fine). Repeating a request with the same key and the same body replays the stored response and adds Idempotency-Replayed: true. The same key with a different body is rejected with 400.

Request body

pathsstring[]

Site paths to export, as listed in /sitemap.xml. Omit it and the first 50 pages by sitemap priority are used.

Response

Export accepted; poll the status URL

idstring required
status'accepted' | 'running' | 'completed' | 'failed' required
created_atstring date-time
finished_atstring date-time nullable
status_urlstring uri required
result_urlstring uri nullable
errorstring nullable
expires_atstring date-time
instance_scopedboolean
notestring
requested_pagesinteger
unknown_pathsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.