Notification Rule List

GEThttps://api.deepinfo.com/v1/platform/notification-rules

Lists notification rules. Filter and sort with the optional query parameters.

Example

Request

curl

curl 'https://api.deepinfo.com/v1/platform/notification-rules?page_size=25' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json'

Python

import requests

url = "https://api.deepinfo.com/v1/platform/notification-rules"

params = {
    "page_size": "25"
}

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

response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/platform/notification-rules?page_size=25";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json"
  },
});

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.deepinfo.com/v1/platform/notification-rules?page_size=25", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "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/platform/notification-rules?page_size=25"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .GET()
            .build();

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

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

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.deepinfo.com/v1/platform/notification-rules?page_size=25");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "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/platform/notification-rules?page_size=25',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
    ],
]);

$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/platform/notification-rules?page_size=25')

request = Net::HTTP::Get.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'

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

puts response.body

Response

200 OK · application/json

Response Body

{
  "page": 1,
  "page_size": 25,
  "result_count": 21,
  "results": [
    {
      "id": "000000000000000e8e040001",
      "name": "Critical issues",
      "scope": "asset_security_score_changed",
      "frequency": "instant",
      "delivery_hour": null,
      "delivery_day_of_week": null,
      "members": [
        {
          "team_member_uuid": "00000000-0000-4000-8000-0000f3aa0001",
          "email": "user@acme.example"
        }
      ],
      "enabled": true,
      "added_date": "2025-06-01T08:00:00Z",
      "last_update_date": "2025-07-01T08:00:00Z"
    },
    {
      "id": "000000000000000e8e040002",
      "name": "New vulnerabilities",
      "scope": "asset_security_score_decreased",
      "frequency": "instant",
      "delivery_hour": null,
      "delivery_day_of_week": null,
      "members": [
        {
          "team_member_uuid": "00000000-0000-4000-8000-0000f3aa0004",
          "email": "user@acme.example"
        }
      ],
      "enabled": true,
      "added_date": "2025-05-25T08:00:00Z",
      "last_update_date": "2025-06-24T08:00:00Z"
    }
  ]
}

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

Request

curl

curl 'https://api.deepinfo.com/v1/platform/notification-rules?enabled=notabool' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json'

Python

import requests

url = "https://api.deepinfo.com/v1/platform/notification-rules"

params = {
    "enabled": "notabool"
}

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

response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const url = "https://api.deepinfo.com/v1/platform/notification-rules?enabled=notabool";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json"
  },
});

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.deepinfo.com/v1/platform/notification-rules?enabled=notabool", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "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/platform/notification-rules?enabled=notabool"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .GET()
            .build();

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

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

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.deepinfo.com/v1/platform/notification-rules?enabled=notabool");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "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/platform/notification-rules?enabled=notabool',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
    ],
]);

$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/platform/notification-rules?enabled=notabool')

request = Net::HTTP::Get.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'

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": "enabled",
      "details": [
        "Must be a valid boolean."
      ]
    }
  ],
  "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.

Query Parameters

Parameter	Required	Description
`page_size`	Optional	Min `25`, max `100`. Default `100`. Example`25`
`ordering`	Optional
`page`	Optional	Min `1`, max `800`. Default `1`. Example`1`
`name__contains`	Optional
`name__not_contains`	Optional
`scope__in`	Optional
`scope__nin`	Optional
`frequency__in`	Optional
`frequency__nin`	Optional
`members__in`	Optional
`members__nin`	Optional
`enabled`	Optional
`added_date__lte`	Optional
`added_date__gte`	Optional
`last_update_date__lte`	Optional
`last_update_date__gte`	Optional

Response Fields

Field	Type	Description
`page`	integer
`page_size`	integer
`result_count`	integer
`results`	array of object
`results[].id`	string
`results[].name`	string
`results[].scope`	string	One of `new_issue_detected`, `reappeared_issue_detected`, `asset_security_score_decreased`, `asset_security_score_changed`, `asset_ssl_changed`, `asset_whois_changed`, `asset_dns_changed`, `domain_security_score_decreased`, `domain_security_score_changed`, `new_asset_discovered`, `new_asset_added`, `new_vulnerability_detected`, `reappeared_vulnerability_detected`, `new_email_breach_detected`, `new_suspicious_domain_detected`, `new_fraudulent_domain_detected`, `new_open_port_detected`, `new_employee_credential_detected`, `new_client_credential_detected`, `new_payment_credential_detected`, `new_cybersecurity_news_added`
`results[].frequency`	string	One of `instant`, `hourly`, `daily`, `weekly`, `monthly`
`results[].delivery_hour`	integer
`results[].delivery_day_of_week`	integer
`results[].members`	array of object
`results[].enabled`	boolean
`results[].added_date`	string	date-time
`results[].last_update_date`	string	date-time

Paginated. See Getting Started → Pagination.

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
`page`	number	`1`
`page_size`	number	`25`
`result_count`	number	`21`
`results`	array<object>
`results[].id`	string	`"000000000000000e8e040001"`
`results[].name`	string	`"Critical issues"`
`results[].scope`	string	`"asset_security_score_changed"`
`results[].frequency`	string	`"instant"`
`results[].delivery_hour`	null
`results[].delivery_day_of_week`	null
`results[].members`	array<object>
`results[].members[].team_member_uuid`	string	`"00000000-0000-4000-8000-0000f3aa0001"`
`results[].members[].email`	string
`results[].enabled`	boolean	`true`
`results[].added_date`	string	`"2025-06-01T08:00:00Z"`
`results[].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