Probely

Probely Developers

Probely is a Web Vulnerability Scanning suite for Agile Teams. It provides continuous scanning of your Web Applications and lets you efficiently manage the…

Developer tools#openapi#monitoring

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Probely is a Web Vulnerability Scanning suite for Agile Teams. It provides
continuous scanning of your Web Applications and lets you efficiently
manage the lifecycle of the vulnerabilities found, in a sleek and
intuitive ~~web interface~~ API.

Quick-Start

Authentication

To use the API, you first need to create a token (API Key).
To create a token, select a target from the drop-down list, go to the
"Settings" page, and click on the "Integrations" tab.

Write a name for the API Key. For example, if you want to use the API Key
for travis,
you could name it "travis". In this example, we chose "example.com_key"

"
,
"stack":
"(...)"
,
"verified":true,
"(...)": "(...)"
}
]
}


Now we can send a request to start a scan on target id **AxtkqTE0v3E-**

curl https://api.probely.com/targets/AxtkqTE0v3E-/scan_now/ \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: JWT PROBELY_AUTH_TOKEN"


And we get a response saying that the scan is scheduled: the status is **queued**, and we've got a **scan id**:

{
"changed":"2017-08-01T13:37:00.843339Z",
"started":null,
"completed":null,
"mediums":0,
"changed_by":
"(...)"
,
"highs":0,
"status":"queued",
"id":"S6dOMPn0SnoH",
"created_by":
"(...)"
,
"target":
"(...)"
,
"created":"2017-08-01T13:37:00.843339Z",
"lows":0
}


Using the scan id **S6dOMPn0SnoH**, we can pool the scan status:

curl https://api.probely.com/targets/AxtkqTE0v3E-/scans/S6dOMPn0SnoH/ \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: JWT PROBELY_AUTH_TOKEN"


And we get a response saying that the scan status is now **started**:

{
"id":"S6dOMPn0SnoH",
"changed":"2017-08-01T13:38:12.623650Z",
"started":null,
"completed":null,
"mediums":0,
"changed_by":
"(...)"
,
"highs":0,
"status":"started",
"created_by":
"(...)"
,
"target":
"(...)"
,
"created":"2017-08-01T13:37:00.843339Z",
"lows":0
}


The possible statuses are:

| Status | Name | Description |
| ------ | ---- | ----------- |
| queued | Queued | The scan is queued to start |
| started | Started | The scan is currently running |
| under_review | Under Review | The scan is complete but has some findings under review |
| completed | Completed | The scan is complete |
| completed_with_errors | Completed with errors | The scan is complete even after getting some error(s) |
| failed | Failed | The scan failed |
| canceled | Canceled | The scan was canceled |
| canceling | Canceling | The scan is being canceled |

During the scan, the keys "lows", "mediums", and "highs" will be updated
with the findings, as they are being found.

After we get either the status **completed** or **completed_with_errors**,
we can view the findings.

### Get vulnerabilities

Using the previous scan id **S6dOMPn0SnoH**, we can get the scan results:

curl https://api.probely.com/targets/AxtkqTE0v3E-/scans/S6dOMPn0SnoH/ \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: JWT PROBELY_AUTH_TOKEN"


We get a response saying that the scan status is now **completed**, and
that **45** vulnerabilities were found. **14** low, **11** medium and
**20** high:

{
"id":"S6dOMPn0SnoH",
"target":
"(...)"
,
"status":"completed",
"started":"2017-08-01T13:37:12.623650Z",
"completed":"2017-08-01T14:17:48.559514Z",
"lows":14,
"mediums":11,
"highs":20,
"created":"2017-08-01T13:37:00.843339Z",
"created_by":
"(...)"
,
"changed":"2017-08-01T14:17:48.559514Z",
"changed_by":
"(...)"
}


You can now view the results of this scan, or the target findings.

Let's start with the scan results:

curl https://api.probely.com/targets/AxtkqTE0v3E-/findings/?scan=S6dOMPn0SnoH&page=1 \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: JWT PROBELY_AUTH_TOKEN"

{
"count":45,
"page_total":5,
"page":1,
"length":10,
"results":[
{
"id":79,
"target":
"(...)"
,
"scans":
"(...)"
,
"labels":
"(...)"
,
"fix":"To fix an SQL Injection in PHP, you should use Prepared Statements. Prepared Statements can be thought of as a kind of compiled template for the SQL that an application wants to run, that can be customized using variable parameters.\n\nPHP's PDO extension supports Prepared Statements, so that's probably your best option.\n\nIn the example below you can see the use of prepared statements. Variables $username and $hashedPassword come from user input.\n\n`\n$stmt = $dbg->prepare(\"SELECT id, name FROM users\n WHERE username=? AND password=?\");\n$stmt->bindParam(1, $username);\n$stmt->bindParam(2, $hashedPassword);\nif ($stmt->execute()) {\n\t$user =…

Endpoints 147

Login

  • POSTAuthenticate user/auth/obtain/The received token should be used for authenticated requests by including in the Authorization header as Authorization: JWT <token>.
  • POSTReplace token with a new one/auth/refresh/
  • POSTRevoke a token/auth/revoke/
  • POSTVerify a token/auth/verify/Check for the validity of a user token.
  • POSTEnterprise user authentication/enterprise/auth/obtain/The received token should be used for authenticated requests by including in the Authorization header as Authorization: JWT <token>.
  • POSTEnterprise token refresh/enterprise/auth/refresh/
  • POSTEnterprise token revokation/enterprise/auth/revoke/
  • POSTEnterprise token verification/enterprise/auth/verify/Check for the validity of a user token.

Targets

  • GETList targets/targets/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate target/targets/
  • GETRetrieve target/targets/:id/
  • PUTUpdate target/targets/:id/
  • DELETEDelete target/targets/:id/
  • PATCHPartial update target/targets/:id/

Site

  • GETRetrieve target's site/targets/:target_id/site/Deprecated.
  • PUTUpdate target's site/targets/:target_id/site/Deprecated. Note that the URL can only be set once.
  • PATCHPartial update target's site/targets/:target_id/site/Deprecated. Note that the URL can only be set once.
  • POSTVerify site ownership/targets/:target_id/site/verify/Deprecated.

Assets

  • GETList target's assets/targets/:target_id/assets/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate new asset/targets/:target_id/assets/
  • GETRetrieve asset/targets/:target_id/assets/:id/
  • PUTUpdate asset/targets/:target_id/assets/:id/
  • DELETEDelete asset/targets/:target_id/assets/:id/
  • PATCHPartial update assets/targets/:target_id/assets/:id/
  • POSTVerify asset ownership/targets/:target_id/assets/:id/verify/

Scans

  • GETList scans for all targets/targets/all/scans/?page=1&length=10&ordering=-changed&search=string&started=2024-01-01&status=queued
  • POSTStart a scan on the target/targets/:target_id/scan_now/
  • GETList scans/targets/:target_id/scans/?page=1&length=10&ordering=-changed&search=string&started=2024-01-01&status=queued
  • GETDates where scans have ocurred/targets/:target_id/scans/dates/
  • GETScan page/targets/:target_id/scans/retrieve_page/?length=10&date=2024-01-01Given a date return the page number
  • GETRetrieve scan/targets/:target_id/scans/:id/
  • POSTCancel running scan/targets/:target_id/scans/:id/cancel/
  • GETScan endpoints file/targets/:target_id/scans/:id/endpoints/
  • GETScan report PDF, using the report type specified for the target/targets/:target_id/scans/:id/report/
  • GETScan report PDF, using the default report type/targets/:target_id/scans/:id/report/default/
  • GETScan report PDF, using the OWASP report type/targets/:target_id/scans/:id/report/owasp/
  • GETScan report PDF, using the PCI report type/targets/:target_id/scans/:id/report/pci/

Scheduled

  • GETList scheduled scans for all targets expanding recurrence/targets/all/scheduledscans/expanded/?length=10
  • GETList scheduled scans/targets/:target_id/scheduledscans/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate new scheduled scan/targets/:target_id/scheduledscans/
  • GETList scheduled scans expanding recurrence/targets/:target_id/scheduledscans/expanded/?length=10
  • GETRetrieve a scheduled scan/targets/:target_id/scheduledscans/:id/
  • PUTUpdate a scheduled scan/targets/:target_id/scheduledscans/:id/
  • DELETEDelete/targets/:target_id/scheduledscans/:id/
  • PATCHPartial update/targets/:target_id/scheduledscans/:id/

Findings

  • GETList target findings/targets/:target_id/findings/?scan=string&severity=10&state=notfixed&assignee=string&label=string&page=1&length=10&ordering=-changed&search=string
  • POSTFinding report/targets/:target_id/findings/bulk/report/
  • POSTBulk retest findings/targets/:target_id/findings/bulk/retest/
  • PATCHBulk update findings/targets/:target_id/findings/bulk/update/
  • GETRetrieve finding report PDF format/targets/:target_id/findings/report/?token=string
  • GETRetrieve finding/targets/:target_id/findings/:id/
  • PUTUpdate finding/targets/:target_id/findings/:id/
  • PATCHPartial update finding/targets/:target_id/findings/:id/
  • GETFinding activity log./targets/:target_id/findings/:id/log/Finding activity log.
  • POSTRetest finding/targets/:target_id/findings/:id/retest/

Frameworks

  • GETList frameworks/frameworks/?page=1&length=10&ordering=-changed&search=string
  • GETRetrieve framework/frameworks/:id/

Labels

  • GETList labels/labels/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate label/labels/
  • GETRetrieve framework/labels/:id/
  • PUTUpdate label/labels/:id/
  • DELETEDelete label/labels/:id/
  • PATCHPartial update/labels/:id/

Vulnerabilities

  • GETList vulnerability definitions/vulnerability_definitions/?page=1&length=10&ordering=-changed&search=string
  • GETRetrieve vulnerability definition/vulnerability_definitions/:id/

API Keys

  • GETList API keys allowed to operate on account/keys/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate account API key/keys/
  • GETRetrieve account API key/keys/:id/
  • DELETEDelete account API key/keys/:id/
  • GETList target specific API keys/targets/:target_id/keys/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate target API key/targets/:target_id/keys/
  • GETRetrieve target API key/targets/:target_id/keys/:id/
  • DELETEDelete target API key/targets/:target_id/keys/:id/

Password Reset

  • POSTCheck validity of password reset token/check/
  • POSTSend reset password email/reset/
  • POSTReset password after asking for a reset (with the token sent by email). /setpassword/

Users

  • GETUser data/profile/?page=1&length=10&ordering=-changed&search=string
  • POSTChange user password/profile/change_password/Our password policy requires a minimum password length of 10 chars with at least one symbol or number.
  • GETList users/users/?page=1&length=10&ordering=-changed&search=string
  • POSTCreate/Reactivate a user./users/
  • GETRetrieve user/users/:id/
  • PUTUpdate user/users/:id/
  • DELETEDeactivate a user/users/:id/
  • PATCHPartial update user/users/:id/

Account

  • GETRetrieve account information/account/
  • GETRetrieve billing information/billing/
  • PUTUpdate billing information/billing/
  • PATCHPartial update billing information/billing/
  • POSTAction that should be taken to enable the selected targets/billing/actions/
  • POSTEstimate costs of updating a subscription/billing/estimate/
  • POSTUpdate a subscription/billing/subscribe/
  • POSTAvailable actions for the selected targets/target-actions/

Statistics

  • GETAverage fix time graph data (all targets)/targets/all/average_fix_time/
  • GETTargets with open vulnerabilities pie chart data/targets/all/needs_attention_pie/
  • GETTargets with open vulnerabilities/targets/all/needs_attention_top/
  • GETRisk trend graph data (all targets)/targets/all/risk_trend/
  • GETSeverity trend graph data (all targets)/targets/all/severity_trend/
  • GETTop 5 vulnerabilities (all targets)./targets/all/top_vulns/
  • GETAverage vulnerability trend graph data/targets/:target_id/average_fix_time/
  • GETRisk trend graph data/targets/:target_id/risk_trend/
  • GETSeverity trend graph data./targets/:target_id/severity_trend/
  • GETTop 5 vulnerabilities/targets/:target_id/top_vulns/

Archive

  • POSTActivate targets/targets/activate/
  • POSTArchive targets/targets/archive/
  • POSTList archived targets/targets/archived/

Events

  • GETList account events/events/
  • GETRetrieve account event/events/:id/
  • GETList target events/targets/:target_id/events/
  • GETRetrieve target event/targets/:target_id/events/:id/
  • GETList target webhooks/targets/:target_id/webhooks/
  • POSTCreate new target webhook/targets/:target_id/webhooks/
  • GETRetrieve target webhook/targets/:target_id/webhooks/:id/
  • PUTUpdate target webhook/targets/:target_id/webhooks/:id/
  • DELETEDelete target webhook/targets/:target_id/webhooks/:id/
  • PATCHPartial update target webhook/targets/:target_id/webhooks/:id/
  • GETList account webhooks/webhooks/
  • POSTCreate new account webhook/webhooks/
  • GETRetrieve account webhook/webhooks/:id/
  • PUTUpdate account webhook/webhooks/:id/
  • DELETEDelete account webhook/webhooks/:id/
  • PATCHPartial update account webhook/webhooks/:id/

Integrations

  • GETIntegrations available and installed in the account/integrations/
  • GETIntegrations available and installed for the target/targets/:target_id/integrations/

Slack Integration

  • GETRetrieve slack integration data/targets/:target_id/integrations/slack/
  • PUTUpdate slack integration data/targets/:target_id/integrations/slack/
  • PATCHUpdate slack integration data/targets/:target_id/integrations/slack/

Jira Cloud Integration

  • GETList Jira Projects/integrations/jira-cloud/projects/
  • GETRetrieve project issue types/integrations/jira-cloud/projects/:project_id/issue_types/
  • GETRetrieve issue priorities/integrations/jira-cloud/projects/:project_id/issue_types/:issue_type_id/priorities/
  • GETRetrieve issue statuses/integrations/jira-cloud/projects/:project_id/issue_types/:issue_type_id/status/
  • GETRetrieve Jira Cloud finding configuration/targets/:target_id/findings/:id/integrations/jira-cloud/
  • PUTUpdate Jira Cloud finding configuration/targets/:target_id/findings/:id/integrations/jira-cloud/
  • PATCHUpdate Jira Cloud finding configuration/targets/:target_id/findings/:id/integrations/jira-cloud/
  • GETRetrieve Jira Cloud Target configuration/targets/:target_id/integrations/jira-cloud/
  • PUTUpdate Jira Cloud target configuration/targets/:target_id/integrations/jira-cloud/
  • PATCHUpdate Jira Cloud target configuration/targets/:target_id/integrations/jira-cloud/

Jira Server Integration

  • GETList Jira Projects/integrations/jira-server/projects/
  • GETRetrieve project issue types/integrations/jira-server/projects/:project_id/issue_types/
  • GETRetrieve issue priorities/integrations/jira-server/projects/:project_id/issue_types/:issue_type_id/priorities/
  • GETRetrieve issue statuses/integrations/jira-server/projects/:project_id/issue_types/:issue_type_id/status/
  • GETRetrieve Jira Server finding configuration/targets/:target_id/findings/:id/integrations/jira-server/
  • PUTUpdate Jira Server finding configuration/targets/:target_id/findings/:id/integrations/jira-server/
  • PATCHUpdate Jira Server finding configuration/targets/:target_id/findings/:id/integrations/jira-server/
  • GETRetrieve Jira Server Target configuration/targets/:target_id/integrations/jira-server/
  • PUTUpdate Jira Server target configuration/targets/:target_id/integrations/jira-server/
  • PATCHUpdate Jira Server target configuration/targets/:target_id/integrations/jira-server/

Plan

  • GETSubscription plans/plans/

API details

Base URL
https://api.probely.com
Authentication
A bearer token in the Authorization header
Operations
147 operations on 99 pathsGET 72POST 35PATCH 16PUT 15DELETE 9
4 marked deprecated
Main resources
Events 16Scans 12Findings 10Jira Cloud Integration 10Jira Server Integration 10Statistics 10API Keys 8Account 8Login 8Scheduled 8
Description format
OpenAPI 3.0.0, API version 1.2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Probely Developers in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Probely Developers collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Authenticate user” (POST /auth/obtain/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Probely Developers?

Probely is a Web Vulnerability Scanning suite for Agile Teams. It provides continuous scanning of your Web Applications and lets you efficiently manage the… It is listed under Developer tools and has 147 endpoints.

Who publishes the Probely Developers?

It is listed from Probely's public API description (an OpenAPI document), not published by Probely on Swastik Codes. Anyone who controls probely.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Probely Developers?

Requests go to https://api.probely.com. Endpoint paths are added to this base URL.

How do I authenticate with the Probely Developers?

With A bearer token in the Authorization header.

How many endpoints does the Probely Developers have?

147 operations on 99 paths (72 GET, 35 POST, 16 PATCH, 15 PUT, 9 DELETE). The largest groups are Events, Scans, Findings, Jira Cloud Integration.

Is forking the Probely Developers free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.