Get asset policy suggestions

Get suggested asset policies based on user data patterns. Analyzes asset data to suggest policies for bad data detection and important asset highlighting.

GET /v1/asset/policy/suggestion

Get asset policy suggestions

cURL

curl --request GET \
  --url https://api.projectdiscovery.io/v1/asset/policy/suggestion \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.projectdiscovery.io/v1/asset/policy/suggestion"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.projectdiscovery.io/v1/asset/policy/suggestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.projectdiscovery.io/v1/asset/policy/suggestion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.projectdiscovery.io/v1/asset/policy/suggestion"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.projectdiscovery.io/v1/asset/policy/suggestion")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.projectdiscovery.io/v1/asset/policy/suggestion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "suggestions": [
    {
      "id": "<string>",
      "category": "<string>",
      "title": "<string>",
      "reason": "<string>",
      "severity": "<string>",
      "suggested_policy": {
        "name": "<string>",
        "policies": {
          "is_tech": true,
          "is_favicon": true,
          "is_new": true,
          "labels": "<string>",
          "host": "<string>",
          "port": "<string>",
          "status_code": "<string>",
          "content_length": "<string>",
          "title": "<string>",
          "domain": [
            "<string>"
          ],
          "cname": "<string>",
          "technologies": "<string>",
          "ip": "<string>",
          "is_screenshot": true,
          "start_date": "2023-12-25",
          "end_date": "2023-12-25",
          "custom_filter": "<string>",
          "search": "<string>",
          "enumeration_ids": [
            "<string>"
          ],
          "only_dns": true,
          "only_ip": true,
          "not_seen_for_days": 2
        },
        "labels": [
          "<string>"
        ]
      },
      "affected_count": 123,
      "affected_percentage": 123,
      "sample_assets": [
        {}
      ]
    }
  ],
  "total": 123,
  "message": "<string>"
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

Each suggestion includes a pre-built policy template that can be used directly with the Create Asset Policy endpoint.

Categories analyzed: error status codes, zero content length, TLS issues, sensitive ports, IP concentration, repeated titles, sensitive technologies (Jenkins, Kubernetes, Redis, etc.), admin panels, login pages, and dev/staging environments.

The threshold parameter controls the minimum percentage of assets a pattern must affect to be suggested (default: 5%).

Example Request

curl -X GET "https://api.projectdiscovery.io/v1/asset/policy/suggestion?limit=5&threshold=10" \
  -H "X-Api-Key: YOUR_API_KEY"

Authorizations

X-API-Key · string · header · required

Query Parameters

enumeration_id · string

Optional enumeration ID to scope suggestions

limit · integer

Maximum suggestions per category

threshold · number

Minimum percentage threshold for anomaly detection

Response

200

application/json

OK

suggestions · AssetPolicySuggestion · object[] · required

List of suggested policies based on user asset patterns

Show child attributes

total · integer<int64> · required

Total number of suggestions

message · string