Skip to main content
Use the Integrations Service to connect agents and backend tasks to external systems like GitHub, Jira, and cloud providers. Integrations are managed centrally by your organization, so you can discover what’s available, read the connection details, and where permitted, fetch credentials securely at execution time. This keeps authentication out of code while making it easy to call external APIs.

​
Quick Example

from kubiya.control_plane_client import ControlPlaneClient
import os

client = ControlPlaneClient(
    api_key=os.environ.get("KUBIYA_CONTROL_PLANE_API_KEY"),
    base_url=os.environ.get("KUBIYA_CONTROL_PLANE_BASE_URL", "https://control-plane.kubiya.ai")
)

# List connected integrations
integrations = client.integrations.list(connected_only=True)
print("Integrations:", integrations)

# Get details for a specific integration
if integrations:
    integration_id = integrations[0].get("id") or integrations[0].get("uuid")
    details = client.integrations.get(integration_id)
    print("Details:", details)

# Fetch credentials (example: special vendors like github_app/jira use ID "0")
creds = client.integrations.get_integration_credentials(vendor="github_app", id="0")
print("Credentials:", creds)

​
Core Operations

​
List Integrations

List organization integrations. Optionally only those already connected. 
# All integrations
all_integrations = client.integrations.list()

# Only connected integrations
connected = client.integrations.list(connected_only=True)
  • connected_only (optional): True to return only connected integrations

​
Get Integration Details

Fetch details for a specific integration by ID. 
info = client.integrations.get("integration-id")
print(info)
  • integration_id (required): Integration identifier (UUID/ID)

​
Get Integration Credentials

Retrieve credentials for a vendor/id pair. 
# For special vendors (e.g., "jira", "github_app"), id is automatically treated as "0"
creds = client.integrations.get_integration_credentials(vendor="github_app", id="0")
print(creds)
  • vendor (required): Integration vendor (e.g., “aws”, “github_app”, “jira”)
  • id (required): Integration ID; for special vendors like jira and github_app use “0”

​
Notes

  • Credentials access is governed by organization policy and your API key permissions.
  • Prefer storing only references in code; fetch credentials at execution time.