Read Block Document By Name For Block Type

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "data": {},
  "block_schema": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "checksum": "<string>",
    "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": {},
    "block_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "slug": "<string>",
      "logo_url": "<string>",
      "documentation_url": "<string>",
      "description": "<string>",
      "code_example": "<string>",
      "is_protected": false
    },
    "capabilities": [
      "<string>"
    ],
    "version": "non-versioned"
  },
  "block_type_name": "<string>",
  "block_type": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "logo_url": "<string>",
    "documentation_url": "<string>",
    "description": "<string>",
    "code_example": "<string>",
    "is_protected": false
  },
  "block_document_references": {},
  "is_anonymous": false
}

GET

api

block_types

slug

{slug}

block_documents

name

{block_document_name}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "data": {},
  "block_schema": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "checksum": "<string>",
    "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": {},
    "block_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "slug": "<string>",
      "logo_url": "<string>",
      "documentation_url": "<string>",
      "description": "<string>",
      "code_example": "<string>",
      "is_protected": false
    },
    "capabilities": [
      "<string>"
    ],
    "version": "non-versioned"
  },
  "block_type_name": "<string>",
  "block_type": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "logo_url": "<string>",
    "documentation_url": "<string>",
    "description": "<string>",
    "code_example": "<string>",
    "is_protected": false
  },
  "block_document_references": {},
  "is_anonymous": false
}

Headers

x-prefect-api-version

string

Path Parameters

slug

string

required

The block type name The block type name

block_document_name

string

required

The block type name The block type name

Query Parameters

include_secrets

boolean

default:false

Whether to include sensitive values in the block document. Whether to include sensitive values in the block document.

Response

Successful Response

An ORM representation of a block document.

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

block_schema_id

string<uuid>

required

A block schema ID

block_type_id

string<uuid>

required

A block type ID

name

string | null

The block document's name. Not required for anonymous block documents.

data

Data · object

The block document's data

block_schema

BlockSchema · object

The associated block schema

Show child attributes

block_schema.id

string<uuid>

required

block_schema.created

string<date-time> | null

required

block_schema.updated

string<date-time> | null

required

block_schema.checksum

string

required

The block schema's unique checksum

block_schema.block_type_id

string<uuid> | null

required

A block type ID

block_schema.fields

Fields · object

The block schema's field schema

block_schema.block_type

BlockType · object

The associated block type

Show child attributes

block_schema.block_type.id

string<uuid>

required

block_schema.block_type.created

string<date-time> | null

required

block_schema.block_type.updated

string<date-time> | null

required

block_schema.block_type.name

string

required

A block type's name

block_schema.block_type.slug

string

required

A block type's slug

block_schema.block_type.logo_url

string | null

Web URL for the block type's logo

block_schema.block_type.documentation_url

string | null

Web URL for the block type's documentation

block_schema.block_type.description

string | null

A short blurb about the corresponding block's intended use

block_schema.block_type.code_example

string | null

A code snippet demonstrating use of the corresponding block

block_schema.block_type.is_protected

boolean

default:false

Protected block types cannot be modified via API.

block_schema.capabilities

string[]

A list of Block capabilities

block_schema.version

string

default:non-versioned

Human readable identifier for the block schema

block_type_name

string | null

The associated block type's name

block_type

BlockType · object

The associated block type

Show child attributes

block_type.id

string<uuid>

required

block_type.created

string<date-time> | null

required

block_type.updated

string<date-time> | null

required

block_type.name

string

required

A block type's name

block_type.slug

string

required

A block type's slug

block_type.logo_url

string | null

Web URL for the block type's logo

block_type.documentation_url

string | null

Web URL for the block type's documentation

block_type.description

string | null

A short blurb about the corresponding block's intended use

block_type.code_example

string | null

A code snippet demonstrating use of the corresponding block

block_type.is_protected

boolean

default:false

Protected block types cannot be modified via API.

block_document_references

Block Document References · object

Record of the block document's references

Show child attributes

block_document_references.{key}

object

is_anonymous

boolean

default:false

Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)

Read Block Documents For Block Type Install System Block Types

⌘I

API Reference

Headers

Path Parameters

Query Parameters

Response