Skip to main content
POST
Read 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.

Body

application/json
websiteId
string
required
Minimum string length: 1
names
string[]
required

File names to read (up to 50). Singleton files are addressed by their type name, for example global_css.

Required array length: 1 - 50 elements
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
startLine
integer

First line to return (1-based, inclusive). Only valid when reading a single file.

Required range: x <= 9007199254740991
endLine
integer

Last line to return (1-based, inclusive). Only valid when reading a single file.

Required range: x <= 9007199254740991
startCharacter
integer

First character to return from the selected line range (1-based, inclusive). Only valid when reading a single file.

Required range: x <= 9007199254740991
endCharacter
integer

Last character to return from the selected line range (1-based, inclusive). Only valid when reading a single file.

Required range: x <= 9007199254740991

Response

The requested files with their contents.

websiteId
string
required

Id of the website.

version
integer
required

Source version that was read. Pass it as version when continuing truncated content.

files
object[]
required

The requested files in request order.