OPEN API

PreviousDeployment

Last updated 1 month ago

Authenticate and get a Bearer token

Returns a Bearer token in exchange for client credentials.

post

/auth

Authorizations

Body

client_idstringrequired

The client ID for authentication.

client_secretstringrequired

The client secret for authentication.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://community.webamon.co.uk/auth' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "client_id": "text",
    "client_secret": "text"
  }'

200

400

401

{
  "bearer": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Authentication successful, returns a Bearer token.

Submit URL/Domain to Sandbox

Scan A URL to retrieve 1st & 3rd party; resources, networks, locations, domains, dns, technology, screenshot, page DOM, certificates and more.

post

/scan

Authorizations

Body

submission_urlstring

Example: https://webamon.co.uk

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://community.webamon.co.uk/scan' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "submission_url": "https://webamon.co.uk"
  }'

200

401

No body

Scan submission successful

Hunt Across All Sandbox Reports

Lucene query every available fields found in scan reports

get

/report

Authorizations

Query parameters

urlparamsstring

Optional query parameters to filter reports.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/report' \
  --header 'Authorization: Bearer JWT'

200

401

No body

Returned reports matching query

Retrieve Full Scan Report

Retrieves a specific scan report by its ID

get

/report/{report_id}

Authorizations

Path parameters

report_idstringrequired

The ID of the report to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/report/{report_id}' \
  --header 'Authorization: Bearer JWT'

200

401

404

No body

Details of the requested report

Hunt Across All Hosting Domains

Lucene query every available fields found in domain records.

get

/domain

Authorizations

Query parameters

urlparamsstring

Optional query parameters to filter domains.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/domain' \
  --header 'Authorization: Bearer JWT'

200

401

No body

List of domains

Retrieve Full Domain Record

Retrieves a specific domain record by its name

get

/domain/{name}

Authorizations

Path parameters

namestringrequired

The name of the domain to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/domain/{name}' \
  --header 'Authorization: Bearer JWT'

200

401

404

No body

Details of the requested domain

Hunt Across All Servers Hosting Web Infrastructure

Lucene query every available fields found in server records.

get

/server

Authorizations

Query parameters

urlparamsstring

Optional query parameters to filter servers.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/server' \
  --header 'Authorization: Bearer JWT'

200

401

No body

List of servers

Retrieve Full Server Record

Retrieve a full server record by its ip.

get

/server/{ip}

Authorizations

Path parameters

ipstringrequired

The IP address of the server to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/server/{ip}' \
  --header 'Authorization: Bearer JWT'

200

401

404

No body

Details of the requested server

Search Raw Content Across All Web Resources

Lucene query every available fields found in resource records, including the raw content.

get

/resource

Authorizations

Query parameters

param1string

A query parameter for filtering.

param2string

Another query parameter for filtering.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/resource' \
  --header 'Authorization: Bearer JWT'

200

400

401

{
  "data": [
    {}
  ]
}

Successful response

Retrieve Raw Resource

Get a specific resource by its SHA256 identifier.

get

/resource/{sha256}

Authorizations

Path parameters

sha256string · sha256required

SHA256 identifier of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/resource/{sha256}' \
  --header 'Authorization: Bearer JWT'

200

401

404

{
  "data": {}
}

Successful response

Retrieve a screenshot

Get a screenshot by report ID.

get

/screenshot/{report_id}

Authorizations

Path parameters

report_idstringrequired

Identifier of the report.

Responses

image/png

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://community.webamon.co.uk/screenshot/{report_id}' \
  --header 'Authorization: Bearer JWT'

200

401

404

text

Successful response

Submit Prompt to Webamon AI Model

Submit a prompt to the Webamon AI Model.

post

/web-assist

Authorizations

Body

promptstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://community.webamon.co.uk/web-assist' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "prompt": "text"
  }'

200

400

401

{
  "status": "scan initiated"
}

Successful response