Skip to main content

POST /api/files/{id}/share

mint a share URL

MethodPOST
Path/api/files/{id}/share
Feature areaFiles
TagOther
Authmachine key — Authorization: Bearer $ZEQ_KEY
Tierauthenticated (machine-control)

Parameters

Path parameters

NameTypeRequiredDescription
idstringyes

No query or header parameters are published for this operation.

Request body

Optional. Content type: application/json.

The node publishes this body as a free-form JSON object — no field schema is exposed in openapi.json. Send the fields the summary above describes; the endpoint validates them and refuses rather than guessing.

Responses

StatusMeaning
200OK
401Missing or invalid credentials
403Forbidden — authenticated, but not permitted for this resource
404Not found
410Gone — retired endpoint

401 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

403 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

404 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

410 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

Call it

curl -sS -X POST https://zeq.me/api/files/01J8ZQ2H9VMR4K/share \
-H "Authorization: Bearer $ZEQ_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Needs a machine key. Mint one: curl -sS -X POST https://zeq.me/api/demo-key/mint, then spin up your machine.


Generated from the live OpenAPI description (https://zeq.me/openapi.json, spec version 1.287.0) by scripts/generate-reference.mjs. Do not edit — this file is rewritten on every run.