POST /api/v1/entities/{name}/bulk-export

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Bulk Export

Export selected rows as a downloadable JSON file.

Auth: Authorization: Bearer <token> required

Request

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/entities/<name>/bulk-export" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"format":"<format>","guids":"<guids>"}'

Response `200`

The contract carries no example for this response; schema: object. Field-level shape: interactive explorer.

Returns

object — Successful Response

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
`name`	path	yes	`string`	—	—
`Idempotency-Key`	header	no	`string`	—	uuid	Optional.

Request body

Field	Type	Required	Description
`format`	`string`	no
`guids`	`array of integer`	yes

Errors

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.