Skip to main content
Read a Tool dataset

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.

Path Parameters

datasetId
string
required
Required string length: 1 - 160

Query Parameters

projectId
string
required
Required string length: 1 - 160
environmentId
string

Authorization context for project-owned definitions. Required for an environment-restricted credential; keep your selected environment explicit.

Required string length: 1 - 160
cursor
integer
Required range: x >= 0
limit
integer
Required range: 1 <= x <= 100
includeRecords
enum<string>
default:false
Available options:
true,
false

Response

The retained resource or operation response.

id
string
required
projectId
string
required
buildId
string
required
version
string
required
records
number
required
createdAt
string
required
recordPage
object
schemaVersion
enum<string>
Available options:
2026-10-15-dataset.1
initialVirtualTimeUs
number
metadata
null | object
validation
null | object
validationStatus
enum<string>
Available options:
not_recorded,
validated