Update asset policy

Update an existing asset policy. Use append mode to merge new values with existing ones (e.g., add alerting configs or labels without removing current ones). Use replace mode to completely overwrite the policy configuration.

PATCH /v1/asset/policy/{policy_id}

Update asset policy

cURL

curl --request PATCH \
  --url https://api.projectdiscovery.io/v1/asset/policy/{policy_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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
  },
  "name": "<string>",
  "enumeration_ids": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ],
  "alerting_config_ids": [
    "<string>"
  ],
  "apply_to_existing": true
}
'

import requests

url = "https://api.projectdiscovery.io/v1/asset/policy/{policy_id}"

payload = {
    "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
    },
    "name": "<string>",
    "enumeration_ids": ["<string>"],
    "labels": ["<string>"],
    "alerting_config_ids": ["<string>"],
    "apply_to_existing": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
    },
    name: '<string>',
    enumeration_ids: ['<string>'],
    labels: ['<string>'],
    alerting_config_ids: ['<string>'],
    apply_to_existing: true
  })
};

fetch('https://api.projectdiscovery.io/v1/asset/policy/{policy_id}', 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/{policy_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ],
    'name' => '<string>',
    'enumeration_ids' => [
        '<string>'
    ],
    'labels' => [
        '<string>'
    ],
    'alerting_config_ids' => [
        '<string>'
    ],
    'apply_to_existing' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.projectdiscovery.io/v1/asset/policy/{policy_id}"

	payload := strings.NewReader("{\n  \"policies\": {\n    \"is_tech\": true,\n    \"is_favicon\": true,\n    \"is_new\": true,\n    \"labels\": \"<string>\",\n    \"host\": \"<string>\",\n    \"port\": \"<string>\",\n    \"status_code\": \"<string>\",\n    \"content_length\": \"<string>\",\n    \"title\": \"<string>\",\n    \"domain\": [\n      \"<string>\"\n    ],\n    \"cname\": \"<string>\",\n    \"technologies\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"is_screenshot\": true,\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\",\n    \"custom_filter\": \"<string>\",\n    \"search\": \"<string>\",\n    \"enumeration_ids\": [\n      \"<string>\"\n    ],\n    \"only_dns\": true,\n    \"only_ip\": true,\n    \"not_seen_for_days\": 2\n  },\n  \"name\": \"<string>\",\n  \"enumeration_ids\": [\n    \"<string>\"\n  ],\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"apply_to_existing\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.projectdiscovery.io/v1/asset/policy/{policy_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"policies\": {\n    \"is_tech\": true,\n    \"is_favicon\": true,\n    \"is_new\": true,\n    \"labels\": \"<string>\",\n    \"host\": \"<string>\",\n    \"port\": \"<string>\",\n    \"status_code\": \"<string>\",\n    \"content_length\": \"<string>\",\n    \"title\": \"<string>\",\n    \"domain\": [\n      \"<string>\"\n    ],\n    \"cname\": \"<string>\",\n    \"technologies\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"is_screenshot\": true,\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\",\n    \"custom_filter\": \"<string>\",\n    \"search\": \"<string>\",\n    \"enumeration_ids\": [\n      \"<string>\"\n    ],\n    \"only_dns\": true,\n    \"only_ip\": true,\n    \"not_seen_for_days\": 2\n  },\n  \"name\": \"<string>\",\n  \"enumeration_ids\": [\n    \"<string>\"\n  ],\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"apply_to_existing\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"policies\": {\n    \"is_tech\": true,\n    \"is_favicon\": true,\n    \"is_new\": true,\n    \"labels\": \"<string>\",\n    \"host\": \"<string>\",\n    \"port\": \"<string>\",\n    \"status_code\": \"<string>\",\n    \"content_length\": \"<string>\",\n    \"title\": \"<string>\",\n    \"domain\": [\n      \"<string>\"\n    ],\n    \"cname\": \"<string>\",\n    \"technologies\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"is_screenshot\": true,\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\",\n    \"custom_filter\": \"<string>\",\n    \"search\": \"<string>\",\n    \"enumeration_ids\": [\n      \"<string>\"\n    ],\n    \"only_dns\": true,\n    \"only_ip\": true,\n    \"not_seen_for_days\": 2\n  },\n  \"name\": \"<string>\",\n  \"enumeration_ids\": [\n    \"<string>\"\n  ],\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"apply_to_existing\": true\n}"

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

200

{
  "message": "<string>",
  "id": "<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
}

The update_type query parameter controls how values are merged:

Mode	Behavior
append (default)	Merges new values with existing ones. For example, adding new alerting_config_ids keeps the current ones.
replace	Completely overwrites the policy. All required fields for the policy type must be provided.

In replace mode, alerting_config_ids is required for alert policies and labels is required for set_label/remove_label policies.

Example Requests

Append new labels to an existing policy

curl -X PATCH "https://api.projectdiscovery.io/v1/asset/policy/POLICY_ID?update_type=append" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "labels": ["new-label"]
  }'

Replace policy conditions entirely

curl -X PATCH "https://api.projectdiscovery.io/v1/asset/policy/POLICY_ID?update_type=replace" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated policy",
    "policy_type": "delete",
    "policies": {
      "host": "staging.example.com",
      "status_code": "503"
    }
  }'

Authorizations

X-API-Key · string · header · required

Path Parameters

policy_id · string · required

Unique identifier of the asset policy

Query Parameters

update_type · enum<string>

Update strategy. append (default) merges new values with existing ones. replace overwrites the entire policy — all required fields for the policy type must be provided.

Available options: append, replace

Body

application/json

policies · AssetFilters · object

Show child attributes

name · string

Display name for the policy

enumeration_ids · string[]

Optional list of enumeration IDs to scope this policy to specific enumerations

policy_type · enum<string>

Type of action to perform when policy matches assets

Available options: alert, delete, set_label, remove_label

labels · string[]

List of labels to apply/remove (required when policy_type is set_label or remove_label). In append mode, merged with existing labels. In replace mode, replaces all labels.

alerting_config_ids · string[]

List of alerting configuration IDs (required when policy_type is alert). In append mode, merged with existing configs. In replace mode, replaces all configs.

apply_to_existing · boolean

When true, the policy action is applied to existing matching assets in addition to future assets.

Response

200

application/json

OK

message · string

id · string