Add documentation for POST api/v2/incidents/import (#3193)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 5188a4e

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -12758,6 +12758,104 @@ datadog\_api\_client.v2.model.incident\_impacts\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.incident\_import\_field\_attributes module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_field_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_field\_attributes\_multiple\_value module
+-----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_field_attributes_multiple_value
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_field\_attributes\_single\_value module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_field_attributes_single_value
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_related\_object module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_related_object
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_relationships module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_relationships
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_request\_attributes module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_request_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_request\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_response\_attributes module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_response\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_response\_included\_item module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_response_included_item
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_response\_relationships module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_response_relationships
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.incident\_import\_visibility module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.incident_import_visibility
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.incident\_integration\_metadata\_attributes module
 --------------------------------------------------------------------------------
 

datadog_api_client.html

@@ -4398,6 +4398,20 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_impact_type">datadog_api_client.v2.model.incident_impact_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_impacts_response">datadog_api_client.v2.model.incident_impacts_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_impacts_type">datadog_api_client.v2.model.incident_impacts_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_field_attributes">datadog_api_client.v2.model.incident_import_field_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_field_attributes_multiple_value">datadog_api_client.v2.model.incident_import_field_attributes_multiple_value module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_field_attributes_single_value">datadog_api_client.v2.model.incident_import_field_attributes_single_value module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_related_object">datadog_api_client.v2.model.incident_import_related_object module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_relationships">datadog_api_client.v2.model.incident_import_relationships module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_request">datadog_api_client.v2.model.incident_import_request module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_request_attributes">datadog_api_client.v2.model.incident_import_request_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_request_data">datadog_api_client.v2.model.incident_import_request_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_response">datadog_api_client.v2.model.incident_import_response module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_response_attributes">datadog_api_client.v2.model.incident_import_response_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_response_data">datadog_api_client.v2.model.incident_import_response_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_response_included_item">datadog_api_client.v2.model.incident_import_response_included_item module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_response_relationships">datadog_api_client.v2.model.incident_import_response_relationships module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_import_visibility">datadog_api_client.v2.model.incident_import_visibility module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_integration_metadata_attributes">datadog_api_client.v2.model.incident_integration_metadata_attributes module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_integration_metadata_create_data">datadog_api_client.v2.model.incident_integration_metadata_create_data module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.incident_integration_metadata_create_request">datadog_api_client.v2.model.incident_integration_metadata_create_request module</a></li>

datadog_api_client.v2.api.html

@@ -1846,6 +1846,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.get_incident_type" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IncidentsApi.get_incident_type()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.import_incident" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IncidentsApi.import_incident()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.list_global_incident_handles" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IncidentsApi.list_global_incident_handles()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.list_incident_attachments" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">IncidentsApi.list_incident_attachments()</span></code></a>
@@ -9414,6 +9416,25 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.incidents_api.IncidentsApi.import_incident">
+<span class="sig-name descname"><span class="pre">import_incident</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.incident_import_request.IncidentImportRequest" title="datadog_api_client.v2.model.incident_import_request.IncidentImportRequest"><span class="pre">IncidentImportRequest</span></a></span></em>, <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">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.incident_import_related_object.IncidentImportRelatedObject" title="datadog_api_client.v2.model.incident_import_related_object.IncidentImportRelatedObject"><span class="pre">IncidentImportRelatedObject</span></a><span class="p"><span class="pre">]</span></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.incident_import_response.IncidentImportResponse" title="datadog_api_client.v2.model.incident_import_response.IncidentImportResponse"><span class="pre">IncidentImportResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.import_incident" title="Link to this definition">¶</a></dt>
+<dd><p>Import an incident.</p>
+<p>Import an incident from an external system. This endpoint allows you to create incidents with
+historical data such as custom timestamps for detection, declaration, and resolution.
+Imported incidents do not execute integrations or notification rules.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.incident_import_request.IncidentImportRequest" title="datadog_api_client.v2.model.incident_import_request.IncidentImportRequest"><em>IncidentImportRequest</em></a>) – Incident import payload.</p></li>
+<li><p><strong>include</strong> (<em>[</em><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.incident_import_related_object.IncidentImportRelatedObject" title="datadog_api_client.v2.model.incident_import_related_object.IncidentImportRelatedObject"><em>IncidentImportRelatedObject</em></a><em>]</em><em>, </em><em>optional</em>) – Specifies which related object types to include in the response when importing an incident.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.incident_import_response.IncidentImportResponse" title="datadog_api_client.v2.model.incident_import_response.IncidentImportResponse">IncidentImportResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.incidents_api.IncidentsApi.list_global_incident_handles">
 <span class="sig-name descname"><span class="pre">list_global_incident_handles</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.incident_handles_response.IncidentHandlesResponse" title="datadog_api_client.v2.model.incident_handles_response.IncidentHandlesResponse"><span class="pre">IncidentHandlesResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.incidents_api.IncidentsApi.list_global_incident_handles" title="Link to this definition">¶</a></dt>
 <dd><p>List global incident handles.</p>