Scheduled Report Rule Create

POSThttps://api.deepinfo.com/v1/platform/scheduled-reports/rules

Creates a scheduled report: type, frequency (daily, weekly, monthly) and the team members (user ids) who receive it.

Example

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/platform/scheduled-reports/rules' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Weekly executive summary",
  "type": "easm_executive_summary",
  "frequency": "monthly",
  "members": [
    "00000000-0000-4000-8000-00006bb60001"
  ]
}'

Python

import requests

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

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

payload = {
    "name": "Weekly executive summary",
    "type": "easm_executive_summary",
    "frequency": "monthly",
    "members": [
        "00000000-0000-4000-8000-00006bb60001"
    ]
}

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

JavaScript

const url = "https://api.deepinfo.com/v1/platform/scheduled-reports/rules";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Weekly executive summary",
    type: "easm_executive_summary",
    frequency: "monthly",
    members: [
      "00000000-0000-4000-8000-00006bb60001"
    ]
  }),
});

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

package main

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

func main() {
	payload := strings.NewReader(`{
  "name": "Weekly executive summary",
  "type": "easm_executive_summary",
  "frequency": "monthly",
  "members": [
    "00000000-0000-4000-8000-00006bb60001"
  ]
}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/platform/scheduled-reports/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": "Weekly executive summary",
              "type": "easm_executive_summary",
              "frequency": "monthly",
              "members": [
                "00000000-0000-4000-8000-00006bb60001"
              ]
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/platform/scheduled-reports/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": "Weekly executive summary",
      "type": "easm_executive_summary",
      "frequency": "monthly",
      "members": [
        "00000000-0000-4000-8000-00006bb60001"
      ]
    }
    """;

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/platform/scheduled-reports/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": "Weekly executive summary",
  "type": "easm_executive_summary",
  "frequency": "monthly",
  "members": [
    "00000000-0000-4000-8000-00006bb60001"
  ]
}
JSON;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/platform/scheduled-reports/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/platform/scheduled-reports/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": "Weekly executive summary",
    "type": "easm_executive_summary",
    "frequency": "monthly",
    "members": [
      "00000000-0000-4000-8000-00006bb60001"
    ]
  }
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": "000000000000000e8e040001",
  "name": "Weekly executive summary",
  "type": "easm_executive_summary",
  "type_context": null,
  "frequency": "monthly",
  "members": [
    "00000000-0000-4000-8000-00006bb60001"
  ],
  "last_sent_date": null,
  "next_send_date": "2025-08-30T08:00:00Z",
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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/platform/scheduled-reports/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": "type",
      "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`
`type`	string	Required	One of `easm_executive_summary`, `easm_weekly_progress`, `easm_asset_detail`, `easm_vulnerability_detail`, `easm_vulnerability_overview`, `easm_issue_overview`, `easm_issue_detail`, `cti_email_breach_summary`
`type_context`	object	Optional
`frequency`	string	Required	One of `daily`, `weekly`, `monthly`
`members`	array	Optional

application/json

{
  "name": "Weekly executive summary",
  "type": "easm_executive_summary",
  "frequency": "monthly",
  "members": [
    "00000000-0000-4000-8000-00006bb60001"
  ]
}

Response Fields

Field	Type	Description
`id`	string
`name`	string
`type`	string	One of `easm_executive_summary`, `easm_weekly_progress`, `easm_asset_detail`, `easm_vulnerability_detail`, `easm_vulnerability_overview`, `easm_issue_overview`, `easm_issue_detail`, `cti_email_breach_summary`
`type_context`	object
`frequency`	string	One of `daily`, `weekly`, `monthly`
`members`	array of string
`last_sent_date`	string	date-time
`next_send_date`	string	date-time
`created_at`	string	date-time
`updated_at`	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	`"000000000000000e8e040001"`
`name`	string	`"Weekly executive summary"`
`type`	string	`"easm_executive_summary"`
`type_context`	null
`frequency`	string	`"monthly"`
`members`	array<string>	`"00000000-0000-4000-8000-00006bb60001"`
`last_sent_date`	null
`next_send_date`	string	`"2025-08-30T08:00:00Z"`
`created_at`	string	`"2025-06-01T08:00:00Z"`
`updated_at`	string	`"2025-07-01T08:00:00Z"`

Examples

Selecting one loads it into the request and response panels.

Reference updated September 27, 2026