Create a portfolio TLS report for a list of hosts
POST
/reports
const url = 'https://api.krakenkey.io/reports';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"Client sites, October","hosts":["example.com","api.example.com:8443"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.krakenkey.io/reports \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Client sites, October", "hosts": [ "example.com", "api.example.com:8443" ] }'Hosts are scanned in the background; poll GET /reports/:id until status is complete. Free plan: 25 hosts per report, paid plans: 250.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
Name shown in the report list and on the shared page
string
Example
Client sites, Octoberhosts
required
Hostnames to scan, one per entry, optionally with :port (default 443). Duplicates are dropped. Free plan: up to 25 hosts, paid plans: up to 250.
Array<string>
Example
[ "example.com", "api.example.com:8443"]Responses
Section titled “Responses”Report created (pending)
Invalid or private host
Plan limit exceeded