Skip to navigation
API ReferenceFiles

List Files

View as Markdown

List the canonical durable File resource. Runtime file endpoints operate on a live machine disk: collect turns a machine file into a durable File, while stage performs the reverse. Use source, type, runId, runtimeId, path, prefix, and createdAfter filters here.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Query parameters

spaceIdstringOptional

Filter by a prefixed space ID, or pass default to use the caller default space.

sourceenumOptional
Allowed values:
pathstringOptional1-4096 characters
prefixstringOptional1-4096 characters
qstringOptional
runIdstringOptional
runtimeIdstringOptional
typelist of stringsOptional
Filter by one or more file artifact types. Repeat the query parameter for multiple values.
createdAfterdatetimeOptional
RFC 3339 timestamp with a UTC offset.
includeenumOptional
Allowed values:
cursorstringOptional
orderenumOptional
Order by createdAt and ID. Defaults to desc.
Allowed values:
limitintegerOptional<=200Defaults to 50

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
datalist of objects
hasMorebooleanDefaults to false
nextCursorstring or null
folderslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error