Connections

Connections are integrations with external tools and services. Each connection stores credentials and configuration for a specific external system (databases, SaaS platforms, cloud providers, etc.).

Service: firetiger.connections.v1.ConnectionsService

Resource name pattern: connections/{connection_id}

Access: Read-only

Resource type: Connection

Connections are configured through the Firetiger UI. The API provides read-only access to list and inspect your configured connections.

Example flow

List your connections to see what is available, then fetch a specific one to inspect its full configuration.

1. List connections

curl -X POST "https://api.ft-scaletowin.firetigerapi.com/firetiger.connections.v1.ConnectionsService/ListConnections" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "connections": [
    {
      "name": "connections/prod-postgres",
      "displayName": "Production Postgres",
      "connectionType": "CONNECTION_TYPE_POSTGRES"
    },
    {
      "name": "connections/staging-http",
      "displayName": "Staging API",
      "connectionType": "CONNECTION_TYPE_HTTP"
    }
  ]
}

2. Get a specific connection

Use the resource name from the list response to fetch full details, including resolved credentials and tool configurations.

curl -X POST "https://api.ft-scaletowin.firetigerapi.com/firetiger.connections.v1.ConnectionsService/GetConnection" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name": "connections/prod-postgres"}'

{
  "connection": {
    "name": "connections/prod-postgres",
    "displayName": "Production Postgres",
    "description": "Primary production database",
    "connectionType": "CONNECTION_TYPE_POSTGRES",
    "connectionDetails": {
      "postgres": {
        "host": "db.example.com",
        "port": 5432,
        "database": "production",
        "username": "readonly",
        "password": "resolved-secret",
        "sslMode": "require"
      }
    },
    "toolConfigurations": [
      {
        "tool": "TOOL_POSTGRES_QUERY",
        "enabled": true
      }
    ]
  }
}

Methods

Method	Description
GetConnection	Retrieve a connection by name
ListConnections	List connections with filtering and pagination
ListConnectionTypes	List all supported connection types

---

GetConnection

Retrieve a connection by name. Returns full connection details including credentials fetched from the secrets provider.

POST /firetiger.connections.v1.ConnectionsService/GetConnection

Request body

Field	Type	Required	Description
name	string	Yes	Resource name of the connection (e.g. connections/prod-postgres)
override	ConnectionDetailsOverride	No	Override to apply before resolution (e.g. restrict GitHub token scope)

Example

curl -X POST "https://api.ft-scaletowin.firetigerapi.com/firetiger.connections.v1.ConnectionsService/GetConnection" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name": "connections/prod-postgres"}'

---

ListConnections

List connections with optional filtering and pagination. Connection details are not populated in list responses.

POST /firetiger.connections.v1.ConnectionsService/ListConnections

Request body

Field	Type	Required	Description
filter	string	No	Filter expression (e.g. connection_type="postgres")
order_by	string	No	Field to sort by
page_size	integer	No	Maximum results per page
page_token	string	No	Token for the next page of results
show_deleted	boolean	No	Include soft-deleted connections

Example

curl -X POST "https://api.ft-scaletowin.firetigerapi.com/firetiger.connections.v1.ConnectionsService/ListConnections" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"filter": "connection_type=\"postgres\"", "page_size": 25}'

---

ListConnectionTypes

List all supported connection types with their metadata and available tools. Returns only user-creatable types.

POST /firetiger.connections.v1.ConnectionsService/ListConnectionTypes

Request body

Field	Type	Required	Description
filter	string	No	Filter expression
order_by	string	No	Sort order
page_size	integer	No	Maximum results per page
page_token	string	No	Token for the next page of results

Example

curl -X POST "https://api.ft-scaletowin.firetigerapi.com/firetiger.connections.v1.ConnectionsService/ListConnectionTypes" \
  -u "$USERNAME:$PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "types": [
    {
      "type": "CONNECTION_TYPE_POSTGRES",
      "displayName": "PostgreSQL",
      "description": "Query PostgreSQL databases",
      "availableTools": ["TOOL_POSTGRES_QUERY"]
    }
  ]
}