Skip to content

Commit 62d2371

Browse files
Add public documentation on NDM interface tags endpoint (#3189)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 7c650b9
1 parent c004cc3 commit 62d2371

9 files changed

Lines changed: 153 additions & 7 deletions

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14578,6 +14578,20 @@ datadog\_api\_client.v2.model.list\_findings\_response module
1457814578
:members:
1457914579
:show-inheritance:
1458014580

14581+
datadog\_api\_client.v2.model.list\_interface\_tags\_response module
14582+
--------------------------------------------------------------------
14583+
14584+
.. automodule:: datadog_api_client.v2.model.list_interface_tags_response
14585+
:members:
14586+
:show-inheritance:
14587+
14588+
datadog\_api\_client.v2.model.list\_interface\_tags\_response\_data module
14589+
--------------------------------------------------------------------------
14590+
14591+
.. automodule:: datadog_api_client.v2.model.list_interface_tags_response_data
14592+
:members:
14593+
:show-inheritance:
14594+
1458114595
datadog\_api\_client.v2.model.list\_kind\_catalog\_response module
1458214596
------------------------------------------------------------------
1458314597

datadog_api_client.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4653,6 +4653,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
46534653
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_findings_meta">datadog_api_client.v2.model.list_findings_meta module</a></li>
46544654
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_findings_page">datadog_api_client.v2.model.list_findings_page module</a></li>
46554655
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_findings_response">datadog_api_client.v2.model.list_findings_response module</a></li>
4656+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_interface_tags_response">datadog_api_client.v2.model.list_interface_tags_response module</a></li>
4657+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_interface_tags_response_data">datadog_api_client.v2.model.list_interface_tags_response_data module</a></li>
46564658
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_kind_catalog_response">datadog_api_client.v2.model.list_kind_catalog_response module</a></li>
46574659
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_notification_channels_response">datadog_api_client.v2.model.list_notification_channels_response module</a></li>
46584660
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_on_call_notification_rules_response">datadog_api_client.v2.model.list_on_call_notification_rules_response module</a></li>

datadog_api_client.v2.api.html

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2158,7 +2158,11 @@
21582158
</li>
21592159
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices_with_pagination()</span></code></a>
21602160
</li>
2161+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_interface_user_tags" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_interface_user_tags()</span></code></a>
2162+
</li>
21612163
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_device_user_tags()</span></code></a>
2164+
</li>
2165+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_interface_user_tags" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_interface_user_tags()</span></code></a>
21622166
</li></ul>
21632167
</nav>
21642168
</li></ul>
@@ -11384,6 +11388,20 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1138411388
</dl>
1138511389
</dd></dl>
1138611390
<dl class="py method">
11391+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_interface_user_tags">
11392+
<span class="sig-name descname"><span class="pre">list_interface_user_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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.list_interface_tags_response.ListInterfaceTagsResponse" title="datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse"><span class="pre">ListInterfaceTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_interface_user_tags" title="Link to this definition">¶</a></dt>
11393+
<dd><p>List tags for an interface.</p>
11394+
<p>Returns the tags associated with the specified interface.</p>
11395+
<dl class="field-list simple">
11396+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
11397+
<dd class="field-odd"><p><strong>interface_id</strong> (<em>str</em>) – The ID of the interface for which to retrieve tags.</p>
11398+
</dd>
11399+
<dt class="field-even">Return type<span class="colon">:</span></dt>
11400+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse" title="datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse">ListInterfaceTagsResponse</a></p>
11401+
</dd>
11402+
</dl>
11403+
</dd></dl>
11404+
<dl class="py method">
1138711405
<dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags">
1138811406
<span class="sig-name descname"><span class="pre">update_device_user_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_tags_response.ListTagsResponse" title="datadog_api_client.v2.model.list_tags_response.ListTagsResponse"><span class="pre">ListTagsResponse</span></a></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.list_tags_response.ListTagsResponse" title="datadog_api_client.v2.model.list_tags_response.ListTagsResponse"><span class="pre">ListTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags" title="Link to this definition">¶</a></dt>
1138911407
<dd><p>Update the tags for a device.</p>
@@ -11397,6 +11415,20 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1139711415
</dd>
1139811416
</dl>
1139911417
</dd></dl>
11418+
<dl class="py method">
11419+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_interface_user_tags">
11420+
<span class="sig-name descname"><span class="pre">update_interface_user_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse" title="datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse"><span class="pre">ListInterfaceTagsResponse</span></a></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.list_interface_tags_response.ListInterfaceTagsResponse" title="datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse"><span class="pre">ListInterfaceTagsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_interface_user_tags" title="Link to this definition">¶</a></dt>
11421+
<dd><p>Update the tags for an interface.</p>
11422+
<p>Updates the tags associated with the specified interface.</p>
11423+
<dl class="field-list simple">
11424+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
11425+
<dd class="field-odd"><p><strong>interface_id</strong> (<em>str</em>) – The ID of the interface for which to update tags.</p>
11426+
</dd>
11427+
<dt class="field-even">Return type<span class="colon">:</span></dt>
11428+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse" title="datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse">ListInterfaceTagsResponse</a></p>
11429+
</dd>
11430+
</dl>
11431+
</dd></dl>
1140011432
</dd></dl>
1140111433
</section>
1140211434
<section id="module-datadog_api_client.v2.api.observability_pipelines_api">

datadog_api_client.v2.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1736,7 +1736,9 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
17361736
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_device_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_device_user_tags()</span></code></a></li>
17371737
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices()</span></code></a></li>
17381738
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_devices_with_pagination"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_devices_with_pagination()</span></code></a></li>
1739+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.list_interface_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.list_interface_user_tags()</span></code></a></li>
17391740
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_device_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_device_user_tags()</span></code></a></li>
1741+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.network_device_monitoring_api.NetworkDeviceMonitoringApi.update_interface_user_tags"><code class="docutils literal notranslate"><span class="pre">NetworkDeviceMonitoringApi.update_interface_user_tags()</span></code></a></li>
17401742
</ul>
17411743
</li>
17421744
</ul>
@@ -10870,6 +10872,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
1087010872
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_findings_response.ListFindingsResponse"><code class="docutils literal notranslate"><span class="pre">ListFindingsResponse</span></code></a></li>
1087110873
</ul>
1087210874
</li>
10875+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_interface_tags_response">datadog_api_client.v2.model.list_interface_tags_response module</a><ul>
10876+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_interface_tags_response.ListInterfaceTagsResponse"><code class="docutils literal notranslate"><span class="pre">ListInterfaceTagsResponse</span></code></a></li>
10877+
</ul>
10878+
</li>
10879+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_interface_tags_response_data">datadog_api_client.v2.model.list_interface_tags_response_data module</a><ul>
10880+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_interface_tags_response_data.ListInterfaceTagsResponseData"><code class="docutils literal notranslate"><span class="pre">ListInterfaceTagsResponseData</span></code></a></li>
10881+
</ul>
10882+
</li>
1087310883
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_kind_catalog_response">datadog_api_client.v2.model.list_kind_catalog_response module</a><ul>
1087410884
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_kind_catalog_response.ListKindCatalogResponse"><code class="docutils literal notranslate"><span class="pre">ListKindCatalogResponse</span></code></a></li>
1087510885
</ul>

0 commit comments

Comments
 (0)