VScanner's Knowledge Base
  • Welcome to VScanner Documentation
  • VScanner API
    • Introduction
      • Classification
    • Authentication
    • Vulnerability Scanner
      • Scans
        • Explorer Preferences
          • Features
        • Website Vulnerability Preferences
          • Features
        • Scan API Preferences
          • Features
        • Subdomain Finder
    • PDF Report Generation
    • PDF Report AI Action Plan
  • FAQ (Frequently Asked Questions)
    • Account & Subscription
      • Can I change my subscription at any time?
      • Can I delete my account at any time?
      • Which payment methods does VScanner accept?
    • Scans & Reports
      • Can I export the scan result to PDF?
      • I fixed the vulnerabilities found on the last scan, how do I run a new one?
      • How often can I run a scan?
      • How long will it take for a scan to complete?
      • What is a target on VScanner?
      • How to scan a website on VScanner?
      • How does VScanner work?
    • Web Security Vulnerabilities
      • How to protect from cyber attacks?
      • List of OWASP TOP 10 vulnerabilities for 2021-2022
      • What are the most common vulnerabilities on websites?
      • How to fix - Broken Access Control
      • How to fix - Extension Vulnerabilities
      • How to fix - Plugin Vulnerabilities
      • How to fix - CMS Vulnerability
      • How to fix - Weak HTTPS Configurations
      • How to fix - Invalid HTTPS Certificates
      • How to fix - Session Failure
      • How to fix - Validation Failure
      • How to fix - Authorization Failure
      • How to fix - Weak Authentication
      • How to fix - Sensitive Data Exposure
      • How to fix - Cross-Site Request Forgery (CSRF)
      • How to fix - Local File Injection (LFI)
      • How to fix - Remote File Injection (RFI)
      • How to fix - Cross-Site Scripting (XSS)
      • How to fix - Command Injection
      • How to fix - SQL Injection
Powered by GitBook
On this page
  1. VScanner API
  2. Vulnerability Scanner
  3. Scans

Subdomain Finder

Uncover the subdomains of your target domain with our powerful Subdomain Scanner. This documentation provides you with all the information you need to leverage this invaluable feature.

PreviousFeaturesNextPDF Report Generation

Last updated 16 days ago

Enqueue a Subdomain Finder Job

Used to initialize a subdomain finder job

Request

To request the endpoint, you must enter the required credentials, as shown in the following example:

Example CURL request

curl --location --request POST 'https://api.vscanner.ai/v1/api/subdomain' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "example.com"
}'

*Filling in the API_KEY value is mandatory.

Return

The request response, in Json format, contains the identification of the analysis for monitoring and obtaining the result.

Successful response

{"enqueued_scan_id": "<SUBDOMAIN_SCAN_JOB_ID>"} 

Subdomain Scan Result

Request

Used to retrieve the results of a specific subdomain job

Example CURL request

curl --location --request GET 'https://api.vscanner.ai/v1/api/subdomain/<ENQUEUED_JOB_ID>' \
--header 'Authorization: Bearer <API_KEY>'

*Filling in the API_KEY value is mandatory.

Return

The request response, in Json format, contains the state of the subdomain finder job, the results, and the last update date.

Successful response

{
    "start_date": 1690026648,
    "url": <SCANNED_DOMAIN>,
    "total_subdomains": 20,
    "subdomains": [
        "<SUBDOMAIN_1>",
        "<SUBDOMAIN_2>",
        ...
    ],
    "subdomain_job_id": <SUBDOMAIN_FINDER_JOB_ID>
}

List Subdomain Finder Jobs

Request

List all subdomain jobs the user initiated

curl --location --request GET 'https://api.vscanner.ai/v1/api/list_subdomain_scans' \
--header 'Authorization: Bearer <API_KEY>'

*Filling in the API_KEY value is mandatory.

Return

The request response, in Json format, contains the state of the Subdomain Scan, the results, and the last update date.

Successful response

{
    "subdomain_jobs": {
        "<SCANNED_DOMAIN_1>": [
            {
                "start_date": 1690026648,
                "url": <SCANNED_DOMAIN>,
                "total_subdomains": 20,
                "subdomains": [
                    "<SUBDOMAIN_1>",
                    "<SUBDOMAIN_2>",
                    ...
                ],
            }
        ],
        "<SCANNED_DOMAIN_2>": [
                "start_date": 1690026648,
                "url": <SCANNED_DOMAIN>,
                "total_subdomains": 20,
                "subdomains": [
                "<SUBDOMAIN_1>",
                "<SUBDOMAIN_2>",
                ...
            ],
        ]
    }
}

API Key List Subdomains

get

API Key List Subdomains

Responses
200Success
get
GET /v1/api/list_subdomain_scans HTTP/1.1
Host: api.vscanner.ai
Accept: */*
200Success

No content

Get Subdomain Job

get

Get Subdomain Job

Responses
200Success
get
GET /v1/api/subdomain/<ENQUEUED_JOB_ID> HTTP/1.1
Host: api.vscanner.ai
Accept: */*
200Success

No content

  • Enqueue a Subdomain Finder Job
  • POSTAPI Key Subdomain Request
  • Subdomain Scan Result
  • GETGet Subdomain Job
  • List Subdomain Finder Jobs
  • GETAPI Key List Subdomains

API Key Subdomain Request

post

API Key Subdomain Request

Body
urlstringOptionalExample: globo.com
Responses
200Success
post
POST /v1/api/subdomain HTTP/1.1
Host: api.vscanner.ai
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "url": "globo.com"
}
200Success

No content