v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Block types

Read Block Types

Gets all block types. Optionally limit return with limit and offset.

post/api/block_types/filter

Headers

x-prefect-api-versionstring

Request body

offsetinteger

limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Example request

{
  "block_types": {
    "name": {
      "like_": "marvin"
    }
  },
  "block_schemas": {
    "block_capabilities": {
      "all_": [
        "write-storage",
        "read-storage"
      ]
    },
    "version": {
      "any_": [
        "2.0.0",
        "2.1.0"
      ]
    }
  }
}

Response

Successful Response

idstring uuid

createdstring date-time

updatedstring date-time

namestring required

A block type's name

slugstring required

A block type's slug

logo_urlstring uri

Web URL for the block type's logo

documentation_urlstring uri

Web URL for the block type's documentation

descriptionstring

A short blurb about the corresponding block's intended use

code_examplestring

A code snippet demonstrating use of the corresponding block

is_protectedboolean

Protected block types cannot be modified via API.