MEmetabase
/api/document

GET /api/document/public

Changed on

List all Documents that have public links.

Returns a sequence of Documents that have been publicly shared. Each Document includes its :id, :name, and :public_uuid. Documents are only actually accessible via the public endpoint if public sharing is currently enabled. Archived Documents are excluded from the results.

This endpoint is used to populate the public links listing in the Admin settings UI.

Requires superuser permissions. Public sharing must be enabled via the enable-public-sharing setting.

get/api/document/public

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Response

Successful response

idinteger required

value must be an integer greater than zero.

namestring required
public_uuidstring required

value must be a valid UUID.

Changes