Skip to main content
POST
Perform an action on a materialization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentName
string
required

Name of the environment

packageName
string
required

Name of the package

materializationId
string
required

ID of the materialization

Query Parameters

action
enum<string>
required

Action to perform on the materialization

Available options:
stop

Response

Materialization cancelled (action=stop)

A record of one materialization run for a package.

id
string
environmentId
string
packageName
string
status
enum<string>

Phase-aware status of a materialization run.

Available options:
PENDING,
MANIFEST_ROWS_READY,
MANIFEST_FILE_READY,
FAILED,
CANCELLED
manifest
object | null

Build output. Null until status = MANIFEST_FILE_READY.

startedAt
string<date-time> | null
completedAt
string<date-time> | null
error
string | null

Error message if the materialization failed

metadata
object | null

Materialization metadata including build options, source counts, and durations

createdAt
string<date-time>
updatedAt
string<date-time>