POST
/
api
/
block_schemas
/
filter
[
  {
    "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"
  }
]

Headers

​
x-prefect-api-version
string

Body

application/json
​
block_schemas
object | null

Filter BlockSchemas

​
offset
integer
default:
0
Required range: x > 0
​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

200
application/json
Successful Response
​
id
string
required
​
created
string | null
required
​
updated
string | null
required
​
checksum
string
required

The block schema's unique checksum

​
block_type_id
string | null
required

A block type ID

​
fields
object

The block schema's field schema

​
block_type
object | null

The associated block type

​
capabilities
string[]

A list of Block capabilities

​
version
string
default:
non-versioned

Human readable identifier for the block schema

Was this page helpful?

Delete Block SchemaRead Block Schema By Checksum