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",
  "name": "<string>",
  "data": {},
  "block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "block_schema": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "checksum": "<string>",
    "fields": {},
    "block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": true
  },
  "block_document_references": {},
  "is_anonymous": false
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
slug
string
required

The block type name

​
block_document_name
string
required

The block type name

Query Parameters

​
include_secrets
boolean
default:
false

Whether to include sensitive values in the block document.

Response

200
application/json
Successful Response

An ORM representation of a block document.

​
id
string
required
​
created
string | null
required
​
updated
string | null
required
​
block_schema_id
string
required

A block schema ID

​
block_type_id
string
required

A block type ID

​
name
string | null

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

​
data
object

The block document's data

​
block_schema
object | null

The associated block schema

​
block_type_name
string | null

The associated block type's name

​
block_type
object | null

The associated block type

​
block_document_references
object

Record of the block document's references

​
is_anonymous
boolean
default:
false

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

Was this page helpful?

Read Block Documents For Block TypeInstall System Block Types