Skip to main content

prefect block

Manage blocks.

prefect block type

Inspect and delete block types.

prefect block type ls

List all block types.

Options

Specify an output format. Currently supports: json

prefect block type inspect

Display details about a block type.

Arguments

string
required
A block type slug

Options

Specify an output format. Currently supports: json

prefect block type delete

Delete an unprotected Block Type.

Arguments

string
required
A Block type slug

prefect block types

Inspect and delete block types.

prefect block types ls

List all block types.

Options

Specify an output format. Currently supports: json

prefect block types inspect

Display details about a block type.

Arguments

string
required
A block type slug

Options

Specify an output format. Currently supports: json

prefect block types delete

Delete an unprotected Block Type.

Arguments

string
required
A Block type slug

prefect block register

Register blocks types within a module or file.This makes the blocks available for configuration via the UI. If a block type has already been registered, its registration will be updated to match the block’s current definition.

Options

Python module containing block types to be registered
Path to .py file containing block types to be registered
Example:

prefect block ls

View all configured blocks.

Options

Specify an output format. Currently supports: json

prefect block delete

Delete a configured block.

Arguments

string
A block slug. Formatted as ‘<BLOCK_TYPE_SLUG>/<BLOCK_NAME>’

Options

A block id.

prefect block create

Generate a link to the Prefect UI to create a block.

Arguments

string
required
A block type slug. View available types with: prefect block type ls

prefect block inspect

Displays details about a configured block.

Arguments

string
A Block slug: <BLOCK_TYPE_SLUG>/<BLOCK_NAME>

Options

A Block id to search for if no slug is given
Specify an output format. Currently supports: json