Connection

Field	Type	Behavior	Description
`name`	string	OUTPUT_ONLY	Resource name (`connections/{id}`)
`connection_type`	ConnectionType	REQUIRED	Type of external system (e.g. `CONNECTION_TYPE_POSTGRES`, `CONNECTION_TYPE_SLACK`)
`display_name`	string	REQUIRED	Human-readable name for the connection
`description`	string	REQUIRED	Description of what this connection provides
`create_time`	timestamp	OUTPUT_ONLY	When the connection was created
`update_time`	timestamp	OUTPUT_ONLY	When the connection was last modified
`delete_time`	timestamp	OUTPUT_ONLY	When the connection was soft-deleted (null if active)
`secret_id`	string		ID of the secret storing full connection details
`connection_details`	ConnectionDetails	REQUIRED	Connection-specific configuration
`tool_configurations`	ToolConfiguration[]		Which tools are enabled for this connection
`read_only`	boolean	OUTPUT_ONLY	Whether the connection is system-managed and cannot be edited
`shell_environment`	ShellEnvironment	OUTPUT_ONLY	Shell prompt information (populated on Get only)
`connection_status`	Status	OUTPUT_ONLY	Operational status of credential resolution (nil or OK means healthy)

Example

{
  "name": "connections/prod-iceberg",
  "connectionType": "CONNECTION_TYPE_ICEBERG",
  "displayName": "Production Iceberg",
  "description": "Iceberg connection for production data lake",
  "createTime": "2026-02-07T08:28:56.588670Z",
  "updateTime": "2026-02-07T08:28:56.588670Z",
  "secretId": "conn_778f2937dc19466086069ee42d234b0a"
}

Connection Type

Value	Description
`CONNECTION_TYPE_POSTGRES`	PostgreSQL database
`CONNECTION_TYPE_HTTP`	Generic HTTP API
`CONNECTION_TYPE_GOOGLE_POSTMASTER`	Google Postmaster Tools
`CONNECTION_TYPE_PYLON`	Pylon customer support platform
`CONNECTION_TYPE_GITHUB`	GitHub App installation
`CONNECTION_TYPE_SLACK`	Slack workspace
`CONNECTION_TYPE_PROMQL`	PromQL-compatible Prometheus API
`CONNECTION_TYPE_LINEAR`	Linear project management
`CONNECTION_TYPE_AWS`	AWS (IAM role assumption or static credentials)
`CONNECTION_TYPE_GCP`	GCP (service account authentication)
`CONNECTION_TYPE_CLICKHOUSE`	ClickHouse database
`CONNECTION_TYPE_MYSQL`	MySQL database
`CONNECTION_TYPE_ICEBERG`	Apache Iceberg REST catalog
`CONNECTION_TYPE_DATADOG`	Datadog observability platform
`CONNECTION_TYPE_INCIDENT_IO`	incident.io webhook integration

Tool

Each connection type supports a set of tools that agents can use. The enabled_tools field on AgentConnection and RunbookConnection references values from this enum.

Value	Description
`TOOL_POSTGRES_QUERY`	Execute a read-only SQL query against PostgreSQL
`TOOL_POSTGRES_WRITE_QUERY`	Execute a read-write SQL query against PostgreSQL
`TOOL_HTTP_REQUEST`	Make an HTTP request
`TOOL_GITHUB_SEARCH_CODE`	Search code in GitHub repositories
`TOOL_GITHUB_GET_FILE`	Get file contents from a GitHub repository
`TOOL_GITHUB_LIST_DIRECTORY`	List files in a GitHub repository directory
`TOOL_GITHUB_GET_PR`	Get a GitHub pull request
`TOOL_GITHUB_GET_ISSUE`	Get a GitHub issue
`TOOL_GITHUB_PULL_REQUEST_SEARCH`	Search GitHub pull requests
`TOOL_GITHUB_CREATE_ISSUE`	Create a GitHub issue
`TOOL_GITHUB_ADD_ISSUE_COMMENT`	Add a comment to a GitHub issue
`TOOL_GITHUB_LIST_ISSUES`	List GitHub issues
`TOOL_GITHUB_CREATE_PR_COMMENT`	Add a comment to a GitHub pull request
`TOOL_GITHUB_LIST_PR_COMMENTS`	List comments on a GitHub pull request
`TOOL_GITHUB_LIST_PR_REVIEWS`	List reviews on a GitHub pull request
`TOOL_GITHUB_LIST_ORGANIZATION_MEMBERS`	List members of a GitHub organization
`TOOL_GITHUB_LIST_REPOS`	List repositories in a GitHub organization
`TOOL_PROMQL_QUERY`	Execute an instant PromQL query
`TOOL_PROMQL_QUERY_RANGE`	Execute a range PromQL query
`TOOL_PROMQL_LABEL_VALUES`	Get label values from Prometheus
`TOOL_PROMQL_SERIES`	Get time series from Prometheus
`TOOL_GOOGLE_POSTMASTER_LIST_DOMAINS`	List domains in Google Postmaster Tools
`TOOL_GOOGLE_POSTMASTER_GET_TRAFFIC_STATS`	Get traffic stats from Google Postmaster Tools
`TOOL_PYLON_LIST_ISSUES`	List issues from Pylon
`TOOL_SLACK_SEND_MESSAGE`	Send a message in Slack
`TOOL_FIRETIGER_QUERY`	Query Firetiger’s data lake
`TOOL_FIRETIGER_CODEBASE_SEARCH`	Search code across configured repositories
`TOOL_LINEAR_LIST_ISSUES`	List issues from Linear
`TOOL_LINEAR_LIST_USERS`	List users from Linear
`TOOL_CLICKHOUSE_QUERY`	Execute a query against ClickHouse
`TOOL_MYSQL_QUERY`	Execute a read-only query against MySQL
`TOOL_ICEBERG_QUERY`	Query an Apache Iceberg table
`TOOL_DATADOG_QUERY_METRICS`	Query metrics from Datadog
`TOOL_DATADOG_QUERY_LOGS`	Query logs from Datadog

Tool Configuration

Controls whether a specific tool is enabled on a connection.

Field	Type	Description
`tool`	Tool	The tool being configured
`is_enabled`	boolean	Whether this tool is enabled

Connection Details

Connection-specific configuration. This is a union type – exactly one variant is set, matching the connection’s connection_type. The fields vary by connection type (e.g. host/port/database for PostgreSQL, base URL and headers for HTTP). Refer to the connection creation UI or ftops api connections for the fields available for each type.

Shell Environment

Shell prompt information for the connection, populated only on Get requests.

Field	Type	Description
`prompt`	string	Shell prompt text for interactive sessions

Status

Operational status of the connection’s credential resolution, following the google.rpc.Status format.

Field	Type	Description
`code`	integer	Status code (0 means OK)
`message`	string	Human-readable error message (empty when healthy)