Patrowl

Swagger API-REST for Patrowl Engines

This is the API documentation for Patrowl Engines usage.

Identity & security#openapi#security

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

This is the API documentation for Patrowl Engines usage.

Endpoints 14

patrowl-engine

  • GETIndex page/Return index page
  • GETClean all scans/cleanClean all current scans.
  • GETClean scan/clean/:scanIdClean scan identified by id.
  • GETGet findings on finished scans/getfindings/:scanIdGet findings on finished scans.
  • GETEngine info page/infoReturn information on engine.
  • GETLiveness page/livenessReturn liveness page
  • GETReadiness page/readinessReturn liveness page
  • GETConfiguration reloading page/reloadconfigReload the configuration file.
  • POSTStart a new scan/startscanStart a new scan.
  • GETStatus on all scans/statusStatus all current scans.
  • GETStatus of a scan/status/:scanIdStatus of a scan identified by id.
  • GETStop a scan/stop/:scanIdStop a scan identified by id.
  • GETStop all scans/stopscansStop all current scans.
  • GETTest page/testReturn test page

API details

Base URL
http://patrowl.local
http://localhost:5001/engines/nmap
http://localhost:5004/engines/ssllabs
http://localhost:5005/engines/arachni
http://localhost:5006/engines/owl_dns
Authentication
None declared in the description
Operations
14 operations on 14 pathsGET 13POST 1
Main resources
patrowl-engine 14
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Swagger API-REST for Patrowl Engines 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 Swagger API-REST for Patrowl Engines collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Index page” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Swagger API-REST for Patrowl Engines?

This is the API documentation for Patrowl Engines usage. It is listed under Identity & security and has 14 endpoints.

Who publishes the Swagger API-REST for Patrowl Engines?

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

What is the base URL of the Swagger API-REST for Patrowl Engines?

Its description lists 5 base URLs: http://patrowl.local, http://localhost:5001/engines/nmap, http://localhost:5004/engines/ssllabs, http://localhost:5005/engines/arachni, http://localhost:5006/engines/owl_dns. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Swagger API-REST for Patrowl Engines?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Swagger API-REST for Patrowl Engines have?

14 operations on 14 paths (13 GET, 1 POST). The largest groups are patrowl-engine.

Is forking the Swagger API-REST for Patrowl Engines 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.