Read Variables
curl --request POST \
--url https://api.example.com/variables/filter \
--header 'Content-Type: application/json' \
--data '
{
"offset": 0,
"variables": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"<string>"
],
"like_": "my_variable_%"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"sort": "NAME_ASC",
"limit": 123
}
'import requests
url = "https://api.example.com/variables/filter"
payload = {
"offset": 0,
"variables": {
"operator": "and_",
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"name": {
"any_": ["<string>"],
"like_": "my_variable_%"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"is_null_": True
}
},
"sort": "NAME_ASC",
"limit": 123
}
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({
offset: 0,
variables: {
operator: 'and_',
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
name: {any_: ['<string>'], like_: 'my_variable_%'},
tags: {operator: 'and_', all_: ['tag-1', 'tag-2'], is_null_: true}
},
sort: 'NAME_ASC',
limit: 123
})
};
fetch('https://api.example.com/variables/filter', 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/variables/filter",
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([
'offset' => 0,
'variables' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'<string>'
],
'like_' => 'my_variable_%'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
]
],
'sort' => 'NAME_ASC',
'limit' => 123
]),
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/variables/filter"
payload := strings.NewReader("{\n \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\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/variables/filter")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/variables/filter")
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 \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\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",
"name": "<string>",
"value": "my-value",
"tags": [
"<string>"
]
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Variables
Read Variables
POST
/
variables
/
filter
Read Variables
curl --request POST \
--url https://api.example.com/variables/filter \
--header 'Content-Type: application/json' \
--data '
{
"offset": 0,
"variables": {
"operator": "and_",
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"name": {
"any_": [
"<string>"
],
"like_": "my_variable_%"
},
"tags": {
"operator": "and_",
"all_": [
"tag-1",
"tag-2"
],
"is_null_": true
}
},
"sort": "NAME_ASC",
"limit": 123
}
'import requests
url = "https://api.example.com/variables/filter"
payload = {
"offset": 0,
"variables": {
"operator": "and_",
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"name": {
"any_": ["<string>"],
"like_": "my_variable_%"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"is_null_": True
}
},
"sort": "NAME_ASC",
"limit": 123
}
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({
offset: 0,
variables: {
operator: 'and_',
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
name: {any_: ['<string>'], like_: 'my_variable_%'},
tags: {operator: 'and_', all_: ['tag-1', 'tag-2'], is_null_: true}
},
sort: 'NAME_ASC',
limit: 123
})
};
fetch('https://api.example.com/variables/filter', 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/variables/filter",
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([
'offset' => 0,
'variables' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'<string>'
],
'like_' => 'my_variable_%'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
]
],
'sort' => 'NAME_ASC',
'limit' => 123
]),
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/variables/filter"
payload := strings.NewReader("{\n \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\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/variables/filter")
.header("Content-Type", "application/json")
.body("{\n \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/variables/filter")
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 \"offset\": 0,\n \"variables\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"like_\": \"my_variable_%\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\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",
"name": "<string>",
"value": "my-value",
"tags": [
"<string>"
]
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Required range:
x >= 0Filter variables. Only variables matching all criteria will be returned
Show child attributes
Show child attributes
Defines variables sorting options.
Available options:
CREATED_DESC, UPDATED_DESC, NAME_DESC, NAME_ASC Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
Successful Response
The name of the variable
Maximum string length:
255Example:
"my-variable"
The value of the variable
Example:
"my-value"
A list of variable tags
Example:
["tag-1", "tag-2"]
Was this page helpful?
⌘I