NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

Scan Reports

API endpoints for retrieving scan reports

Get Site Scan Reports

Endpoint to get all recent scans for a single site

Example request:

curl -X GET -G "/api/site/1/reports" \
    -H "Content-Type: application/json" \
    -d '{"id":"exercitationem"}'
const url = new URL("/api/site/1/reports");

    let params = {
            "api_token": "iure",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id": "exercitationem"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/site/{id}/reports

Body Parameters

Parameter Type Status Description
id required optional Site ID

Query Parameters

Parameter Status Description
api_token required API token

Get Single Scan Report

Endpoint to get a single scan from a single site

Example request:

curl -X GET -G "/api/site/1/report/1" \
    -H "Content-Type: application/json" \
    -d '{"id":"sint","report_id":"sed"}'
const url = new URL("/api/site/1/report/1");

    let params = {
            "api_token": "sed",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id": "sint",
    "report_id": "sed"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/site/{id}/report/{report_id}

Body Parameters

Parameter Type Status Description
id required optional Site ID
report_id required optional The report ID

Query Parameters

Parameter Status Description
api_token required API token

Sites

API endpoints for retrieving information about Sites and their recent scans

Get All Sites

Endpoint to get all of a users sites and their recent scans summaries

Example request:

curl -X GET -G "/api/sites" 
const url = new URL("/api/sites");

    let params = {
            "api_token": "omnis",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/sites

Query Parameters

Parameter Status Description
api_token required API token

Get Single Site

Endpoint to get details about a single site according to its ID

Example request:

curl -X GET -G "/api/site/1" \
    -H "Content-Type: application/json" \
    -d '{"id":4}'
const url = new URL("/api/site/1");

    let params = {
            "api_token": "numquam",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id": 4
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/site/{id}

Body Parameters

Parameter Type Status Description
id integer required The ID of the site.

Query Parameters

Parameter Status Description
api_token required API token