storage

Run SQL against one durable storage bucket.

Run SQL against one durable storage bucket. Requires package:write (connection-profile write) whenever storage_id resolves to a package bucket — including writable:false SELECT/EXPLAIN/PRAGMA inspection. Defaults to read-only SQL and only allows SELECT, EXPLAIN, and schema PRAGMA queries unless writable is explicitly true. A large read is allowed and metered; warning is set once the scan crosses the oversized-read line, and the call stops only after the documented row ceiling.

Org permission: package:write.

post/v1/storage/{storage_id}/query

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/storage/{storage_id}/query
  • Auth: HTTP bearer

Path parameters

storage_idstring required

Durable storage id to inspect.

Request body

querystring required
writableboolean

Optional write access toggle. Defaults to false for inspection workflows.

Response

Success.

oktrue required
storage_idstring required
querystring required
columnsstring[] required
rowsobject[] required
row_countnumber required
rows_readnumber required
rows_writtennumber required
truncatedboolean required
warningstring nullable required

Set when this statement examined at least 1000000 rows. The read is allowed and metered on the monthly Rows read include. Null under that line. A read stops after 1000000000 rows.

writableboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.