Create Custom Integration
curl --request POST \
--url https://control-plane.kubiya.ai/api/v1/custom-integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"context_prompt": "Production database - handle with care",
"env_vars": {
"DB_HOST": "postgres.prod.example.com",
"DB_PORT": "5432"
},
"secrets": [
"DB_PASSWORD"
]
},
"description": "Production PostgreSQL database",
"integration_type": "postgres",
"name": "production-database",
"tags": [
"production",
"database"
]
}
'import requests
url = "https://control-plane.kubiya.ai/api/v1/custom-integrations"
payload = {
"config": {
"context_prompt": "Production database - handle with care",
"env_vars": {
"DB_HOST": "postgres.prod.example.com",
"DB_PORT": "5432"
},
"secrets": ["DB_PASSWORD"]
},
"description": "Production PostgreSQL database",
"integration_type": "postgres",
"name": "production-database",
"tags": ["production", "database"]
}
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({
config: {
context_prompt: 'Production database - handle with care',
env_vars: {DB_HOST: 'postgres.prod.example.com', DB_PORT: '5432'},
secrets: ['DB_PASSWORD']
},
description: 'Production PostgreSQL database',
integration_type: 'postgres',
name: 'production-database',
tags: ['production', 'database']
})
};
fetch('https://control-plane.kubiya.ai/api/v1/custom-integrations', 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://control-plane.kubiya.ai/api/v1/custom-integrations",
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([
'config' => [
'context_prompt' => 'Production database - handle with care',
'env_vars' => [
'DB_HOST' => 'postgres.prod.example.com',
'DB_PORT' => '5432'
],
'secrets' => [
'DB_PASSWORD'
]
],
'description' => 'Production PostgreSQL database',
'integration_type' => 'postgres',
'name' => 'production-database',
'tags' => [
'production',
'database'
]
]),
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://control-plane.kubiya.ai/api/v1/custom-integrations"
payload := strings.NewReader("{\n \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\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://control-plane.kubiya.ai/api/v1/custom-integrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://control-plane.kubiya.ai/api/v1/custom-integrations")
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 \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"integration_type": "<string>",
"description": "<string>",
"status": "<string>",
"config": {},
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"created_by": "<string>"
}custom-integrations
Create Custom Integration
Create a new custom integration instance.
Configuration Options:
env_vars: Key-value pairs for environment variablessecrets: List of secret names to resolve from vaultfiles: List of files to create in workspacecontext_prompt: Contextual guidance for AI agentsconnection_test: Optional command to test connectivity
Name Requirements:
- Must be unique within the organization
- Cannot be empty
- Alphanumeric and hyphens recommended
Example Request:
{
"name": "production-postgres",
"integration_type": "postgres",
"description": "Production PostgreSQL database",
"config": {
"env_vars": {
"DB_HOST": "postgres.prod.example.com",
"DB_PORT": "5432",
"DB_NAME": "production"
},
"secrets": ["DB_PASSWORD"],
"files": [
{
"path": "~/.postgresql/client.crt",
"secret_ref": "POSTGRES_CLIENT_CERT",
"mode": "0600"
}
],
"context_prompt": "Production database - use connection pooling"
},
"tags": ["production", "database"]
}
POST
/
api
/
v1
/
custom-integrations
Create Custom Integration
curl --request POST \
--url https://control-plane.kubiya.ai/api/v1/custom-integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"context_prompt": "Production database - handle with care",
"env_vars": {
"DB_HOST": "postgres.prod.example.com",
"DB_PORT": "5432"
},
"secrets": [
"DB_PASSWORD"
]
},
"description": "Production PostgreSQL database",
"integration_type": "postgres",
"name": "production-database",
"tags": [
"production",
"database"
]
}
'import requests
url = "https://control-plane.kubiya.ai/api/v1/custom-integrations"
payload = {
"config": {
"context_prompt": "Production database - handle with care",
"env_vars": {
"DB_HOST": "postgres.prod.example.com",
"DB_PORT": "5432"
},
"secrets": ["DB_PASSWORD"]
},
"description": "Production PostgreSQL database",
"integration_type": "postgres",
"name": "production-database",
"tags": ["production", "database"]
}
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({
config: {
context_prompt: 'Production database - handle with care',
env_vars: {DB_HOST: 'postgres.prod.example.com', DB_PORT: '5432'},
secrets: ['DB_PASSWORD']
},
description: 'Production PostgreSQL database',
integration_type: 'postgres',
name: 'production-database',
tags: ['production', 'database']
})
};
fetch('https://control-plane.kubiya.ai/api/v1/custom-integrations', 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://control-plane.kubiya.ai/api/v1/custom-integrations",
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([
'config' => [
'context_prompt' => 'Production database - handle with care',
'env_vars' => [
'DB_HOST' => 'postgres.prod.example.com',
'DB_PORT' => '5432'
],
'secrets' => [
'DB_PASSWORD'
]
],
'description' => 'Production PostgreSQL database',
'integration_type' => 'postgres',
'name' => 'production-database',
'tags' => [
'production',
'database'
]
]),
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://control-plane.kubiya.ai/api/v1/custom-integrations"
payload := strings.NewReader("{\n \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\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://control-plane.kubiya.ai/api/v1/custom-integrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://control-plane.kubiya.ai/api/v1/custom-integrations")
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 \"config\": {\n \"context_prompt\": \"Production database - handle with care\",\n \"env_vars\": {\n \"DB_HOST\": \"postgres.prod.example.com\",\n \"DB_PORT\": \"5432\"\n },\n \"secrets\": [\n \"DB_PASSWORD\"\n ]\n },\n \"description\": \"Production PostgreSQL database\",\n \"integration_type\": \"postgres\",\n \"name\": \"production-database\",\n \"tags\": [\n \"production\",\n \"database\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"integration_type": "<string>",
"description": "<string>",
"status": "<string>",
"config": {},
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"created_by": "<string>"
}Authorizations
Enter your Kubiya API token (format: Bearer )
Body
application/json
Request to create a custom integration
Integration name
Required string length:
1 - 255Integration type
Required string length:
1 - 100Integration configuration
Show child attributes
Show child attributes
Example:
{ "context_prompt": "Production PostgreSQL database. Use connection pooling.", "env_vars": { "DB_HOST": "postgres.prod.example.com", "DB_NAME": "production", "DB_PORT": "5432" }, "files": [ { "mode": "0600", "path": "~/.postgresql/client.crt", "secret_ref": "POSTGRES_CLIENT_CERT" } ], "secrets": ["DB_PASSWORD", "DB_SSL_CERT"] }
Description
Tags
Response
Integration created successfully
Custom integration response
Was this page helpful?
⌘I