curl --location --request PUT 'http://localhost:6789/api/pipelines/broken_wave/blocks/solitary_silence' \
--header 'Cookie: oauth_token=long_token_string' \
--header 'Content-Type: text/plain' \
--header 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
--data '{
"block" : {
"color" : "teal"
}
} '
{
"block" : {
"all_upstream_blocks_executed" : true ,
"color" : "teal" ,
"configuration" : { } ,
"downstream_blocks" : [ ] ,
"executor_config" : null ,
"executor_type" : "local_python" ,
"has_callback" : false ,
"name" : "solitary silence" ,
"language" : "python" ,
"retry_config" : null ,
"status" : "not_executed" ,
"type" : "data_loader" ,
"upstream_blocks" : [ ] ,
"uuid" : "solitary_silence" ,
"content" : "some_long_content_string"
}
}
PUT /api/pipelines/:pipeline_uuid/blocks/:block_uuid
Human readable block name. This is used to generate the UUID, e.g. restless dust
. Names will be slugified to a safe-uuid.
Type of block:
callback
, chart
, conditional
, custom
, data_exporter
, data_loader
, dbt
, extension
, global_data_product
, markdown
, scratchpad
, sensor
, transformer
Data integration bookmark values as a list of strings.
Array of callback block objects. Same shape as blocks
.
Block color displayed by the frontend for custom
blocks. All other block types have predefined colors.
Miscellaneous configuration settings for the block.
Database or data warehouse for the SQL block to connect to.
Database name to use when saving the output of the SQL block.
Profile target for the dbt block.
Schema name to use when saving the output of the SQL block.
Table name to use when saving the output of the SQL block.
Whether to replace
the existing table of the SQL block output, append
, or
raise an error and fail
.
Toggle writing raw SQL in the block. Read more here .
The content of block formatted as a string. Use /n
for newlines. Omitting will create an empty block.
The destination table for a data integration pipeline.
Array of blocks downstream from the created block.
Used when configuring a Kubernetes executor. See the Kubernetes config page for more details
Used when configuring a Kubernetes executor. See the Kubernetes config page for more details
The block language:
python
, sql
, r
, yaml
, markdown
Array of strings containing the pipeline uuids for which the block is a member.
The configuration for block retry logic. See the pipeline runs docs for retry config examples.
The block tap stream ID for data integration pipelines.
An array of strings representing the uuids of upstream blocks (the blocks on which the new block depends). For example, ["a", "b"]
will create a block that depends on blocks a
and b
.
The unique id of the block. This is generated from name
, so it’s not necessary to populate this field.
curl --location --request PUT 'http://localhost:6789/api/pipelines/broken_wave/blocks/solitary_silence' \
--header 'Cookie: oauth_token=long_token_string' \
--header 'Content-Type: text/plain' \
--header 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
--data '{
"block" : {
"color" : "teal"
}
} '
{
"block" : {
"all_upstream_blocks_executed" : true ,
"color" : "teal" ,
"configuration" : { } ,
"downstream_blocks" : [ ] ,
"executor_config" : null ,
"executor_type" : "local_python" ,
"has_callback" : false ,
"name" : "solitary silence" ,
"language" : "python" ,
"retry_config" : null ,
"status" : "not_executed" ,
"type" : "data_loader" ,
"upstream_blocks" : [ ] ,
"uuid" : "solitary_silence" ,
"content" : "some_long_content_string"
}
}