Read Block Schemas

curl --request POST \
  --url https://api.example.com/api/block_schemas/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "block_schemas": {
    "operator": "and_",
    "block_type_id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "block_capabilities": {
      "all_": [
        "write-storage",
        "read-storage"
      ]
    },
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "version": {
      "any_": [
        "2.0.0",
        "2.1.0"
      ]
    }
  },
  "offset": 0,
  "limit": 123
}
'

[
  {
    "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"
  }
]

POST

api

block_schemas

filter

Read Block Schemas

curl --request POST \
  --url https://api.example.com/api/block_schemas/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "block_schemas": {
    "operator": "and_",
    "block_type_id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "block_capabilities": {
      "all_": [
        "write-storage",
        "read-storage"
      ]
    },
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "version": {
      "any_": [
        "2.0.0",
        "2.1.0"
      ]
    }
  },
  "offset": 0,
  "limit": 123
}
'

[
  {
    "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"
  }
]

Headers

x-prefect-api-version

string

Body

application/json

block_schemas

BlockSchemaFilter · object

Filter BlockSchemas

Show child attributes

block_schemas.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

block_schemas.block_type_id

BlockSchemaFilterBlockTypeId · object

Filter criteria for BlockSchema.block_type_id

Show child attributes

block_schemas.block_type_id.any_

string<uuid>[] | null

A list of block type ids to include

block_schemas.block_capabilities

BlockSchemaFilterCapabilities · object

Filter criteria for BlockSchema.capabilities

Show child attributes

block_schemas.block_capabilities.all_

string[] | null

A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.

Example:

["write-storage", "read-storage"]

block_schemas.id

BlockSchemaFilterId · object

Filter criteria for BlockSchema.id

Show child attributes

block_schemas.id.any_

string<uuid>[] | null

A list of IDs to include

block_schemas.version

BlockSchemaFilterVersion · object

Filter criteria for BlockSchema.version

Show child attributes

block_schemas.version.any_

string[] | null

A list of block schema versions.

Example:

["2.0.0", "2.1.0"]

offset

integer

default:0

Required range: x >= 0

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

checksum

string

required

The block schema's unique checksum

block_type_id

string<uuid> | null

required

A block type ID

fields

Fields · object

The block schema's field schema

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.

capabilities

string[]

A list of Block capabilities

version

string

default:non-versioned

Human readable identifier for the block schema

Delete Block Schema Read Block Schema By Checksum

⌘I

API Reference

Headers

Body

Response