{"openapi":"3.1.0","info":{"title":"Pentest-Tools.com (BYOK) API","version":"0.1.0","description":"Pentest-Tools.com (BYOK) lets an AI assistant read your own Pentest-Tools.com data through the Pentest-Tools.com API with a key you supply (Pentest-Tools.com API key (needs a plan with API access)). Read-only: 10 tools (list_workspaces, get_workspace, list_targets, get_target, list_scans, get_scan, list_findings, get_finding, list_scan_tests, list_reports). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pentest-tools.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pentest-tools/docs"},"termsOfService":"https://connectorbay.com/byok-pentest-tools/terms"},"servers":[{"url":"https://byok-pentest-tools.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pentest-tools/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/list_workspaces":{"post":{"operationId":"list_workspaces","summary":"List workspaces (projects that group targets and scans) with name, description, scan count and target count. Use for \"Wh","description":"List workspaces (projects that group targets and scans) with name, description, scan count and target count. Use for \"Which Pentest-Tools workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_workspacesArguments","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_workspace":{"post":{"operationId":"get_workspace","summary":"Get one workspace: name, description, scan count and target count. Use for \"How many scans does Pentest-Tools workspace ","description":"Get one workspace: name, description, scan count and target count. Use for \"How many scans does Pentest-Tools workspace 7 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from list_workspaces).","title":"Workspace Id","type":"integer"}},"required":["workspace_id"],"title":"get_workspaceArguments","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_targets":{"post":{"operationId":"list_targets","summary":"List scan targets (hostnames, IP addresses or URLs), optionally of one workspace or type. Use for \"Which targets are in ","description":"List scan targets (hostnames, IP addresses or URLs), optionally of one workspace or type. Use for \"Which targets are in my Pentest-Tools workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this workspace id (see list_workspaces); the active workspace of the key is used when omitted.","title":"Workspace Id"},"type":{"anyOf":[{"enum":["hostname","ip_address","url"],"type":"string"},{"type":"null"}],"default":null,"description":"Only targets of this type.","title":"Type"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_targetsArguments","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_target":{"post":{"operationId":"get_target","summary":"Get one target by id: name, type, description and workspace. Use for \"What is Pentest-Tools target 3\".","description":"Get one target by id: name, type, description and workspace. Use for \"What is Pentest-Tools target 3\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"target_id":{"description":"Target id (from list_targets).","title":"Target Id","type":"integer"}},"required":["target_id"],"title":"get_targetArguments","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_scans":{"post":{"operationId":"list_scans","summary":"List scans with tool, target, status, progress, result counts by risk level, start and end time. Filter by workspace, ta","description":"List scans with tool, target, status, progress, result counts by risk level, start and end time. Filter by workspace, target, tool or status. Use for \"Which Pentest-Tools scans failed or are still running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this workspace id (see list_workspaces); the active workspace of the key is used when omitted.","title":"Workspace Id"},"target_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only scans of this target id.","title":"Target Id"},"tool_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only scans made with this tool id.","title":"Tool Id"},"status":{"anyOf":[{"enum":["running","finished","failed to start","stopped","timed out","waiting","aborted","VPN connection error","auth failed","connection error"],"type":"string"},{"type":"null"}],"default":null,"description":"Only scans with this status.","title":"Status"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_scansArguments","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_scan":{"post":{"operationId":"get_scan","summary":"Get one scan: status, progress, result counts by risk level, times and status message. Findings are read with list_findi","description":"Get one scan: status, progress, result counts by risk level, times and status message. Findings are read with list_findings. Use for \"Did Pentest-Tools scan 1 finish and what did it find\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"scan_id":{"description":"Scan id (from list_scans).","title":"Scan Id","type":"integer"}},"required":["scan_id"],"title":"get_scanArguments","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_findings":{"post":{"operationId":"list_findings","summary":"List vulnerability findings with name, risk level (0 informational to 4 critical), status, CVSS and EPSS scores, CVE ids","description":"List vulnerability findings with name, risk level (0 informational to 4 critical), status, CVSS and EPSS scores, CVE ids, CISA catalog flag, port and service. Filter by workspace, target, scan or risk. Use for \"What high risk findings does Pentest-Tools have open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this workspace id (see list_workspaces); the active workspace of the key is used when omitted.","title":"Workspace Id"},"target_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only findings of this target id.","title":"Target Id"},"task_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only findings of this scan id.","title":"Task Id"},"group_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only findings of this finding group id.","title":"Group Id"},"group_duplicates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to show only the latest finding of each duplicate group.","title":"Group Duplicates"},"min_risk_level":{"anyOf":[{"maximum":4,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only findings at or above this risk level (0 informational, 1 low, 2 medium, 3 high, 4 critical).","title":"Min Risk Level"},"max_risk_level":{"anyOf":[{"maximum":4,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only findings at or below this risk level (0 to 4).","title":"Max Risk Level"}},"title":"list_findingsArguments","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_finding":{"post":{"operationId":"get_finding","summary":"Get one finding with description, risk description and recommendation in addition to its scores and location. Use for \"E","description":"Get one finding with description, risk description and recommendation in addition to its scores and location. Use for \"Explain Pentest-Tools finding 11 and how to fix it\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"finding_id":{"description":"Finding id (from list_findings).","title":"Finding Id","type":"integer"}},"required":["finding_id"],"title":"get_findingArguments","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_scan_tests":{"post":{"operationId":"list_scan_tests","summary":"List the tests performed during a scan, including those that found nothing, with id, description and time. Use for \"Whic","description":"List the tests performed during a scan, including those that found nothing, with id, description and time. Use for \"Which checks did Pentest-Tools scan 1 run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"scan_id":{"description":"Scan id (from list_scans).","title":"Scan Id","type":"integer"},"resource_type":{"anyOf":[{"enum":["scan","finding"],"type":"string"},{"type":"null"}],"default":null,"description":"finding to list only tests that produced a finding, scan for the others.","title":"Resource Type"}},"required":["scan_id"],"title":"list_scan_testsArguments","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_reports":{"post":{"operationId":"list_reports","summary":"List generated reports with file name, status, format, generation date and expiration date. Use for \"Which Pentest-Tools","description":"List generated reports with file name, status, format, generation date and expiration date. Use for \"Which Pentest-Tools reports are ready to download\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_reportsArguments","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}}}}