Create Block Schema
curl --request POST \
--url https://api.example.com/block_schemas/ \
--header 'Content-Type: application/json' \
--data '
{
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"capabilities": [
"<string>"
],
"version": "non-versioned"
}
'import requests
url = "https://api.example.com/block_schemas/"
payload = {
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"capabilities": ["<string>"],
"version": "non-versioned"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
block_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fields: {},
capabilities: ['<string>'],
version: 'non-versioned'
})
};
fetch('https://api.example.com/block_schemas/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/block_schemas/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'block_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fields' => [
],
'capabilities' => [
'<string>'
],
'version' => 'non-versioned'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/block_schemas/"
payload := strings.NewReader("{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/block_schemas/")
.header("Content-Type", "application/json")
.body("{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_schemas/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Block schemas
Create Block Schema
Create a block schema.
For more information, see https://docs.prefect.io/v3/concepts/blocks.
POST
/
block_schemas
/
Create Block Schema
curl --request POST \
--url https://api.example.com/block_schemas/ \
--header 'Content-Type: application/json' \
--data '
{
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"capabilities": [
"<string>"
],
"version": "non-versioned"
}
'import requests
url = "https://api.example.com/block_schemas/"
payload = {
"block_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fields": {},
"capabilities": ["<string>"],
"version": "non-versioned"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
block_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fields: {},
capabilities: ['<string>'],
version: 'non-versioned'
})
};
fetch('https://api.example.com/block_schemas/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/block_schemas/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'block_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fields' => [
],
'capabilities' => [
'<string>'
],
'version' => 'non-versioned'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/block_schemas/"
payload := strings.NewReader("{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/block_schemas/")
.header("Content-Type", "application/json")
.body("{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_schemas/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"block_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fields\": {},\n \"capabilities\": [\n \"<string>\"\n ],\n \"version\": \"non-versioned\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Response
Successful Response
An ORM representation of a block schema.
The block schema's unique checksum
A block type ID
The block schema's field schema
The associated block type
Show child attributes
Show child attributes
A list of Block capabilities
Human readable identifier for the block schema
Was this page helpful?
⌘I