OPEN API

PreviousDeployment

Last updated 4 months ago

Hunt Across All Sandbox Reports

get

Lucene query every available fields found in scan reports

Authorizations

Query parameters

urlparamsstringOptional

Optional query parameters to filter reports.

Responses

200

Returned reports matching query

401

Unauthorized - Invalid or missing Bearer token

application/json

get

GET /report HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Retrieve Full Scan Report

get

Retrieves a specific scan report by its ID

Authorizations

Path parameters

report_idstringRequired

The ID of the report to retrieve.

Responses

200

Details of the requested report

401

Unauthorized - Invalid or missing Bearer token

application/json

404

Not Found - Report not found

application/json

get

GET /report/{report_id} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Hunt Across All Hosting Domains

get

Lucene query every available fields found in domain records.

Authorizations

Query parameters

urlparamsstringOptional

Optional query parameters to filter domains.

Responses

200

List of domains

401

Unauthorized - Invalid or missing Bearer token

application/json

get

GET /domain HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Retrieve Full Domain Record

get

Retrieves a specific domain record by its name

Authorizations

Path parameters

namestringRequired

The name of the domain to retrieve.

Responses

200

Details of the requested domain

401

Unauthorized - Invalid or missing Bearer token

application/json

404

Not Found - Domain not found

application/json

get

GET /domain/{name} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Hunt Across All Servers Hosting Web Infrastructure

get

Lucene query every available fields found in server records.

Authorizations

Query parameters

urlparamsstringOptional

Optional query parameters to filter servers.

Responses

200

List of servers

401

Unauthorized - Invalid or missing Bearer token

application/json

get

GET /server HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Retrieve Full Server Record

get

Retrieve a full server record by its ip.

Authorizations

Path parameters

ipstringRequired

The IP address of the server to retrieve.

Responses

200

Details of the requested server

401

Unauthorized - Invalid or missing Bearer token

application/json

404

Not Found - Server not found

application/json

get

GET /server/{ip} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

No content

Search Raw Content Across All Web Resources

get

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

Authorizations

Query parameters

param1stringOptional

A query parameter for filtering.

param2stringOptional

Another query parameter for filtering.

Responses

200

Successful response

application/json

400

Bad Request

401

Unauthorized

get

GET /resource HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {}
  ]
}

Retrieve Raw Resource

get

Get a specific resource by its SHA256 identifier.

Authorizations

Path parameters

sha256string · sha256Required

SHA256 identifier of the resource.

Responses

200

Successful response

application/json

401

Unauthorized

404

Not Found

get

GET /resource/{sha256} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

{
  "data": {}
}

Retrieve a screenshot

get

Get a screenshot by report ID.

Authorizations

Path parameters

report_idstringRequired

Identifier of the report.

Responses

200

Successful response

image/png

Responsestring · binary

401

Unauthorized

404

Not Found

get

GET /screenshot/{report_id} HTTP/1.1
Host: community.webamon.co.uk
Authorization: Bearer JWT
Accept: */*

binary

Authenticate and get a Bearer token

post

Returns a Bearer token in exchange for client credentials.

Authorizations

Body

client_idstringRequired

The client ID for authentication.

client_secretstringRequired

The client secret for authentication.

Responses

200

Authentication successful, returns a Bearer token.

application/json

400

Bad Request. Invalid client credentials.

401

Unauthorized. Authentication failed.

post

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

Submit URL/Domain to Sandbox

post

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

Authorizations

Body

submission_urlstringOptionalExample: https://webamon.co.uk

Responses

200

Scan submission successful

401

Unauthorized - Invalid or missing Bearer token

application/json

post

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

Submit Prompt to Webamon AI Model

post

Submit a prompt to the Webamon AI Model.

Authorizations

Body

promptstringOptional

Responses

200

Successful response

application/json

400

Bad Request

401

Unauthorized

post

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"
}