{"openapi":"3.1.0","info":{"title":"SecurityTrails (BYOK) API","version":"0.1.0","description":"SecurityTrails (BYOK) lets an AI assistant read your own SecurityTrails data through the SecurityTrails API with a key you supply (SecurityTrails API key). Read-only: 9 tools (get_domain, list_subdomains, get_whois, get_whois_history, get_dns_history, find_associated_domains, list_domain_certificates, get_nearby_ips, get_usage). The BYOK key travels with each request, is used for that one call...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-securitytrails.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-securitytrails/docs"},"termsOfService":"https://connectorbay.com/byok-securitytrails/terms"},"servers":[{"url":"https://byok-securitytrails.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-securitytrails/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_domain":{"post":{"operationId":"get_domain","summary":"Get the current DNS records (A, AAAA, MX, NS, SOA, TXT) of a domain and its Alexa rank. Use for \"What are the current DN","description":"Get the current DNS records (A, AAAA, MX, NS, SOA, TXT) of a domain and its Alexa rank. Use for \"What are the current DNS records of example.com on SecurityTrails\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"}},"required":["hostname"],"title":"get_domainArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_subdomains":{"post":{"operationId":"list_subdomains","summary":"List the known subdomain labels of a domain (for example 'www', 'mail'); append the domain to get the full name. Use for","description":"List the known subdomain labels of a domain (for example 'www', 'mail'); append the domain to get the full name. Use for \"What subdomains does example.com have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"}},"required":["hostname"],"title":"list_subdomainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whois":{"post":{"operationId":"get_whois","summary":"Get the current WHOIS data of a domain: registrar, status, created, updated and expiry dates, name servers and contacts.","description":"Get the current WHOIS data of a domain: registrar, status, created, updated and expiry dates, name servers and contacts. Use for \"Who is the registrar of example.com and when does it expire\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"}},"required":["hostname"],"title":"get_whoisArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whois_history":{"post":{"operationId":"get_whois_history","summary":"Get the historical WHOIS records of a domain (registrar, dates, name servers, status, contacts), paged. Use for \"How has","description":"Get the historical WHOIS records of a domain (registrar, dates, name servers, status, contacts), paged. Use for \"How has the WHOIS data of example.com changed over time\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["hostname"],"title":"get_whois_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_dns_history":{"post":{"operationId":"get_dns_history","summary":"Get the history of one DNS record type of a domain with first and last seen dates, paged. For A and AAAA the values are ","description":"Get the history of one DNS record type of a domain with first and last seen dates, paged. For A and AAAA the values are IP addresses. Use for \"Which IP addresses has example.com pointed to in the past\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"},"type":{"description":"DNS record type: a, aaaa, mx, ns, soa or txt.","enum":["a","aaaa","mx","ns","soa","txt"],"title":"Type","type":"string"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["hostname","type"],"title":"get_dns_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/find_associated_domains":{"post":{"operationId":"find_associated_domains","summary":"Find domains associated with a domain, with registrar, creation and expiry dates, providers and Alexa rank, paged. May n","description":"Find domains associated with a domain, with registrar, creation and expiry dates, providers and Alexa rank, paged. May need a higher plan. Use for \"Which domains are associated with google.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["hostname"],"title":"find_associated_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_domain_certificates":{"post":{"operationId":"list_domain_certificates","summary":"List TLS certificates seen for a domain: names, SHA-1 and SHA-256 fingerprints, issuer, validity timestamps and serial. ","description":"List TLS certificates seen for a domain: names, SHA-1 and SHA-256 fingerprints, issuer, validity timestamps and serial. May need a higher plan. Use for \"Which TLS certificates were seen for example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"Domain name to look up, for example 'example.com'.","maxLength":253,"title":"Hostname","type":"string"},"include_subdomains":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include certificates of subdomains (default false).","title":"Include Subdomains"},"status":{"anyOf":[{"enum":["valid","expired","all"],"type":"string"},{"type":"null"}],"default":"valid","description":"Which certificates: valid (default), expired or all.","title":"Status"}},"required":["hostname"],"title":"list_domain_certificatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_nearby_ips":{"post":{"operationId":"get_nearby_ips","summary":"List the IP blocks around an IP address (neighbouring addresses), with the count per block. Use for \"Which IP addresses ","description":"List the IP blocks around an IP address (neighbouring addresses), with the count per block. Use for \"Which IP addresses are next to 8.8.8.8\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ipaddress":{"description":"IP address, optionally with a CIDR mask, for example '8.8.8.8'.","maxLength":50,"title":"Ipaddress","type":"string"}},"required":["ipaddress"],"title":"get_nearby_ipsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_usage":{"post":{"operationId":"get_usage","summary":"Show the API usage of the key this month and the monthly allowance. Use for \"How much of my SecurityTrails monthly quota","description":"Show the API usage of the key this month and the monthly allowance. Use for \"How much of my SecurityTrails monthly quota have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}