Skip to content

Commit 4a0ade2

Browse files
Update Get All Notification Rules API docs to include pagination, sorting, and filtering params (#2808)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 110582d
1 parent cd780b9 commit 4a0ade2

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

datadog_api_client.v2.api.html

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7936,13 +7936,25 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
79367936
</dd></dl>
79377937
<dl class="py method">
79387938
<dt class="sig sig-object py" id="datadog_api_client.v2.api.monitors_api.MonitorsApi.get_monitor_notification_rules">
7939-
<span class="sig-name descname"><span class="pre">get_monitor_notification_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse" title="datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse"><span class="pre">MonitorNotificationRuleListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.monitors_api.MonitorsApi.get_monitor_notification_rules" title="Link to this definition">¶</a></dt>
7939+
<span class="sig-name descname"><span class="pre">get_monitor_notification_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per_page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse" title="datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse"><span class="pre">MonitorNotificationRuleListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.monitors_api.MonitorsApi.get_monitor_notification_rules" title="Link to this definition">¶</a></dt>
79407940
<dd><p>Get all monitor notification rules.</p>
79417941
<p>Returns a list of all monitor notification rules.</p>
79427942
<dl class="field-list simple">
79437943
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7944-
<dd class="field-odd"><p><strong>include</strong> (<em>str</em><em>, </em><em>optional</em>) – Comma-separated list of resource paths for related resources to include in the response. Supported resource
7945-
path is <code class="docutils literal notranslate"><span class="pre">created_by</span></code>.</p>
7944+
<dd class="field-odd"><ul class="simple">
7945+
<li><p><strong>page</strong> (<em>int</em><em>, </em><em>optional</em>) – The page to start paginating from. If <code class="docutils literal notranslate"><span class="pre">page</span></code> is not specified, the argument defaults to the first page.</p></li>
7946+
<li><p><strong>per_page</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of rules to return per page. If <code class="docutils literal notranslate"><span class="pre">per_page</span></code> is not specified, the argument defaults to 100.</p></li>
7947+
<li><p><strong>sort</strong> (<em>str</em><em>, </em><em>optional</em>) – String for sort order, composed of field and sort order separated by a colon, for example <code class="docutils literal notranslate"><span class="pre">name:asc</span></code>. Supported sort directions: <code class="docutils literal notranslate"><span class="pre">asc</span></code> , <code class="docutils literal notranslate"><span class="pre">desc</span></code>. Supported fields: <code class="docutils literal notranslate"><span class="pre">name</span></code> , <code class="docutils literal notranslate"><span class="pre">created_at</span></code>.</p></li>
7948+
<li><p><strong>filters</strong> (<em>str</em><em>, </em><em>optional</em>) – <p>JSON-encoded filter object. Supported keys:</p>
7949+
<ul>
7950+
<li><p><code class="docutils literal notranslate"><span class="pre">text</span></code> : Free-text query matched against rule name, tags, and recipients.</p></li>
7951+
<li><p><code class="docutils literal notranslate"><span class="pre">tags</span></code> : Array of strings. Return rules that have any of these tags.</p></li>
7952+
<li><p><code class="docutils literal notranslate"><span class="pre">recipients</span></code> : Array of strings. Return rules that have any of these recipients.</p></li>
7953+
</ul>
7954+
</p></li>
7955+
<li><p><strong>include</strong> (<em>str</em><em>, </em><em>optional</em>) – Comma-separated list of resource paths for related resources to include in the response. Supported resource
7956+
path is <code class="docutils literal notranslate"><span class="pre">created_by</span></code>.</p></li>
7957+
</ul>
79467958
</dd>
79477959
<dt class="field-even">Return type<span class="colon">:</span></dt>
79487960
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse" title="datadog_api_client.v2.model.monitor_notification_rule_list_response.MonitorNotificationRuleListResponse">MonitorNotificationRuleListResponse</a></p>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)