OPEN API
Returns a Bearer token in exchange for client credentials.
The client ID for authentication.
The client secret for authentication.
Authentication successful, returns a Bearer token.
Bad Request. Invalid client credentials.
Unauthorized. Authentication failed.
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"
}{
"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.ukScan submission successful
No content
Unauthorized - Invalid or missing Bearer token
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"
}No content
Lucene query every available fields found in scan reports
Optional query parameters to filter reports.
Returned reports matching query
No content
Unauthorized - Invalid or missing Bearer token
GET /report HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Retrieves a specific scan report by its ID
The ID of the report to retrieve.
Details of the requested report
No content
Unauthorized - Invalid or missing Bearer token
Not Found - Report not found
GET /report/{report_id} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Lucene query every available fields found in domain records.
Optional query parameters to filter domains.
List of domains
No content
Unauthorized - Invalid or missing Bearer token
GET /domain HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Retrieves a specific domain record by its name
The name of the domain to retrieve.
Details of the requested domain
No content
Unauthorized - Invalid or missing Bearer token
Not Found - Domain not found
GET /domain/{name} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Lucene query every available fields found in server records.
Optional query parameters to filter servers.
List of servers
No content
Unauthorized - Invalid or missing Bearer token
GET /server HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Retrieve a full server record by its ip.
The IP address of the server to retrieve.
Details of the requested server
No content
Unauthorized - Invalid or missing Bearer token
Not Found - Server not found
GET /server/{ip} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
No content
Lucene query every available fields found in resource records, including the raw content.
A query parameter for filtering.
Another query parameter for filtering.
Successful response
Bad Request
Unauthorized
GET /resource HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
{
"data": [
{}
]
}Get a specific resource by its SHA256 identifier.
SHA256 identifier of the resource.
Successful response
Unauthorized
Not Found
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.
Successful response
Unauthorized
Not Found
GET /screenshot/{report_id} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*
binarySubmit a prompt to the Webamon AI Model.
Successful response
Bad Request
Unauthorized
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"
}Last updated