Skip to content

Commit 8139c77

Browse files
Publish IP allowlist APIs (#1330)
Co-authored-by: ci.datadog-api-spec <[email protected]> 318d77a
1 parent 7db01a6 commit 8139c77

10 files changed

+657
-7
lines changed

_sources/datadog_api_client.v2.api.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,13 @@ incidents\_api
9292
:members:
9393
:show-inheritance:
9494

95+
ip\_allowlist\_api
96+
------------------
97+
98+
.. automodule:: datadog_api_client.v2.api.ip_allowlist_api
99+
:members:
100+
:show-inheritance:
101+
95102
key\_management\_api
96103
--------------------
97104

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2227,6 +2227,69 @@ intake\_payload\_accepted
22272227
:members:
22282228
:show-inheritance:
22292229

2230+
ip\_allowlist\_attributes
2231+
-------------------------
2232+
2233+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_attributes
2234+
:members:
2235+
:show-inheritance:
2236+
2237+
ip\_allowlist\_data
2238+
-------------------
2239+
2240+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_data
2241+
:members:
2242+
:show-inheritance:
2243+
2244+
ip\_allowlist\_entry
2245+
--------------------
2246+
2247+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_entry
2248+
:members:
2249+
:show-inheritance:
2250+
2251+
ip\_allowlist\_entry\_attributes
2252+
--------------------------------
2253+
2254+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_entry_attributes
2255+
:members:
2256+
:show-inheritance:
2257+
2258+
ip\_allowlist\_entry\_data
2259+
--------------------------
2260+
2261+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_entry_data
2262+
:members:
2263+
:show-inheritance:
2264+
2265+
ip\_allowlist\_entry\_type
2266+
--------------------------
2267+
2268+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_entry_type
2269+
:members:
2270+
:show-inheritance:
2271+
2272+
ip\_allowlist\_response
2273+
-----------------------
2274+
2275+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_response
2276+
:members:
2277+
:show-inheritance:
2278+
2279+
ip\_allowlist\_type
2280+
-------------------
2281+
2282+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_type
2283+
:members:
2284+
:show-inheritance:
2285+
2286+
ip\_allowlist\_update\_request
2287+
------------------------------
2288+
2289+
.. automodule:: datadog_api_client.v2.model.ip_allowlist_update_request
2290+
:members:
2291+
:show-inheritance:
2292+
22302293
list\_application\_keys\_response
22312294
---------------------------------
22322295

datadog_api_client.html

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4351,6 +4351,10 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
43514351
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.incidents_api.IncidentsApi"><code class="docutils literal notranslate"><span class="pre">IncidentsApi</span></code></a></li>
43524352
</ul>
43534353
</li>
4354+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.ip_allowlist_api">ip_allowlist_api</a><ul>
4355+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi</span></code></a></li>
4356+
</ul>
4357+
</li>
43544358
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.key_management_api">key_management_api</a><ul>
43554359
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.key_management_api.KeyManagementApi"><code class="docutils literal notranslate"><span class="pre">KeyManagementApi</span></code></a></li>
43564360
</ul>
@@ -5702,6 +5706,42 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
57025706
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.intake_payload_accepted.IntakePayloadAccepted"><code class="docutils literal notranslate"><span class="pre">IntakePayloadAccepted</span></code></a></li>
57035707
</ul>
57045708
</li>
5709+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_attributes">ip_allowlist_attributes</a><ul>
5710+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_attributes.IPAllowlistAttributes"><code class="docutils literal notranslate"><span class="pre">IPAllowlistAttributes</span></code></a></li>
5711+
</ul>
5712+
</li>
5713+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_data">ip_allowlist_data</a><ul>
5714+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_data.IPAllowlistData"><code class="docutils literal notranslate"><span class="pre">IPAllowlistData</span></code></a></li>
5715+
</ul>
5716+
</li>
5717+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_entry">ip_allowlist_entry</a><ul>
5718+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_entry.IPAllowlistEntry"><code class="docutils literal notranslate"><span class="pre">IPAllowlistEntry</span></code></a></li>
5719+
</ul>
5720+
</li>
5721+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_entry_attributes">ip_allowlist_entry_attributes</a><ul>
5722+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_entry_attributes.IPAllowlistEntryAttributes"><code class="docutils literal notranslate"><span class="pre">IPAllowlistEntryAttributes</span></code></a></li>
5723+
</ul>
5724+
</li>
5725+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_entry_data">ip_allowlist_entry_data</a><ul>
5726+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_entry_data.IPAllowlistEntryData"><code class="docutils literal notranslate"><span class="pre">IPAllowlistEntryData</span></code></a></li>
5727+
</ul>
5728+
</li>
5729+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_entry_type">ip_allowlist_entry_type</a><ul>
5730+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_entry_type.IPAllowlistEntryType"><code class="docutils literal notranslate"><span class="pre">IPAllowlistEntryType</span></code></a></li>
5731+
</ul>
5732+
</li>
5733+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_response">ip_allowlist_response</a><ul>
5734+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse"><code class="docutils literal notranslate"><span class="pre">IPAllowlistResponse</span></code></a></li>
5735+
</ul>
5736+
</li>
5737+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_type">ip_allowlist_type</a><ul>
5738+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_type.IPAllowlistType"><code class="docutils literal notranslate"><span class="pre">IPAllowlistType</span></code></a></li>
5739+
</ul>
5740+
</li>
5741+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.ip_allowlist_update_request">ip_allowlist_update_request</a><ul>
5742+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_update_request.IPAllowlistUpdateRequest"><code class="docutils literal notranslate"><span class="pre">IPAllowlistUpdateRequest</span></code></a></li>
5743+
</ul>
5744+
</li>
57055745
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.list_application_keys_response">list_application_keys_response</a><ul>
57065746
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.list_application_keys_response.ListApplicationKeysResponse"><code class="docutils literal notranslate"><span class="pre">ListApplicationKeysResponse</span></code></a></li>
57075747
</ul>

datadog_api_client.v2.api.html

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,18 @@
515515
</li></ul>
516516
</nav>
517517
</li>
518+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.ip_allowlist_api" class="md-nav__link">ip_allowlist_api</a><nav class="md-nav">
519+
<ul class="md-nav__list">
520+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi</span></code></a><nav class="md-nav">
521+
<ul class="md-nav__list">
522+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.get_ip_allowlist" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi.get_ip_allowlist()</span></code></a>
523+
</li>
524+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.update_ip_allowlist" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi.update_ip_allowlist()</span></code></a>
525+
</li></ul>
526+
</nav>
527+
</li></ul>
528+
</nav>
529+
</li>
518530
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.key_management_api" class="md-nav__link">key_management_api</a><nav class="md-nav">
519531
<ul class="md-nav__list">
520532
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.key_management_api.KeyManagementApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">KeyManagementApi</span></code></a><nav class="md-nav">
@@ -1612,6 +1624,18 @@
16121624
</li></ul>
16131625
</nav>
16141626
</li>
1627+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.ip_allowlist_api" class="md-nav__link">ip_allowlist_api</a><nav class="md-nav">
1628+
<ul class="md-nav__list">
1629+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi</span></code></a><nav class="md-nav">
1630+
<ul class="md-nav__list">
1631+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.get_ip_allowlist" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi.get_ip_allowlist()</span></code></a>
1632+
</li>
1633+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.update_ip_allowlist" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IPAllowlistApi.update_ip_allowlist()</span></code></a>
1634+
</li></ul>
1635+
</nav>
1636+
</li></ul>
1637+
</nav>
1638+
</li>
16151639
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.key_management_api" class="md-nav__link">key_management_api</a><nav class="md-nav">
16161640
<ul class="md-nav__list">
16171641
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.key_management_api.KeyManagementApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">KeyManagementApi</span></code></a><nav class="md-nav">
@@ -3415,6 +3439,38 @@ <h1 id="datadog-api-client-v2-api--page-root">datadog_api_client.v2.api<a class=
34153439
</dd></dl>
34163440
</dd></dl>
34173441
</section>
3442+
<section id="module-datadog_api_client.v2.api.ip_allowlist_api">
3443+
<span id="ip-allowlist-api"></span><h2 id="module-datadog_api_client.v2.api.ip_allowlist_api">ip_allowlist_api<a class="headerlink" href="#module-datadog_api_client.v2.api.ip_allowlist_api" title="Permalink to this heading">¶</a></h2>
3444+
<dl class="py class">
3445+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi">
3446+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">IPAllowlistApi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi" title="Permalink to this definition">¶</a></dt>
3447+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3448+
<p>The IP allowlist API is used to manage the IP addresses that
3449+
can access the Datadog API and UI.</p>
3450+
<dl class="py method">
3451+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.get_ip_allowlist">
3452+
<span class="sig-name descname"><span class="pre">get_ip_allowlist</span></span><span class="sig-paren">(</span><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.ip_allowlist_response.IPAllowlistResponse" title="datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse"><span class="pre">IPAllowlistResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.get_ip_allowlist" title="Permalink to this definition">¶</a></dt>
3453+
<dd><p>Get IP Allowlist.</p>
3454+
<p>Returns the IP allowlist and its enabled or disabled state.</p>
3455+
<dl class="field-list simple">
3456+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
3457+
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse" title="datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse">IPAllowlistResponse</a></p>
3458+
</dd>
3459+
</dl>
3460+
</dd></dl>
3461+
<dl class="py method">
3462+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.update_ip_allowlist">
3463+
<span class="sig-name descname"><span class="pre">update_ip_allowlist</span></span><span class="sig-paren">(</span><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.ip_allowlist_update_request.IPAllowlistUpdateRequest" title="datadog_api_client.v2.model.ip_allowlist_update_request.IPAllowlistUpdateRequest"><span class="pre">IPAllowlistUpdateRequest</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.ip_allowlist_response.IPAllowlistResponse" title="datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse"><span class="pre">IPAllowlistResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.ip_allowlist_api.IPAllowlistApi.update_ip_allowlist" title="Permalink to this definition">¶</a></dt>
3464+
<dd><p>Update IP Allowlist.</p>
3465+
<p>Edit the entries in the IP allowlist, and enable or disable it.</p>
3466+
<dl class="field-list simple">
3467+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
3468+
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse" title="datadog_api_client.v2.model.ip_allowlist_response.IPAllowlistResponse">IPAllowlistResponse</a></p>
3469+
</dd>
3470+
</dl>
3471+
</dd></dl>
3472+
</dd></dl>
3473+
</section>
34183474
<section id="module-datadog_api_client.v2.api.key_management_api">
34193475
<span id="key-management-api"></span><h2 id="module-datadog_api_client.v2.api.key_management_api">key_management_api<a class="headerlink" href="#module-datadog_api_client.v2.api.key_management_api" title="Permalink to this heading">¶</a></h2>
34203476
<dl class="py class">

0 commit comments

Comments
 (0)