- Technical Details
GET /public/api/accounts/{accountId}
- Get the properties of the account identified by accountId
GET /public/api/accounts/{accountId}/projects
- Get the list of projects running in the account identified by accountId
POST /public/api/auth/access-token
- Submit a security key you can obtain from UI and generate an access token for the public API.
GET /public/api/projects
- Get the list of all projects from any accounts where the user profile you use to access the public API have enough privileges to access them.
GET /public/api/projects/{projectId}/execution-status
- Get the execution status of the last scan of the specified project (Pending, Executing, Completed, Failed, Aborted)
GET /public/api/projects/{projectId}
- Get details of the specified project
GET /public/api/projects/{projectId}/business-units
- A business unit is a group of domains, created by a user. Here we can get the list of business units of the specified project.
POST /public/api/projects/{projectId}/business-units
- This endpoint allows you to create business units
GET /public/api/projects/{projectId}/domains
- Get the list of domains from the specified project
POST /public/api/projects/{projectId}/domains
- This endpoint is very useful to assign domains to existing business units
GET /public/api/projects/{projectId}/custom-asset-info-list
- Get the custom properties set by users assigned to applications (security program onboarding, business criticality, update frequency, manual complexity).
POST /public/api/projects/{projectId}/custom-asset-info-list
- Assign custom properties to applications
GET /public/api/projects/{projectId}/scan-workqueue
- Get the list of items from the workqueue. Te workqueue is the place where the user enter some domains, urls, ips or ip ranges as starting point for the scanner. Some items can be ceated automatically by the scanner during deep discovery.
POST /public/api/projects/{projectId}/scan-workqueue
- Add some items to the workque using the public API.
GET /public/api/projects/{projectId}/tests
- Get the list of tests already completed from the specified project.
GET /public/api/projects/{projectId}/test-comparisons
- Get the list of test comparisons. A comparison is a delta dataset showing changes between 2 test results.
GET /public/api/projects/{projectId}/jobs
- Anytime a task is running on a project, we call it a job. Here we can see all the jobs already executed for the specified project and status as well.
POST /public/api/projects/{projectId}/launch-scan
- Start a scan on the specified project.
GET /public/api/projects/{projectId}/jobs/params
- Get the list of technical parameters of the project. Those parameters drive the way the scan will behave.
POST /public/api/projects/{projectId}/jobs/params
- Use this endpoint to change values of some parameters.
POST /public/api/projects/{projectId}/jobs/{jobId}/hooks
- Use this endpoint to tell the public API about an url to call when a job is changing status. In that case, the public API will post the status to the specified url.
POST /public/api/projects/{projectId}/data/test-things
- API endpoint that allows to retrieve test result data. Explanations can be found in another document
Public API swagger is available here:
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article