Skip to main content
Read a retained value chunk

Authorizations

Authorization
string
header
required

Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.

Headers

x-fd-read-scope-version
string

Send all three selected-read headers together. The response echoes the confirmed selection.

Allowed value: "2026-10-16-read-scope.1"
x-fd-read-project-id
string

Your selected project. A resource outside the selected context returns 409.

x-fd-read-environment-id
string

Your selected environment. These headers never grant authority.

Path Parameters

runId
string
required
Required string length: 1 - 160

Query Parameters

source
enum<string>
required
Available options:
output,
input,
scenario,
configuration,
target,
assessment,
event,
check_actual,
check_expected
pointer
string

RFC 6901 pointer into the selected retained value.

eventId
string
checkId
string
offset
integer
Required range: x >= 0
limit
integer
default:8192
Required range: 256 <= x <= 32768
sha256
string

Required for continuation offsets; use the digest from the first chunk.

Pattern: ^[a-f0-9]{64}$

Response

The retained resource or operation response.

schemaVersion
string
required
Allowed value: "2026-10-15-retained-value.1"
resource
object
required
encoding
string
required
Allowed value: "utf-8"
serialization
string
required
Allowed value: "json"
offset
number
required
returnedBytes
number
required
text
string
required
nextOffset
null | number
required
complete
boolean
required
source
enum<string>
required
Available options:
output,
input,
target,
scenario,
configuration,
recipe,
assessment,
event,
check_actual,
check_expected
pointer
string
required
valueType
enum<string>
required
Available options:
string,
number,
boolean,
object,
null,
array
totalBytes
number
required
sha256
string
required
readPath
string
required
eventId
string
checkId
string