Cybersecurity

Securitytrails

Learn how to use Securitytrails with Composio

Overview

SLUG: SECURITYTRAILS

Description

SecurityTrails provides comprehensive domain and IP intelligence data, including historical DNS records, WHOIS data, and more, to enhance cybersecurity efforts.

Authentication Details

generic_api_key
stringRequired

Connecting to Securitytrails

Create an auth config

Use the dashboard to create an auth config for the Securitytrails toolkit. This allows you to connect multiple Securitytrails accounts to Composio for agents to use.

1

Select App

Navigate to Securitytrails.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Securitytrails Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4securitytrails_auth_config_id = "ac_YOUR_SECURITYTRAILS_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Securitytrails for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, securitytrails_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Securitytrails toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["SECURITYTRAILS"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Bulk Static Asset Rules

Description

Tool to bulk add or remove static asset rules for a project. Use when performing batch updates (up to 1000 rules total) asynchronously; verify changes via the Get Static Assets endpoint.

Action Parameters

add
array
project_id
stringRequired
remove
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Company Associated IPs

Description

Tool to retrieve IPs associated with a company domain. Use when you need to find all IP addresses linked to an organization's domain name.

Action Parameters

domain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Domain

Description

Tool to retrieve current data about a given domain, including DNS record statistics. Use when you need to fetch detailed domain insights after determining the target hostname.

Action Parameters

hostname
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Domain SSL

Description

Tool to fetch current and historical SSL certificate details for a hostname. Use when you need to retrieve SSL data after identifying the domain.

Action Parameters

hostname
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP Search Statistics

Description

Tool to fetch summary statistics for an IP DSL query. Use when you need metrics for IP search queries.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List ASI Projects

Description

Tool to list ASI projects available to the account. Use when you need project IDs for subsequent ASI operations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Ping

Description

Tool to test authentication and connectivity with the SecurityTrails API. Use after configuring API key.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Scroll Results

Description

Tool to continue scrolling through DSL search results. Use after receiving a scroll_id from a prior search to fetch the next batch of data.

Action Parameters

scroll_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search IPs

Description

Tool to search IP addresses via SecurityTrails DSL. Use when you need to filter IPs with custom DSL queries.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: SQL API Execute Query

Description

Tool to execute SQL queries across Hosts and IPs. Use when you need to retrieve data via SecurityTrails SQL API.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: SQL API Scroll Results

Description

Tool to fetch next page of SQL query results. Use after obtaining scroll_id from initial SQL API response.

Action Parameters

scroll_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Temp Scrape Securitytrails Usage

Description

Temporary action for scraping Securitytrails usage from documentation.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired