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.

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:

API Key Subdomain Request

post

API Key Subdomain Request

Body

urlstringOptionalExample: globo.com

Responses

200Success

post

HTTPcURLJavaScriptPython

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

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

Get Subdomain Job

get

Get Subdomain Job

Responses

200Success

get

HTTPcURLJavaScriptPython

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

200Success

No content

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

API Key List Subdomains

get

API Key List Subdomains

Responses

200Success

get

HTTPcURLJavaScriptPython

GET /v1/api/list_subdomain_scans HTTP/1.1
Host: api.vscanner.ai
Accept: */*

200Success

No content

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>",
                ...
            ],
        ]
    }
}