openapi: 3.1.0 info: title: PENTESTON - API Requests description: | # Summary PENTESTON - API Requests, are software interfaces and protocols designed to enhance the security posture tools for check computer systems, networks, and applications. These APIs play a crucial role in the field of cybersecurity by providing tools and functionalities that enable developers and security professionals to integrate security features into their applications and infrastructure. # Authentication termsOfService: https://penteston.com/terms-of-use contact: name: MUNSIRADO Group OÜ (PENTESTON) url: https://penteston.com/contacts email: support@penteston.com version: "v1.0.0" externalDocs: url: 'https://www.postman.com/munsirado/workspace/penteston-api-v1-0-0/overview' description: 'Postman collection' servers: - url: https://api.penteston.com description: PENTESTON API variables: port: enum: - '443' default: '443' basePath: default: v1 components: securitySchemes: apikeyAuth: title: API Key Token summary: API Key Token description: | To harness the full power of PENTESTON, you'll need an API Key. Follow these simple steps to get started:

1. **Register:** If you haven't already, sign up on https://penteston.com. This will grant you access to an list of advanced scanning tools.

2. **Log In:** After successfully registering, log in to your account using your credentials. Once logged in, you'll be greeted by your personalized dashboard.

3. **Access Your API Key:** Inside your Dashboard, you'll find an option labeled "API Key." Click on this to generate your unique API Key. This key will serve as your authentication token, allowing you to integrate PENTESTON's capabilities seamlessly into your applications, scripts, or tools.

With your API Key in hand, you're ready to explore the world of scanning tools like never before. Seamlessly integrate our robust scanning capabilities into your projects and applications to enhance your cybersecurity posture, monitor your network health, and ensure optimal performance.

Unlock the potential of PENTESTON's API today and take control of your network security and monitoring efforts. Happy scanning! type: apiKey in: header name: PNT-API-KEY tags: - name: Targets description: >- Creating and managing targets (hosts) can be an essential part of various applications and systems, including cybersecurity tools, network management, and vulnerability assessment platforms. - name: Schedule test description: >- API's for Creating and managing tests to check your target, particularly in the context of security testing, often involves the use of various tools. paths: /v1/add_target: post: tags: - Targets summary: Add New Target description: API for Add New Target (Host) requestBody: content: application/x-www-form-urlencoded: schema: properties: target_name: type: string description: Target display name example: Test target target_host: type: string description: Target host Full URL example: http://example.com security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/add_target' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'PNT-API-KEY: ************************' \ --data-urlencode 'target_name=Test target' \ --data-urlencode 'target_host=http://example.com' responses: '200': description: Successful response content: application/json: {} /v1/list_targets: get: tags: - Targets summary: List Targets description: List Targets security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/list_targets' \ --header 'PNT-API-KEY: ************************' responses: '200': description: Successful response content: application/json: {} /v1/add_test: post: tags: - Schedule test summary: New Assessment (Test) requestBody: content: application/x-www-form-urlencoded: schema: properties: test_name: type: string description: Assessment (Test) display name example: Test Name target_id: type: string description: Target ID example: '{{target_id}}' scan_type: type: string description: "Scan type\n\tinfo => Information Gathering\n\trcnc => Reconnaissance\n\tbrte => Brute-force\n\tenum => Enumeration\n\tscan => Scanner\n\tosnt => OSINT\n\tssls => SSL" example: '{{scan_type}}' host_http_user: type: string description: HTTP User (If restriction on host) host_http_pass: type: string description: HTTP Password (If restriction on host) tools: type: string description: "Tools by scan_type, seperated by comma (,)\n\tinfo => Information Gathering\n\t\twhois => Whois \n\t\tnmaps => Nmap (Normal Nmap Scan)\n\t\twhat3 => WhatWeb\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tanubs => Anubis (Subdomain enumeration and information gathering tool)\n\t\trusts => RustScan (The Modern Port Scanner)\n\t\tmstcp => TCP Scan by Metasploit\n\t\tmstwb => Pulling urls from Archive.org by Metasploit\n\t\tdataf => Default File Check by DataSploit\n\t\tdatag => Check Google PDF by DataSploit\n\t\tdatad => Find DNS Records by DataSploit\n\t\tcmsmp => CMS scanner that automates the process of detecting security flaws of the most popular CMSs\n\t\tdmitr => DMitry (Deepmagic Information Gathering Tool)\n\t\tdnsen => dnsenum (enumerates DNS information)\n\t\tjooms => OWASP JoomScan (Joomla Vulnerability Scanner)\n\t\tdiggg => DiG\n\t\t\t\n\trcnc => Reconnaissance\n\t\twhat3 => WhatWeb - Additional requests will be made.\n\t\tdnsdp => DNSDumpster (A tool to perform DNS reconnaissance on target networks.)\n\t\tferce => Fierce (A DNS reconnaissance tool for locating non-contiguous IP space)\n\t\t\n\tbrte => Brute-force\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnscn => dnscan (DNS subdomain scanner)\n\t\tdirb0 => Dirb (A web content scanner)\n\t\tdnsmp => Dnsmap (Scan for subdomains using bruteforcing techniques)\n\t\t\n\tenum => Enumeration\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tanubs => Anubis (Subdomain enumeration and information gathering tool)\n\t\tlepus => Lepus (Subdomain finder)\n\t\tdnsen => dnsenum (enumerates DNS information)\n\t\t\n\tscan => Scanner\n\t\tnmaps => Nmap (Normal Nmap Scan)\n\t\tnikto => Nikto web server scanner\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tdnscn => dnscan (DNS subdomain scanner)\n\t\tdirb0 => Dirb (A web content scanner)\n\t\trusts => RustScan (The Modern Port Scanner)\n\t\tmstcp => TCP Scan by Metasploit\n\t\tcmsmp => CMS scanner that automates the process of detecting security flaws of the most popular CMSs\n\t\tjooms => OWASP JoomScan (Joomla Vulnerability Scanner)\n\t\t\n\tosnt => OSINT\n\t\twhois => Whois (Obtain Whois information and name server of a website)\n\t\tmstwb => Pulling urls from Archive.org by Metasploit\n\t\tdataf => Default File Check by DataSploit\n\t\tdatag => Check Google PDF by DataSploit\n\t\tdatad => Find DNS Records by DataSploit\n\t\tghsdm => Goohost (Extracts hosts/subdomains for a specific domain with Google search)\n\t\tghsip => Goohost (Extracts IP or emails for a specific domain with Google search)\n\t\t\n\tssls => SSL\n\t\tciphr => Cipherscan (Tests the ordering of the SSL/TLS ciphers on a given target)\n\t\t\t" example: '{{tools}}' security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/add_test' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'PNT-API-KEY: ************************' \ --data-urlencode 'test_name=Test Name' \ --data-urlencode 'target_id=************************' \ --data-urlencode 'scan_type=info' \ --data-urlencode 'host_http_user=' \ --data-urlencode 'host_http_pass=' \ --data-urlencode 'tools=dnsrc,anubs' responses: '200': description: Successful response content: application/json: {} /v1/list_tests/{target_id}: get: tags: - Schedule test summary: List Assessments (Tests) security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/list_tests/************************' \ --header 'PNT-API-KEY: ************************' parameters: - name: target_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /v1/test_more/{test_id}: get: tags: - Schedule test summary: Assessment (Test) more security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/test_more/************************' \ --header 'PNT-API-KEY: ************************' parameters: - name: test_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /v1/test_tools/{test_id}: get: tags: - Schedule test summary: Assessment (Test) tools security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/test_tools/************************' \ --header 'PNT-API-KEY: ************************' parameters: - name: test_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /v1/test_tools/{test_id}/{tool_id}: get: tags: - Schedule test summary: Assessment (Test) tools more security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/test_tools/************************/anubs' \ --header 'PNT-API-KEY: ************************' parameters: - name: test_id in: path schema: type: string required: true - name: tool_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /v1/test_report/{test_id}: get: tags: - Schedule test summary: Assessment (Test) report security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/test_report/************************' \ --header 'PNT-API-KEY: ************************' parameters: - name: test_id in: path schema: type: string required: true responses: '200': description: Successful response content: application/json: {} /v1/start_scan: post: tags: - General summary: Start scan requestBody: content: application/x-www-form-urlencoded: schema: properties: target_name: type: string description: Target display name example: Test target (for scan) target_host: type: string description: Target host Full URL example: http://example.com test_name: type: string description: Assessment (Test) display name example: Test Name scan_type: type: string description: "Scan type\n\tinfo => Information Gathering\n\trcnc => Reconnaissance\n\tbrte => Brute-force\n\tenum => Enumeration\n\tscan => Scanner\n\tosnt => OSINT\n\tssls => SSL" example: '{{scan_type}}' host_http_user: type: string description: HTTP User (If restriction on host) host_http_pass: type: string description: HTTP Password (If restriction on host) tools: type: string description: "Tools by scan_type, seperated by comma (,)\n\tinfo => Information Gathering\n\t\twhois => Whois \n\t\tnmaps => Nmap (Normal Nmap Scan)\n\t\twhat3 => WhatWeb\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tanubs => Anubis (Subdomain enumeration and information gathering tool)\n\t\trusts => RustScan (The Modern Port Scanner)\n\t\tmstcp => TCP Scan by Metasploit\n\t\tmstwb => Pulling urls from Archive.org by Metasploit\n\t\tdataf => Default File Check by DataSploit\n\t\tdatag => Check Google PDF by DataSploit\n\t\tdatad => Find DNS Records by DataSploit\n\t\tcmsmp => CMS scanner that automates the process of detecting security flaws of the most popular CMSs\n\t\tdmitr => DMitry (Deepmagic Information Gathering Tool)\n\t\tdnsen => dnsenum (enumerates DNS information)\n\t\tjooms => OWASP JoomScan (Joomla Vulnerability Scanner)\n\t\tdiggg => DiG\n\t\t\t\n\trcnc => Reconnaissance\n\t\twhat3 => WhatWeb - Additional requests will be made.\n\t\tdnsdp => DNSDumpster (A tool to perform DNS reconnaissance on target networks.)\n\t\tferce => Fierce (A DNS reconnaissance tool for locating non-contiguous IP space)\n\t\t\n\tbrte => Brute-force\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnscn => dnscan (DNS subdomain scanner)\n\t\tdirb0 => Dirb (A web content scanner)\n\t\tdnsmp => Dnsmap (Scan for subdomains using bruteforcing techniques)\n\t\t\n\tenum => Enumeration\n\t\tgodns => Gobuster (DNS subdomain enumeration mode)\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tanubs => Anubis (Subdomain enumeration and information gathering tool)\n\t\tlepus => Lepus (Subdomain finder)\n\t\tdnsen => dnsenum (enumerates DNS information)\n\t\t\n\tscan => Scanner\n\t\tnmaps => Nmap (Normal Nmap Scan)\n\t\tnikto => Nikto web server scanner\n\t\tdnsrc => DNSRecon (DNS Enumeration and Scanning Tool)\n\t\tdnscn => dnscan (DNS subdomain scanner)\n\t\tdirb0 => Dirb (A web content scanner)\n\t\trusts => RustScan (The Modern Port Scanner)\n\t\tmstcp => TCP Scan by Metasploit\n\t\tcmsmp => CMS scanner that automates the process of detecting security flaws of the most popular CMSs\n\t\tjooms => OWASP JoomScan (Joomla Vulnerability Scanner)\n\t\t\n\tosnt => OSINT\n\t\twhois => Whois (Obtain Whois information and name server of a website)\n\t\tmstwb => Pulling urls from Archive.org by Metasploit\n\t\tdataf => Default File Check by DataSploit\n\t\tdatag => Check Google PDF by DataSploit\n\t\tdatad => Find DNS Records by DataSploit\n\t\tghsdm => Goohost (Extracts hosts/subdomains for a specific domain with Google search)\n\t\tghsip => Goohost (Extracts IP or emails for a specific domain with Google search)\n\t\t\n\tssls => SSL\n\t\tciphr => Cipherscan (Tests the ordering of the SSL/TLS ciphers on a given target)\n\t\t\t" example: '{{tools}}' security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/start_scan' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'PNT-API-KEY: ************************' \ --data-urlencode 'target_name=Test target (for scan)' \ --data-urlencode 'target_host=http://example.com' \ --data-urlencode 'test_name=Test Name' \ --data-urlencode 'scan_type=info' \ --data-urlencode 'host_http_user=' \ --data-urlencode 'host_http_pass=' \ --data-urlencode 'tools=dnsrc,anubs' responses: '200': description: Successful response content: application/json: {} /v1/api_report: get: tags: - General summary: API Report security: - apikeyAuth: [] x-codeSamples: - lang: cURL source: | curl --location 'https://api.penteston.com/v1/api_report' \ --header 'PNT-API-KEY: ************************' responses: '200': description: Successful response content: application/json: {}