Skip to content

Commit c863c5a

Browse files
Update header for logs search endpoints (#2339)
Co-authored-by: ci.datadog-api-spec <[email protected]> caa1a50
1 parent 5ed78cc commit c863c5a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: datadog_api_client.v2.api.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -5517,10 +5517,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
55175517
<dl class="py method">
55185518
<dt class="sig sig-object py" id="datadog_api_client.v2.api.logs_api.LogsApi.list_logs">
55195519
<span class="sig-name descname"><span class="pre">list_logs</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">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.logs_list_request.LogsListRequest" title="datadog_api_client.v2.model.logs_list_request.LogsListRequest"><span class="pre">LogsListRequest</span></a><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.logs_list_response.LogsListResponse" title="datadog_api_client.v2.model.logs_list_response.LogsListResponse"><span class="pre">LogsListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs" title="Link to this definition">¶</a></dt>
5520-
<dd><p>Search logs.</p>
5520+
<dd><p>Search logs (POST).</p>
55215521
<p>List endpoint returns logs that match a log search query.
55225522
<a class="reference external" href="/logs/guide/collect-multiple-logs-with-pagination">Results are paginated</a>.</p>
5523-
<p>Use this endpoint to build complex logs filtering and search.</p>
5523+
<p>Use this endpoint to search and filter your logs.</p>
55245524
<p>If you are considering archiving logs for your organization,
55255525
consider use of the Datadog archive capabilities instead of the log list API.
55265526
See <a class="reference external" href="https://docs.datadoghq.com/logs/archives">Datadog Logs Archive documentation</a>.</p>
@@ -5533,10 +5533,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
55335533
<dl class="py method">
55345534
<dt class="sig sig-object py" id="datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get">
55355535
<span class="sig-name descname"><span class="pre">list_logs_get</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">filter_query</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">filter_indexes</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><span class="pre">str</span><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>, <em class="sig-param"><span class="n"><span class="pre">filter_from</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</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">filter_to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</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">filter_storage_tier</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.logs_storage_tier.LogsStorageTier" title="datadog_api_client.v2.model.logs_storage_tier.LogsStorageTier"><span class="pre">LogsStorageTier</span></a><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"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.logs_sort.LogsSort" title="datadog_api_client.v2.model.logs_sort.LogsSort"><span class="pre">LogsSort</span></a><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">page_cursor</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">page_limit</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><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.logs_list_response.LogsListResponse" title="datadog_api_client.v2.model.logs_list_response.LogsListResponse"><span class="pre">LogsListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get" title="Link to this definition">¶</a></dt>
5536-
<dd><p>Get a list of logs.</p>
5536+
<dd><p>Search logs (GET).</p>
55375537
<p>List endpoint returns logs that match a log search query.
55385538
<a class="reference external" href="/logs/guide/collect-multiple-logs-with-pagination">Results are paginated</a>.</p>
5539-
<p>Use this endpoint to see your latest logs.</p>
5539+
<p>Use this endpoint to search and filter your logs.</p>
55405540
<p>If you are considering archiving logs for your organization,
55415541
consider use of the Datadog archive capabilities instead of the log list API.
55425542
See <a class="reference external" href="https://docs.datadoghq.com/logs/archives">Datadog Logs Archive documentation</a>.</p>
@@ -5562,7 +5562,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
55625562
<dl class="py method">
55635563
<dt class="sig sig-object py" id="datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get_with_pagination">
55645564
<span class="sig-name descname"><span class="pre">list_logs_get_with_pagination</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">filter_query</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">filter_indexes</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><span class="pre">str</span><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>, <em class="sig-param"><span class="n"><span class="pre">filter_from</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</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">filter_to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</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">filter_storage_tier</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.logs_storage_tier.LogsStorageTier" title="datadog_api_client.v2.model.logs_storage_tier.LogsStorageTier"><span class="pre">LogsStorageTier</span></a><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"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.logs_sort.LogsSort" title="datadog_api_client.v2.model.logs_sort.LogsSort"><span class="pre">LogsSort</span></a><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">page_cursor</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">page_limit</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><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Iterable</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.log.Log" title="datadog_api_client.v2.model.log.Log"><span class="pre">Log</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get_with_pagination" title="Link to this definition">¶</a></dt>
5565-
<dd><p>Get a list of logs.</p>
5565+
<dd><p>Search logs (GET).</p>
55665566
<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get" title="datadog_api_client.v2.api.logs_api.LogsApi.list_logs_get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">list_logs_get()</span></code></a>, returning all items.</p>
55675567
<dl class="field-list simple">
55685568
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -5589,7 +5589,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
55895589
<dl class="py method">
55905590
<dt class="sig sig-object py" id="datadog_api_client.v2.api.logs_api.LogsApi.list_logs_with_pagination">
55915591
<span class="sig-name descname"><span class="pre">list_logs_with_pagination</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">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.logs_list_request.LogsListRequest" title="datadog_api_client.v2.model.logs_list_request.LogsListRequest"><span class="pre">LogsListRequest</span></a><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"><span class="pre">Iterable</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.log.Log" title="datadog_api_client.v2.model.log.Log"><span class="pre">Log</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs_with_pagination" title="Link to this definition">¶</a></dt>
5592-
<dd><p>Search logs.</p>
5592+
<dd><p>Search logs (POST).</p>
55935593
<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v2.api.logs_api.LogsApi.list_logs" title="datadog_api_client.v2.api.logs_api.LogsApi.list_logs"><code class="xref py py-meth docutils literal notranslate"><span class="pre">list_logs()</span></code></a>, returning all items.</p>
55945594
<dl class="field-list simple">
55955595
<dt class="field-odd">Returns<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)