OPEN API

Authenticate and get a Bearer token

Returns a Bearer token in exchange for client credentials.

POSThttps://community.webamon.co.uk/auth

Body

application/json

client_id*string

The client ID for authentication.

client_secret*string

The client secret for authentication.

Response

200400401

Authentication successful, returns a Bearer token.

Body

application/json

bearerstring

The Bearer token to be used for authenticated requests.

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/auth', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "client_id": "text",
      "client_secret": "text"
    }),
});
const data = await response.json();

Response

200

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

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.

POSThttps://community.webamon.co.uk/scan

Authorization

BearerAuth

Body

application/json

submission_urlstring

Example: "https://webamon.co.uk"

Response

200401

Scan submission successful

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/scan', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401

{
  "code": 0,
  "message": "text"
}

Hunt Across All Sandbox Reports

Lucene query every available fields found in scan reports

GEThttps://community.webamon.co.uk/report

Authorization

BearerAuth

Query parameters

Response

200401

Returned reports matching query

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/report', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401

{
  "code": 0,
  "message": "text"
}

Retrieve Full Scan Report

Retrieves a specific scan report by its ID

GEThttps://community.webamon.co.uk/report/{report_id}

Authorization

BearerAuth

Path parameters

report_id*string

The ID of the report to retrieve.

Response

200401404

Details of the requested report

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/report/{report_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401404

{
  "code": 0,
  "message": "text"
}

Hunt Across All Hosting Domains

Lucene query every available fields found in domain records.

GEThttps://community.webamon.co.uk/domain

Authorization

BearerAuth

Query parameters

Response

200401

List of domains

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/domain', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401

{
  "code": 0,
  "message": "text"
}

Retrieve Full Domain Record

Retrieves a specific domain record by its name

GEThttps://community.webamon.co.uk/domain/{name}

Authorization

BearerAuth

Path parameters

name*string

The name of the domain to retrieve.

Response

200401404

Details of the requested domain

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/domain/{name}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401404

{
  "code": 0,
  "message": "text"
}

Hunt Across All Servers Hosting Web Infrastructure

Lucene query every available fields found in server records.

GEThttps://community.webamon.co.uk/server

Authorization

BearerAuth

Query parameters

Response

200401

List of servers

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/server', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401

{
  "code": 0,
  "message": "text"
}

Retrieve Full Server Record

Retrieve a full server record by its ip.

GEThttps://community.webamon.co.uk/server/{ip}

Authorization

BearerAuth

Path parameters

ip*string

The IP address of the server to retrieve.

Response

200401404

Details of the requested server

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/server/{ip}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

401404

{
  "code": 0,
  "message": "text"
}

Search Raw Content Across All Web Resources

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

GEThttps://community.webamon.co.uk/resource

Query parameters

Response

200400401

Successful response

Body

application/json

dataarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/resource', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": []
}

Retrieve Raw Resource

Get a specific resource by its SHA256 identifier.

GEThttps://community.webamon.co.uk/resource/{sha256}

Path parameters

sha256*string (sha256)

SHA256 identifier of the resource.

Response

200401404

Successful response

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/resource/{sha256}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Retrieve a screenshot

Get a screenshot by report ID.

GEThttps://community.webamon.co.uk/screenshot/{report_id}

Path parameters

report_id*string

Identifier of the report.

Response

200401404

Successful response

Body

image/png

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/screenshot/{report_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

binary

Submit Prompt to Webamon AI Model

Submit a prompt to the Webamon AI Model.

POSThttps://community.webamon.co.uk/web-assist

Body

application/json

promptstring

Response

200400401

Successful response

Body

application/json

statusstring

Example: "scan initiated"

Request

JavaScriptCurlPython

const response = await fetch('https://community.webamon.co.uk/web-assist', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "status": "scan initiated"
}