Swagger API-REST for Patrowl Engines API

by patrowl.local

No authHTTPSSecurity

Overview

This is the API documentation for Patrowl Engines usage.

Swagger API-REST for Patrowl Engines is a security API from patrowl.local. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 14 endpoints.

At a glance

Authentication: No auth
HTTPS: Yes
CORS: Unknown
Category: Security
Base URL: http://patrowl.local
Version: 1.0.0
Endpoints: 14
OpenAPI: Specification ↗
Spec updated: 2021-03-01

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "http://patrowl.local/" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("http://patrowl.local/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://patrowl.local/",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/`	Index page
GET	`/clean`	Clean all scans
GET	`/clean/{scanId}`	Clean scan
GET	`/getfindings/{scanId}`	Get findings on finished scans
GET	`/info`	Engine info page
GET	`/liveness`	Liveness page
GET	`/readiness`	Readiness page
GET	`/reloadconfig`	Configuration reloading page
POST	`/startscan`	Start a new scan
GET	`/status`	Status on all scans
GET	`/status/{scanId}`	Status of a scan
GET	`/stop/{scanId}`	Stop a scan
GET	`/stopscans`	Stop all scans
GET	`/test`	Test page

Questions

Does the Swagger API-REST for Patrowl Engines API need an API key?

No. The Swagger API-REST for Patrowl Engines API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Swagger API-REST for Patrowl Engines API support HTTPS?

Yes, the Swagger API-REST for Patrowl Engines API is served over HTTPS.

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

Its OpenAPI description lists 14 endpoints in version 1.0.0. All of them are shown on this page.

What are alternatives to the Swagger API-REST for Patrowl Engines API?

Other Security APIs include Microsoft Security Response Center (MSRC), National Vulnerability Database, Cisco PSIRT openVuln API, Shodan, BitWarden.

Compare alternatives →

Microsoft Security Response Center (MSRC)

Security

Programmatic interfaces to engage with the Microsoft Security Response Center (MSRC)

No auth

National Vulnerability Database

Security

U.S. National Vulnerability Database

No auth

Cisco PSIRT openVuln API

Security

The Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information). For more information about the Cisco PSIRT openVuln API visit https://developer.cisco.com/site/PSIRT/discover/overview For detail steps on how to use the API go to:https://developer.cisco.com/site/PSIRT/get-started/getting-started.gsp This is a beta release of a swagger YAML for the Cisco PSIRT openVuln API To access the API sign in with your Cisco CCO account at http://apiconsole.cisco.com and register an application to recieve a client_id and a client_secret You can then get your token using curl or any other method you prefer. 'curl -s -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "client_id=<your_client_id>" -d "client_secret=<your_client_secret>" -d "grant_type=client_credentials" https://cloudsso.cisco.com/as/token.oauth2' You will receive an access token as demonstrated in the following example: '{"access_token":"I7omWtBDAieSiUX3shOxNJfuy4J6","token_type":"Bearer","expires_in":3599}' In Swagger, click on Change Authentication enter the text "I7omWtBDAieSiUX3shOxNJfuy4J6" (which is the token you received) then click on "Try this operation"

OAuth19 endpoints