Last updated 3 months ago
Lucene query every available fields found in scan reports
Optional query parameters to filter reports.
GET /report HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
Returned reports matching query
No content
Retrieves a specific scan report by its ID
The ID of the report to retrieve.
GET /report/{report_id} HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
Details of the requested report
Lucene query every available fields found in domain records.
Optional query parameters to filter domains.
GET /domain HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
List of domains
Retrieves a specific domain record by its name
The name of the domain to retrieve.
GET /domain/{name} HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
Details of the requested domain
Lucene query every available fields found in server records.
Optional query parameters to filter servers.
GET /server HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
List of servers
Retrieve a full server record by its ip.
The IP address of the server to retrieve.
GET /server/{ip} HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
Details of the requested server
Lucene query every available fields found in resource records, including the raw content.
A query parameter for filtering.
Another query parameter for filtering.
GET /resource HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
Successful response
{ "data": [ {} ] }
Get a specific resource by its SHA256 identifier.
SHA256 identifier of the resource.
GET /resource/{sha256} HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
{ "data": {} }
Get a screenshot by report ID.
Identifier of the report.
GET /screenshot/{report_id} HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Accept: */*
binary
Returns a Bearer token in exchange for client credentials.
The client ID for authentication.
The client secret for authentication.
POST /auth HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 43 { "client_id": "text", "client_secret": "text" }
Authentication successful, returns a Bearer token.
{ "bearer": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }
Scan A URL to retrieve 1st & 3rd party; resources, networks, locations, domains, dns, technology, screenshot, page DOM, certificates and more.
https://webamon.co.uk
POST /scan HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 42 { "submission_url": "https://webamon.co.uk" }
Scan submission successful
Submit a prompt to the Webamon AI Model.
POST /web-assist HTTP/1.1 Host: community.webamon.co.uk Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 17 { "prompt": "text" }
{ "status": "scan initiated" }
