curl --request POST \
--url https://api.example.com/connections/{connection_id}/execute/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mode": "python",
"code": "<string>",
"query": "<string>",
"query_language": "sql",
"configuration": {},
"discovery_metadata": {},
"parameters": {},
"secret_names": [
"<string>"
],
"limit": 25,
"timeout_seconds": 60
}
'import requests
url = "https://api.example.com/connections/{connection_id}/execute/"
payload = {
"mode": "python",
"code": "<string>",
"query": "<string>",
"query_language": "sql",
"configuration": {},
"discovery_metadata": {},
"parameters": {},
"secret_names": ["<string>"],
"limit": 25,
"timeout_seconds": 60
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: 'python',
code: '<string>',
query: '<string>',
query_language: 'sql',
configuration: {},
discovery_metadata: {},
parameters: {},
secret_names: ['<string>'],
limit: 25,
timeout_seconds: 60
})
};
fetch('https://api.example.com/connections/{connection_id}/execute/', 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/connections/{connection_id}/execute/",
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([
'mode' => 'python',
'code' => '<string>',
'query' => '<string>',
'query_language' => 'sql',
'configuration' => [
],
'discovery_metadata' => [
],
'parameters' => [
],
'secret_names' => [
'<string>'
],
'limit' => 25,
'timeout_seconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/connections/{connection_id}/execute/"
payload := strings.NewReader("{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/connections/{connection_id}/execute/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/connections/{connection_id}/execute/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"execution_id": "<string>",
"status": "succeeded",
"connection": {
"name": "<string>",
"source": "salesforce",
"configuration": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"credential_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credential_secret_name": "<string>",
"discovery_metadata": {},
"status": "active",
"credential_secret_type": "<string>",
"last_discovered_at": "2023-11-07T05:31:56Z",
"last_sync_at": "2023-11-07T05:31:56Z",
"last_error": "<string>"
},
"outputs": {},
"metadata": {},
"stdout_tail": "",
"stderr_tail": "",
"error": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Run a bounded generated-code probe against an external data connection.
curl --request POST \
--url https://api.example.com/connections/{connection_id}/execute/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mode": "python",
"code": "<string>",
"query": "<string>",
"query_language": "sql",
"configuration": {},
"discovery_metadata": {},
"parameters": {},
"secret_names": [
"<string>"
],
"limit": 25,
"timeout_seconds": 60
}
'import requests
url = "https://api.example.com/connections/{connection_id}/execute/"
payload = {
"mode": "python",
"code": "<string>",
"query": "<string>",
"query_language": "sql",
"configuration": {},
"discovery_metadata": {},
"parameters": {},
"secret_names": ["<string>"],
"limit": 25,
"timeout_seconds": 60
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: 'python',
code: '<string>',
query: '<string>',
query_language: 'sql',
configuration: {},
discovery_metadata: {},
parameters: {},
secret_names: ['<string>'],
limit: 25,
timeout_seconds: 60
})
};
fetch('https://api.example.com/connections/{connection_id}/execute/', 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/connections/{connection_id}/execute/",
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([
'mode' => 'python',
'code' => '<string>',
'query' => '<string>',
'query_language' => 'sql',
'configuration' => [
],
'discovery_metadata' => [
],
'parameters' => [
],
'secret_names' => [
'<string>'
],
'limit' => 25,
'timeout_seconds' => 60
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/connections/{connection_id}/execute/"
payload := strings.NewReader("{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/connections/{connection_id}/execute/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/connections/{connection_id}/execute/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"python\",\n \"code\": \"<string>\",\n \"query\": \"<string>\",\n \"query_language\": \"sql\",\n \"configuration\": {},\n \"discovery_metadata\": {},\n \"parameters\": {},\n \"secret_names\": [\n \"<string>\"\n ],\n \"limit\": 25,\n \"timeout_seconds\": 60\n}"
response = http.request(request)
puts response.read_body{
"execution_id": "<string>",
"status": "succeeded",
"connection": {
"name": "<string>",
"source": "salesforce",
"configuration": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"credential_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credential_secret_name": "<string>",
"discovery_metadata": {},
"status": "active",
"credential_secret_type": "<string>",
"last_discovered_at": "2023-11-07T05:31:56Z",
"last_sync_at": "2023-11-07T05:31:56Z",
"last_error": "<string>"
},
"outputs": {},
"metadata": {},
"stdout_tail": "",
"stderr_tail": "",
"error": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
Use python for arbitrary source probes. Use query when generated Python should execute the provided read-only SQL/SOQL query via ctx.query.
python, query Generated Python code for the executor. Define run(ctx) or run(). The result should be a pandas DataFrame, list of records, or dict of named DataFrames/records/scalars. RUNTIME_* globals contain raw Secret Manager strings; generated code should parse them according to secret metadata, for example json.loads(RUNTIME_ATTIO_API_TOKEN)['token'] for token secrets.
1sql, soql Optional non-secret runtime configuration for standalone generated-code execution. Connection-bound execution uses the saved connection configuration.
Optional non-secret metadata available to standalone generated code as ctx.discovery_metadata.
Optional secret names to resolve through the backend and expose to generated code as RUNTIME_<SECRET_NAME> globals. The globals contain raw Secret Manager payload strings that code must parse according to each secret_type.
20Maximum sample rows returned to the agent per output table.
1 <= x <= 5001 <= x <= 120Response
Successful Response
succeeded, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes