Asset Discovery Custom Discovery Rule Create

POSThttps://api.deepinfo.com/v1/easm/discovery/custom-rules

Creates a custom discovery rule. filters select which domains in Deepinfo's dataset become candidates; auto_approval adds them to your assets directly.

Example

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/easm/discovery/custom-rules' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Main domains",
  "filters": {
    "must": [
      {
        "name": "webdata.http.final_domain",
        "value": "acme.example",
        "type": "eq"
      }
    ],
    "must_not": [],
    "should": []
  },
  "tags": [],
  "auto_approval": false,
  "enabled": true
}'

Python

import requests

url = "https://api.deepinfo.com/v1/easm/discovery/custom-rules"

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

payload = {
    "name": "Main domains",
    "filters": {
        "must": [
            {
                "name": "webdata.http.final_domain",
                "value": "acme.example",
                "type": "eq"
            }
        ],
        "must_not": [],
        "should": []
    },
    "tags": [],
    "auto_approval": False,
    "enabled": True
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/easm/discovery/custom-rules";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Main domains",
    filters: {
      must: [
        {
          name: "webdata.http.final_domain",
          value: "acme.example",
          type: "eq"
        }
      ],
      must_not: [],
      should: []
    },
    tags: [],
    auto_approval: false,
    enabled: true
  }),
});

const data = await response.json();
console.log(data);

package main

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

func main() {
	payload := strings.NewReader(`{
  "name": "Main domains",
  "filters": {
    "must": [
      {
        "name": "webdata.http.final_domain",
        "value": "acme.example",
        "type": "eq"
      }
    ],
    "must_not": [],
    "should": []
  },
  "tags": [],
  "auto_approval": false,
  "enabled": true
}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/easm/discovery/custom-rules", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "name": "Main domains",
              "filters": {
                "must": [
                  {
                    "name": "webdata.http.final_domain",
                    "value": "acme.example",
                    "type": "eq"
                  }
                ],
                "must_not": [],
                "should": []
              },
              "tags": [],
              "auto_approval": false,
              "enabled": true
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/easm/discovery/custom-rules"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var body = """
    {
      "name": "Main domains",
      "filters": {
        "must": [
          {
            "name": "webdata.http.final_domain",
            "value": "acme.example",
            "type": "eq"
          }
        ],
        "must_not": [],
        "should": []
      },
      "tags": [],
      "auto_approval": false,
      "enabled": true
    }
    """;

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/easm/discovery/custom-rules");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$body = <<<'JSON'
{
  "name": "Main domains",
  "filters": {
    "must": [
      {
        "name": "webdata.http.final_domain",
        "value": "acme.example",
        "type": "eq"
      }
    ],
    "must_not": [],
    "should": []
  },
  "tags": [],
  "auto_approval": false,
  "enabled": true
}
JSON;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/easm/discovery/custom-rules',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/easm/discovery/custom-rules')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~'JSON'.chomp
  {
    "name": "Main domains",
    "filters": {
      "must": [
        {
          "name": "webdata.http.final_domain",
          "value": "acme.example",
          "type": "eq"
        }
      ],
      "must_not": [],
      "should": []
    },
    "tags": [],
    "auto_approval": false,
    "enabled": true
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

201 Created · application/json

Response Body

{
  "id": "00000000000000000000000e8e040001",
  "name": "Main domains",
  "filters": {
    "must": [
      {
        "name": "webdata.http.final_domain",
        "value": "acme.example",
        "type": "eq"
      }
    ],
    "must_not": [],
    "should": []
  },
  "tags": [],
  "auto_approval": false,
  "enabled": true,
  "create_date": "2025-06-01T08:00:00Z",
  "last_update_date": "2025-07-01T08:00:00Z"
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/easm/discovery/custom-rules' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

import requests

url = "https://api.deepinfo.com/v1/easm/discovery/custom-rules"

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

payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/easm/discovery/custom-rules";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);

package main

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

func main() {
	payload := strings.NewReader(`{}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/easm/discovery/custom-rules", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/easm/discovery/custom-rules"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/easm/discovery/custom-rules");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/easm/discovery/custom-rules',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{}',
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/easm/discovery/custom-rules')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = '{}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

400 Bad Request · application/json

Response Body

{
  "code": 10400,
  "parameters": [
    {
      "param": "name",
      "details": [
        "This field is required."
      ]
    },
    {
      "param": "filters",
      "details": [
        "This field is required."
      ]
    }
  ],
  "solution": "https://docs.deepinfo.com/reference/"
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Authentication

Send your API key in the apikey request header.

Request Body

Parameter	Type	Required	Description
`name`	string	Required	min length `1`; max length `255`
`filters`	object	Required	The filters of the rule; see the example request body
`tags`	array	Optional	max items `10`
`auto_approval`	boolean	Required
`enabled`	boolean	Required

application/json

{
  "name": "Main domains",
  "filters": {
    "must": [
      {
        "name": "webdata.http.final_domain",
        "value": "acme.example",
        "type": "eq"
      }
    ],
    "must_not": [],
    "should": []
  },
  "tags": [],
  "auto_approval": false,
  "enabled": true
}

Response Fields

Field	Type	Description
`id`	string
`name`	string
`filters`	object
`tags`	array of string
`auto_approval`	boolean
`enabled`	boolean
`create_date`	string	date-time
`last_update_date`	string	date-time

Response Schema

Inferred from examples Built from the saved 2xx example response: the fields it contains, with the types seen there. It is not a contract.

Field	Type	Example
`id`	string	`"00000000000000000000000e8e040001"`
`name`	string	`"Main domains"`
`filters`	object
`filters.must`	array<object>
`filters.must[].name`	string	`"webdata.http.final_domain"`
`filters.must[].value`	string	`"acme.example"`
`filters.must[].type`	string	`"eq"`
`filters.must_not`	array
`filters.should`	array
`tags`	array
`auto_approval`	boolean	`false`
`enabled`	boolean	`true`
`create_date`	string	`"2025-06-01T08:00:00Z"`
`last_update_date`	string	`"2025-07-01T08:00:00Z"`

Examples

Selecting one loads it into the request and response panels.

Reference updated September 27, 2026