Swagger API-REST for Patrowl Engines
This is the API documentation for Patrowl Engines usage
COMMUNITYNO AUTH0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "http://patrowl.local"
},
{
"url": "http://localhost:5001/engines/nmap/"
},
{
"url": "http://localhost:5004/engines/ssllabs/"
},
{
"url": "http://localhost:5005/engines/arachni/"
},
{
"url": "http://localhost:5006/engines/owl_dns/"
},
{
"url": "http://localhost:5007/engines/virustotal/"
},
{
"url": "http://localhost:5008/engines/urlvoid/"
},
{
"url": "http://localhost:5009/engines/cortex/"
},
{
"url": "http://localhost:5012/engines/owl_leaks/"
},
{
"url": "http://localhost:5013/engines/owl_code/"
},
{
"url": "http://localhost:5014/engines/sslscan/"
}
],
"info": {
"contact": {
"email": "getsupport@patrowl.io",
"x-twitter": "patrowl_io"
},
"description": "This is the API documentation for Patrowl Engines usage.",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"title": "Swagger API-REST for Patrowl Engines",
"version": "1.0.0",
"x-apisguru-categories": [
"security"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_patrowl_io_profile_image.jpeg"
},
"x-origin": [
{
"converter": {
"url": "https://github.com/mermade/oas-kit",
"version": "7.0.4"
},
"format": "openapi",
"url": "https://raw.githubusercontent.com/Patrowl/PatrowlDocs/master/api/openapi-patrowl-engines.yaml",
"version": "3.0"
}
],
"x-providerName": "patrowl.local"
},
"externalDocs": {
"description": "Find out more about Patrowl",
"url": "https://github.com/Patrowl/PatrowlDocs"
},
"tags": [
{
"description": "SSLScan API documentation",
"externalDocs": {
"description": "Find out more",
"url": "https://github.com/Patrowl/PatrowlDocs"
},
"name": "patrowl-engine"
}
],
"paths": {
"/": {
"get": {
"description": "Return index page",
"operationId": "getDefaultPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Index page",
"tags": [
"patrowl-engine"
]
}
},
"/clean": {
"get": {
"description": "Clean all current scans.",
"operationId": "CleanScansPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Clean all scans",
"tags": [
"patrowl-engine"
]
}
},
"/clean/{scanId}": {
"get": {
"description": "Clean scan identified by id.",
"operationId": "CleanScanPage",
"parameters": [
{
"description": "Numeric ID of the scan to clean",
"in": "path",
"name": "scanId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Clean scan",
"tags": [
"patrowl-engine"
]
}
},
"/getfindings/{scanId}": {
"get": {
"description": "Get findings on finished scans.",
"operationId": "GetFindingPage",
"parameters": [
{
"description": "Numeric ID of the scan to get findings",
"in": "path",
"name": "scanId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Findings"
}
}
},
"description": "successful operation"
}
},
"summary": "Get findings on finished scans",
"tags": [
"patrowl-engine"
]
}
},
"/info": {
"get": {
"description": "Return information on engine.",
"operationId": "getInfoPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Engine info page",
"tags": [
"patrowl-engine"
]
}
},
"/liveness": {
"get": {
"description": "Return liveness page",
"operationId": "getLivenessPage",
"responses": {
"200": {
"description": "successful operation"
}
},
"summary": "Liveness page",
"tags": [
"patrowl-engine"
]
}
},
"/readiness": {
"get": {
"description": "Return liveness page",
"operationId": "getReadinessPage",
"responses": {
"200": {
"description": "successful operation"
}
},
"summary": "Readiness page",
"tags": [
"patrowl-engine"
]
}
},
"/reloadconfig": {
"get": {
"description": "Reload the configuration file.",
"operationId": "reloadConfigurationPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Configuration reloading page",
"tags": [
"patrowl-engine"
]
}
},
"/startscan": {
"post": {
"description": "Start a new scan.",
"operationId": "StartScanPage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanDefinition"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Start a new scan",
"tags": [
"patrowl-engine"
]
}
},
"/status": {
"get": {
"description": "Status all current scans.",
"operationId": "StatusScansPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Status on all scans",
"tags": [
"patrowl-engine"
]
}
},
"/status/{scanId}": {
"get": {
"description": "Status of a scan identified by id.",
"operationId": "StatusScanPage",
"parameters": [
{
"description": "Numeric ID of the scan to get status",
"in": "path",
"name": "scanId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Status of a scan",
"tags": [
"patrowl-engine"
]
}
},
"/stop/{scanId}": {
"get": {
"description": "Stop a scan identified by id.",
"operationId": "StopScanPage",
"parameters": [
{
"description": "Numeric ID of the scan to stop",
"in": "path",
"name": "scanId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Stop a scan",
"tags": [
"patrowl-engine"
]
}
},
"/stopscans": {
"get": {
"description": "Stop all current scans.",
"operationId": "StopScansPage",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
},
"description": "successful operation"
}
},
"summary": "Stop all scans",
"tags": [
"patrowl-engine"
]
}
},
"/test": {
"get": {
"description": "Return test page",
"operationId": "getTestPage",
"responses": {
"200": {
"description": "successful operation"
}
},
"summary": "Test page",
"tags": [
"patrowl-engine"
]
}
}
},
"components": {
"schemas": {
"ApiResponse": {
"properties": {
"page": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"Findings": {
"items": {
"properties": {
"confidence": {
"type": "string"
},
"description": {
"type": "string"
},
"issue_id": {
"type": "integer"
},
"meta_links": {
"items": {
"type": "string"
},
"type": "array"
},
"meta_risk": {
"properties": {
"cvss_base_score": {
"items": {
"type": "string"
},
"type": "array"
},
"cvss_vector": {
"items": {
"type": "string"
},
"type": "array"
},
"exploit_available": {
"items": {
"type": "string"
},
"type": "array"
},
"exploitability_ease": {
"items": {
"type": "string"
},
"type": "array"
},
"patch_publication_date": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"meta_tags": {
"items": {
"type": "string"
},
"type": "array"
},
"meta_vuln_refs": {
"properties": {
"bid": {
"items": {
"type": "string"
},
"type": "array"
},
"cpe": {
"items": {
"type": "string"
},
"type": "array"
},
"cve": {
"items": {
"type": "string"
},
"type": "array"
},
"cwe": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"raw": {
"type": "string"
},
"severity": {
"enum": [
"info",
"low",
"medium",
"high"
],
"type": "string"
},
"solution": {
"type": "string"
},
"target_addrs": {
"items": {
"type": "string"
},
"type": "array"
},
"target_proto": {
"items": {
"type": "string"
},
"type": "array"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"ScanDefinition": {
"properties": {
"assets": {
"items": {
"properties": {
"criticity": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"datatype": {
"enum": [
"ip",
"ip-range",
"ip-subnet",
"fqdn",
"domain",
"url",
"keyword",
"person",
"organisation",
"path",
"application"
],
"type": "string"
},
"id": {
"example": "3",
"type": "string"
},
"value": {
"example": "8.8.8.8",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"options": {
"type": "object"
},
"scan_id": {
"example": 1,
"type": "integer"
}
}
}
}
}
}