Skip to main content
GET
List source files

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

websiteId
string
required
Minimum string length: 1
target
enum<string>

Version alias to read: head (default) or published.

Available options:
head,
published
version
integer

Explicit source version. Takes precedence over target.

Required range: x <= 9007199254740991
nameGlob
string

Only list files whose name matches this glob. * and ? stop at a / segment boundary; ** crosses them, for example blog/**.

Required string length: 1 - 255
cursor
string

Opaque cursor from the previous page. Continue with the returned resolved version to keep the listing pinned.

limit
integer
default:20

Maximum files to return. Defaults to 20 and cannot exceed 100.

Required range: 1 <= x <= 100

Response

The file listing for the requested source version.

items
object[]
required
nextCursor
string | null
required

Opaque cursor for the next page. Pass it as the cursor parameter on the next request. null when this is the last page.

websiteId
string
required

Id of the website.

version
integer
required

Source version that was listed. Pass it as version when continuing with nextCursor.