Search a vault's ingots
Changed onA page of the vault's ingots matching every filter sent: a whole name (q), a type (file_type), a folder and a size range. One index is read, chosen by the filters in that order: names for q; ingots in creation order for file_type, the folder's own with folder_id, else the vault's; sizes for a size range; sort_order orders the last two, desc (the default) reading the last first. The other filters narrow what that index holds, so a page can hold fewer ingots than limit, or none, while has_more is true: follow next_cursor until it is false, never stop on the count. Names and types are stored sealed, so no index holds a type: a file_type page reads at most 400 ingots, and can end with none that match while more remain. An ingot's type is its content_type; an ingot a product manages matches no type.
Request
- Base URLhttps://api.sparkvault.com/v1
- Auth
- API key in header X-API-Key and API key in header X-Vault-Access-Token
- or HTTP bearer and API key in header X-Vault-Access-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The vault.
Query parameters
The ingot's whole file name, matched exactly as a Unicode compatibility caseless match: letter case, composed and decomposed accents and compatibility forms aside (Café.pdf matches CAFÉ.PDF, Straße matches STRASSE). No prefix, substring or fuzzy match. A comma is part of the name. At most 255 characters.
A family, a media type's top-level type (image, video, audio, text, application, font, model, …; the sound formats platforms type outside the audio tree, application/ogg and video/x-ms-wma, are in audio), or one exact type (application/pdf), in lowercase. An exact type matches an ingot of that type with or without parameters: application/json matches application/json;charset=utf-8, never application/json-patch+json. Read by its syntax, never against a list: a family no ingot belongs to matches nothing.
Only the ingots directly in this folder. Omitted: the whole vault.
The fewest bytes a match holds.
The most bytes a match holds.
A page-size hint: a value above 200 reads as 200, and a missing, zero, negative or non-numeric one as 50.
The next_cursor a previous page returned, with the same filters and sort_order.
Response
A page of matching ingots.
Changes
- info
the response property
/became required for the status - info
the response property
/became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
/became required for the status - info
the response property
/became required for the status - info
added the required property
/to the response with the status - info
added the required property
/to the response with the status
- info
- breaking
the response property
/became nullable for the status - breaking
the response property
/became nullable for the status
- breaking