canonical: https://jentic.com/apis/probely.com/probely # Probely's API Reference Documentation The Probely API provides programmatic access to a web application security scanning platform with 331 endpoints covering target management, vulnerability scanning, finding triage, reporting, and integration configuration. It supports scheduling automated DAST scans against web applications and APIs, reviewing discovered vulnerabilities by severity, assigning remediation tasks, and generating compliance reports across multiple targets and teams. ## For AI agents Run web application security scans, manage vulnerability findings, configure scan targets, and generate security compliance reports across web applications and APIs. ## Scope Does not handle network infrastructure scanning, endpoint detection, or SIEM log analysis - use for web application DAST scanning and vulnerability management only. ## Capabilities - Schedule and trigger dynamic application security testing scans against web targets and APIs - Triage vulnerability findings by severity, assign remediation owners, and track fix status - Configure scan targets with authentication credentials, custom headers, and crawling rules - Generate downloadable PDF security reports filtered by target, severity, or compliance framework - Manage scanning agent deployments for targets behind firewalls or in private networks - Integrate scan results with issue trackers and CI/CD pipelines via webhooks and API user roles - Monitor account credit usage and subscription entitlements for scanning capacity planning ## Use cases ### CI/CD Security Gate Integrate Probely scans into deployment pipelines to block releases containing high-severity vulnerabilities. The API allows agents to create scan targets from deployment URLs, trigger scans on each build, poll for completion, and check whether new critical or high-severity findings were introduced. This enables shift-left security without manual intervention, with scan results feeding back into pull request checks. Example prompt: Trigger a scan on target ID 12345 using POST to `/targets/{target_id}/scans`/, poll `/scans/{scan_id}`/ until status is completed, then retrieve findings filtered to severity high or critical ### Vulnerability Remediation Tracking Track the lifecycle of discovered vulnerabilities from detection through remediation. The API provides finding status management, assignee configuration, and re-scan verification. Security teams can use agents to automatically assign new findings to developers based on the affected target, monitor fix timelines, and trigger verification scans once patches are deployed. Example prompt: List all findings with status 'notfixed' for a target, filter to those older than 30 days, and retrieve the assignee and affected URL for each finding ### Multi-Target Security Posture Dashboard Aggregate scan results across all targets to build an organization-wide security posture view. The API supports listing all targets with their last scan status, querying findings across targets by severity, and pulling account-level statistics. Agents can compile this into executive dashboards showing vulnerability trends, mean time to remediation, and compliance status. Example prompt: Retrieve all targets from /targets/, for each target get the latest scan result count by severity, and compile a summary table of total critical, high, medium, and low findings across the organization ### AI Agent Security Scanning Automation Enable AI agents to manage web application security scanning end-to-end through Jentic. Agents can discover available Probely operations by intent, configure targets, launch scans, and retrieve results without hardcoding API paths. This is useful for security chatbots, automated compliance checks, and agent-driven vulnerability management workflows. Example prompt: Search Jentic for 'run a web application security scan', load the operation schema for creating a scan, and execute it against a specified target URL ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/targets/` | Create a new scan target | | GET | `/targets/` | List all configured scan targets | | POST | `/targets/{target_id}/scans/` | Trigger a new security scan on a target | | GET | `/targets/{target_id}/findings/` | List vulnerability findings for a target | | GET | `/scans/{scan_id}/` | Get scan status and results | | GET | `/report/` | Generate a security report | | GET | `/account/credits/usage/` | Check scanning credit consumption | | POST | `/integrations/` | Configure third-party integrations | ## Key resources - **Targets** — Web application and API scan targets with authentication, scope, and scheduling configuration - **Scans** — Security scan executions with status tracking, scheduling, and result retrieval - **Findings** — Discovered vulnerabilities with severity, status, assignee, and remediation details - **Reports** — Generated security reports in PDF format with filtering by target and severity - **Account** — Billing, credits, subscription, and entitlement management - **Integrations** — Third-party service connections for issue tracking and notification delivery ## Why Jentic - **Setup:** Wiring Probely by hand means formatting its JWT with the required 'JWT ' prefix on the Authorization header, targeting api.probely.com, and mapping targets, scans, and findings across many endpoints yourself. Through Jentic you install once, import Probely from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** Probely puts the target id in the URL path (`/targets/{target_id}/scans`/, `/targets/{target_id}/findings`/), so a rule can pin your agent to one target: it can start scans and read findings for that target and nothing else. You choose the operations it may call, so target creation is not included unless you add it. - **Credential handling:** Your Probely JWT is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'scan a web application for vulnerabilities' or 'retrieve scan findings', and Jentic returns the matching Probely operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Snyk API** — Static analysis and dependency vulnerability scanning for source code and containers - **Detectify API** — External attack surface monitoring and DAST scanning with crowdsourced vulnerability signatures - **SonarCloud API** — Code quality and security analysis for source code repositories ## FAQ ### What authentication does the Probely API use? The Probely API uses JWT token authentication passed in the Authorization header with a 'JWT' prefix. You obtain a token by authenticating with your account credentials. Through Jentic, JWT tokens are managed in the credential vault and refreshed automatically - agents never handle raw tokens directly. ### Can I trigger automated security scans with the Probely API? Yes. POST to `/targets/{target_id}/scans`/ launches a new DAST scan against a configured target. You can also schedule recurring scans via the target configuration. The scan runs asynchronously and you can poll its status until completion, then retrieve all discovered findings. ### What are the rate limits for the Probely API? Probely applies per-account rate limits based on your subscription tier. The API returns 429 status codes when limits are exceeded, with a Retry-After header indicating when to retry. Enterprise plans have higher limits suitable for CI/CD pipeline integration with frequent scan triggers. ### How do I retrieve vulnerability findings for a target through Jentic? Search Jentic for 'list security vulnerabilities for a target', load the operation schema for GET `/targets/{target_id}/findings`/, then execute with your target ID. Results include severity, status, affected URL, and remediation guidance. Install with pip install jentic and authenticate through Jentic One, the self-hosted execution layer. ### Can I integrate Probely scan results into my CI/CD pipeline? Yes. Use the API to trigger scans on deployment targets, poll for completion via GET `/scans/{scan_id}`/, then check findings filtered by severity. If critical or high findings exist, your pipeline can fail the deployment. The /integrations/ endpoints also support webhook notifications on scan completion. ### Does the Probely API support scanning behind firewalls? Yes. The /scanning-agents/ endpoints allow you to deploy and manage scanning agents within private networks. These agents handle scan execution for targets that are not publicly accessible, reporting results back to the Probely platform via the API. ### Can I limit what my agent is allowed to do with the Probely API? Yes. Because you run Jentic One yourself, your own rules decide which Probely operations and credentials the agent may use. Since Probely puts the target id in the URL path, such as `/targets/{target_id}/scans`/ and `/targets/{target_id}/findings`/, you can pin the agent to a single target so it only starts scans and reads findings for that target and nothing else. You choose the exact operations it can call, so actions like creating new targets stay off unless you explicitly add them.