Block documents
Create Block Document
API Reference
- Overview
- Python SDK Overview
- Settings reference
- REST API
- REST API overview
- Cloud API
- Server API
- Server API Overview
- Root
- Flows
- Flow Runs
- Task Runs
- Flow Run States
- Task Run States
- Deployments
- SavedSearches
- Logs
- Concurrency Limits
- Concurrency Limits V2
- Block types
- Block documents
- Work Pools
- Task Workers
- Work Queues
- Artifacts
- Block schemas
- Block capabilities
- Collections
- Variables
- GETCreate Csrf Token
- Events
- Automations
- Admin
- CLI Reference
Block documents
Create Block Document
Create a new block document.
For more information, see https://docs.prefect.io/v3/develop/blocks.
POST
/
api
/
block_documents
{
"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
Body
application/json
Data used by the Prefect REST API to create a block document.
Response
201
application/json
Successful Response
An ORM representation of a block document.
Was this page helpful?
{
"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
}