diff --git a/docs/datadog-docs/index.md b/docs/datadog-docs/index.md index ab80bf4910..39e22f13ca 100644 --- a/docs/datadog-docs/index.md +++ b/docs/datadog-docs/index.md @@ -13,8 +13,10 @@ custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png id: datadog-doc slug: /providers/datadog - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Monitoring, alerting and reporting platform for cloud platforms and applications. :::info Provider Summary (v23.12.00194) @@ -49,8 +51,8 @@ REGISTRY PULL datadog; The following system environment variables are used for authentication by default: -- `DD_API_KEY` - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) -- `DD_APP_KEY` - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) +- - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) +- - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) These variables are sourced at runtime (from the local machine or as CI variables/secrets). diff --git a/docs/datadog-docs/providers/datadog/apm_retention_filters/apm_retention_filters/index.md b/docs/datadog-docs/providers/datadog/apm_retention_filters/apm_retention_filters/index.md index d9bf6b2d13..9ff0e0fed0 100644 --- a/docs/datadog-docs/providers/datadog/apm_retention_filters/apm_retention_filters/index.md +++ b/docs/datadog-docs/providers/datadog/apm_retention_filters/apm_retention_filters/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapm_retention_filters
TypeResource
Iddatadog.apm_retention_filters.apm_retention_filters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the retention filter. | -| `attributes` | `object` | The attributes of the retention filter. | -| `type` | `string` | The type of the resource. | +| | `string` | The ID of the retention filter. | +| | `object` | The attributes of the retention filter. | +| | `string` | The type of the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_apm_retention_filter` | `SELECT` | `filter_id, dd_site` | Get an APM retention filter. | -| `list_apm_retention_filters` | `SELECT` | `dd_site` | Get the list of APM retention filters. | -| `create_apm_retention_filter` | `INSERT` | `data__data, dd_site` | Create a retention filter to index spans in your organization.
Returns the retention filter definition when the request is successful. | -| `delete_apm_retention_filter` | `DELETE` | `filter_id, dd_site` | Delete a specific retention filter from your organization. | -| `_get_apm_retention_filter` | `EXEC` | `filter_id, dd_site` | Get an APM retention filter. | -| `_list_apm_retention_filters` | `EXEC` | `dd_site` | Get the list of APM retention filters. | -| `reorder_apm_retention_filters` | `EXEC` | `data__data, dd_site` | Re-order the execution order of retention filters. | -| `update_apm_retention_filter` | `EXEC` | `filter_id, data__data, dd_site` | Update a retention filter from your organization. | +| | `SELECT` | | Get an APM retention filter. | +| | `SELECT` | | Get the list of APM retention filters. | +| | `INSERT` | | Create a retention filter to index spans in your organization.
Returns the retention filter definition when the request is successful. | +| | `DELETE` | | Delete a specific retention filter from your organization. | +| | `EXEC` | | Get an APM retention filter. | +| | `EXEC` | | Get the list of APM retention filters. | +| | `EXEC` | | Re-order the execution order of retention filters. | +| | `EXEC` | | Update a retention filter from your organization. | diff --git a/docs/datadog-docs/providers/datadog/apm_retention_filters/index.md b/docs/datadog-docs/providers/datadog/apm_retention_filters/index.md index 8f828267c2..a3891881cf 100644 --- a/docs/datadog-docs/providers/datadog/apm_retention_filters/index.md +++ b/docs/datadog-docs/providers/datadog/apm_retention_filters/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + APM Retention Filters :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/audit/audit_logs/index.md b/docs/datadog-docs/providers/datadog/audit/audit_logs/index.md index a8c443dd48..c452ee10d5 100644 --- a/docs/datadog-docs/providers/datadog/audit/audit_logs/index.md +++ b/docs/datadog-docs/providers/datadog/audit/audit_logs/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameaudit_logs
TypeResource
Iddatadog.audit.audit_logs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the event. | -| `attributes` | `object` | JSON object containing all event attributes and their associated values. | -| `type` | `string` | Type of the event. | +| | `string` | Unique ID of the event. | +| | `object` | JSON object containing all event attributes and their associated values. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_audit_logs` | `SELECT` | `dd_site` | List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].

Use this endpoint to see your latest Audit Logs events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | -| `_list_audit_logs` | `EXEC` | `dd_site` | List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].

Use this endpoint to see your latest Audit Logs events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | -| `search_audit_logs` | `EXEC` | `dd_site` | List endpoint returns Audit Logs events that match an Audit search query.
[Results are paginated][1].

Use this endpoint to build complex Audit Logs events filtering and search.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `SELECT` | | List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].

Use this endpoint to see your latest Audit Logs events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `EXEC` | | List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].

Use this endpoint to see your latest Audit Logs events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `EXEC` | | List endpoint returns Audit Logs events that match an Audit search query.
[Results are paginated][1].

Use this endpoint to build complex Audit Logs events filtering and search.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | diff --git a/docs/datadog-docs/providers/datadog/audit/index.md b/docs/datadog-docs/providers/datadog/audit/index.md index bcfae5bbbc..42e834fdb8 100644 --- a/docs/datadog-docs/providers/datadog/audit/index.md +++ b/docs/datadog-docs/providers/datadog/audit/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Search Your Audit Logs Events Over HTTP. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/authn_mappings/index.md b/docs/datadog-docs/providers/datadog/authn_mappings/index.md index 589ae9a20e..dc284e72ec 100644 --- a/docs/datadog-docs/providers/datadog/authn_mappings/index.md +++ b/docs/datadog-docs/providers/datadog/authn_mappings/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + AuthN Mappings :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/authn_mappings/mappings/index.md b/docs/datadog-docs/providers/datadog/authn_mappings/mappings/index.md index 2545617b67..d026677d8e 100644 --- a/docs/datadog-docs/providers/datadog/authn_mappings/mappings/index.md +++ b/docs/datadog-docs/providers/datadog/authn_mappings/mappings/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemappings
TypeResource
Iddatadog.authn_mappings.mappings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the AuthN Mapping. | -| `attributes` | `object` | Attributes of AuthN Mapping. | -| `relationships` | `object` | All relationships associated with AuthN Mapping. | -| `type` | `string` | AuthN Mappings resource type. | +| | `string` | ID of the AuthN Mapping. | +| | `object` | Attributes of AuthN Mapping. | +| | `object` | All relationships associated with AuthN Mapping. | +| | `string` | AuthN Mappings resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `getauthn_mapping` | `SELECT` | `authn_mapping_id, dd_site` | Get an AuthN Mapping specified by the AuthN Mapping UUID. | -| `listauthn_mappings` | `SELECT` | `dd_site` | List all AuthN Mappings in the org. | -| `createauthn_mapping` | `INSERT` | `data__data, dd_site` | Create an AuthN Mapping. | -| `deleteauthn_mapping` | `DELETE` | `authn_mapping_id, dd_site` | Delete an AuthN Mapping specified by AuthN Mapping UUID. | -| `_getauthn_mapping` | `EXEC` | `authn_mapping_id, dd_site` | Get an AuthN Mapping specified by the AuthN Mapping UUID. | -| `_listauthn_mappings` | `EXEC` | `dd_site` | List all AuthN Mappings in the org. | -| `updateauthn_mapping` | `EXEC` | `authn_mapping_id, data__data, dd_site` | Edit an AuthN Mapping. | +| | `SELECT` | | Get an AuthN Mapping specified by the AuthN Mapping UUID. | +| | `SELECT` | | List all AuthN Mappings in the org. | +| | `INSERT` | | Create an AuthN Mapping. | +| | `DELETE` | | Delete an AuthN Mapping specified by AuthN Mapping UUID. | +| | `EXEC` | | Get an AuthN Mapping specified by the AuthN Mapping UUID. | +| | `EXEC` | | List all AuthN Mappings in the org. | +| | `EXEC` | | Edit an AuthN Mapping. | diff --git a/docs/datadog-docs/providers/datadog/ci_visibility/app_pipeline_events/index.md b/docs/datadog-docs/providers/datadog/ci_visibility/app_pipeline_events/index.md index 2f802e5ad6..baf826a103 100644 --- a/docs/datadog-docs/providers/datadog/ci_visibility/app_pipeline_events/index.md +++ b/docs/datadog-docs/providers/datadog/ci_visibility/app_pipeline_events/index.md @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapp_pipeline_events
TypeResource
Iddatadog.ci_visibility.app_pipeline_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the event. | -| `attributes` | `object` | JSON object containing all event attributes and their associated values. | -| `type` | `string` | Type of the event. | +| | `string` | Unique ID of the event. | +| | `object` | JSON object containing all event attributes and their associated values. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_ci_app_pipeline_events` | `SELECT` | `dd_site` | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest pipeline events. | -| `create_ci_app_pipeline_event` | `INSERT` | `dd_site` | Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).

Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. | -| `_list_ci_app_pipeline_events` | `EXEC` | `dd_site` | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest pipeline events. | -| `aggregate_ci_app_pipeline_events` | `EXEC` | `dd_site` | Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. | -| `search_ci_app_pipeline_events` | `EXEC` | `dd_site` | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | +| | `SELECT` | | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest pipeline events. | +| | `INSERT` | | Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).

Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. | +| | `EXEC` | | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest pipeline events. | +| | `EXEC` | | Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. | +| | `EXEC` | | List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | diff --git a/docs/datadog-docs/providers/datadog/ci_visibility/app_test_events/index.md b/docs/datadog-docs/providers/datadog/ci_visibility/app_test_events/index.md index a3da558b6b..6b04a90c26 100644 --- a/docs/datadog-docs/providers/datadog/ci_visibility/app_test_events/index.md +++ b/docs/datadog-docs/providers/datadog/ci_visibility/app_test_events/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapp_test_events
TypeResource
Iddatadog.ci_visibility.app_test_events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the event. | -| `attributes` | `object` | JSON object containing all event attributes and their associated values. | -| `type` | `string` | Type of the event. | +| | `string` | Unique ID of the event. | +| | `object` | JSON object containing all event attributes and their associated values. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_ci_app_test_events` | `SELECT` | `dd_site` | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest test events. | -| `_list_ci_app_test_events` | `EXEC` | `dd_site` | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest test events. | -| `aggregate_ci_app_test_events` | `EXEC` | `dd_site` | The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries. | -| `search_ci_app_test_events` | `EXEC` | `dd_site` | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | +| | `SELECT` | | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest test events. | +| | `EXEC` | | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest test events. | +| | `EXEC` | | The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries. | +| | `EXEC` | | List endpoint returns CI Visibility test events that match a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/).
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | diff --git a/docs/datadog-docs/providers/datadog/ci_visibility/index.md b/docs/datadog-docs/providers/datadog/ci_visibility/index.md index 42980f82f2..449c13f5e2 100644 --- a/docs/datadog-docs/providers/datadog/ci_visibility/index.md +++ b/docs/datadog-docs/providers/datadog/ci_visibility/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + CI Visibility Pipelines :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_policy_files/index.md b/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_policy_files/index.md index c937d5d6f3..a8e43f9af4 100644 --- a/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_policy_files/index.md +++ b/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_policy_files/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecloud_workload_policy_files
TypeResource
Iddatadog.cloud_workload_security.cloud_workload_policy_files
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `_download_cloud_workload_policy_file` | `EXEC` | `dd_site` | -| `download_cloud_workload_policy_file` | `EXEC` | `dd_site` | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_security_agent_rules/index.md b/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_security_agent_rules/index.md index aaa27803db..806682fea8 100644 --- a/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_security_agent_rules/index.md +++ b/docs/datadog-docs/providers/datadog/cloud_workload_security/cloud_workload_security_agent_rules/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecloud_workload_security_agent_rules
TypeResource
Iddatadog.cloud_workload_security.cloud_workload_security_agent_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Agent rule. | -| `attributes` | `object` | A Cloud Workload Security Agent rule returned by the API. | -| `type` | `string` | The type of the resource. The value should always be `agent_rule`. | +| | `string` | The ID of the Agent rule. | +| | `object` | A Cloud Workload Security Agent rule returned by the API. | +| | `string` | The type of the resource. The value should always be `agent_rule`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_cloud_workload_security_agent_rule` | `SELECT` | `agent_rule_id, dd_site` | Get the details of a specific Agent rule. | -| `list_cloud_workload_security_agent_rules` | `SELECT` | `dd_site` | Get the list of Agent rules. | -| `create_cloud_workload_security_agent_rule` | `INSERT` | `data__data, dd_site` | Create a new Agent rule with the given parameters. | -| `delete_cloud_workload_security_agent_rule` | `DELETE` | `agent_rule_id, dd_site` | Delete a specific Agent rule. | -| `_get_cloud_workload_security_agent_rule` | `EXEC` | `agent_rule_id, dd_site` | Get the details of a specific Agent rule. | -| `_list_cloud_workload_security_agent_rules` | `EXEC` | `dd_site` | Get the list of Agent rules. | -| `update_cloud_workload_security_agent_rule` | `EXEC` | `agent_rule_id, data__data, dd_site` | Update a specific Agent rule.
Returns the Agent rule object when the request is successful. | +| | `SELECT` | | Get the details of a specific Agent rule. | +| | `SELECT` | | Get the list of Agent rules. | +| | `INSERT` | | Create a new Agent rule with the given parameters. | +| | `DELETE` | | Delete a specific Agent rule. | +| | `EXEC` | | Get the details of a specific Agent rule. | +| | `EXEC` | | Get the list of Agent rules. | +| | `EXEC` | | Update a specific Agent rule.
Returns the Agent rule object when the request is successful. | diff --git a/docs/datadog-docs/providers/datadog/cloud_workload_security/index.md b/docs/datadog-docs/providers/datadog/cloud_workload_security/index.md index febe7898ea..ff4f1810ff 100644 --- a/docs/datadog-docs/providers/datadog/cloud_workload_security/index.md +++ b/docs/datadog-docs/providers/datadog/cloud_workload_security/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Cloud Workload Security :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/cloudflare_integration/cloudflare_accounts/index.md b/docs/datadog-docs/providers/datadog/cloudflare_integration/cloudflare_accounts/index.md index eee804e7c3..21413d0f64 100644 --- a/docs/datadog-docs/providers/datadog/cloudflare_integration/cloudflare_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/cloudflare_integration/cloudflare_accounts/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecloudflare_accounts
TypeResource
Iddatadog.cloudflare_integration.cloudflare_accounts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Cloudflare account, a hash of the account name. | -| `attributes` | `object` | Attributes object of a Cloudflare account. | -| `type` | `string` | The JSON:API type for this API. Should always be `cloudflare-accounts`. | +| | `string` | The ID of the Cloudflare account, a hash of the account name. | +| | `object` | Attributes object of a Cloudflare account. | +| | `string` | The JSON:API type for this API. Should always be `cloudflare-accounts`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_cloudflare_account` | `SELECT` | `account_id, dd_site` | Get a Cloudflare account. | -| `list_cloudflare_accounts` | `SELECT` | `dd_site` | List Cloudflare accounts. | -| `create_cloudflare_account` | `INSERT` | `data__data, dd_site` | Create a Cloudflare account. | -| `delete_cloudflare_account` | `DELETE` | `account_id, dd_site` | Delete a Cloudflare account. | -| `_get_cloudflare_account` | `EXEC` | `account_id, dd_site` | Get a Cloudflare account. | -| `_list_cloudflare_accounts` | `EXEC` | `dd_site` | List Cloudflare accounts. | -| `update_cloudflare_account` | `EXEC` | `account_id, data__data, dd_site` | Update a Cloudflare account. | +| | `SELECT` | | Get a Cloudflare account. | +| | `SELECT` | | List Cloudflare accounts. | +| | `INSERT` | | Create a Cloudflare account. | +| | `DELETE` | | Delete a Cloudflare account. | +| | `EXEC` | | Get a Cloudflare account. | +| | `EXEC` | | List Cloudflare accounts. | +| | `EXEC` | | Update a Cloudflare account. | diff --git a/docs/datadog-docs/providers/datadog/cloudflare_integration/index.md b/docs/datadog-docs/providers/datadog/cloudflare_integration/index.md index f0e019f56c..02a5aab76c 100644 --- a/docs/datadog-docs/providers/datadog/cloudflare_integration/index.md +++ b/docs/datadog-docs/providers/datadog/cloudflare_integration/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Cloudflare Integration :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_accounts/index.md b/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_accounts/index.md index 15ef1a7efe..2fc2339b4f 100644 --- a/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_accounts/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfluent_accounts
TypeResource
Iddatadog.confluent_cloud.confluent_accounts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A randomly generated ID associated with a Confluent account. | -| `attributes` | `object` | The attributes of a Confluent account. | -| `type` | `string` | The JSON:API type for this API. Should always be `confluent-cloud-accounts`. | +| | `string` | A randomly generated ID associated with a Confluent account. | +| | `object` | The attributes of a Confluent account. | +| | `string` | The JSON:API type for this API. Should always be `confluent-cloud-accounts`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_confluent_account` | `SELECT` | `account_id, dd_site` | Get the Confluent account with the provided account ID. | -| `list_confluent_account` | `SELECT` | `dd_site` | List Confluent accounts. | -| `create_confluent_account` | `INSERT` | `data__data, dd_site` | Create a Confluent account. | -| `delete_confluent_account` | `DELETE` | `account_id, dd_site` | Delete a Confluent account with the provided account ID. | -| `_get_confluent_account` | `EXEC` | `account_id, dd_site` | Get the Confluent account with the provided account ID. | -| `_list_confluent_account` | `EXEC` | `dd_site` | List Confluent accounts. | -| `update_confluent_account` | `EXEC` | `account_id, data__data, dd_site` | Update the Confluent account with the provided account ID. | +| | `SELECT` | | Get the Confluent account with the provided account ID. | +| | `SELECT` | | List Confluent accounts. | +| | `INSERT` | | Create a Confluent account. | +| | `DELETE` | | Delete a Confluent account with the provided account ID. | +| | `EXEC` | | Get the Confluent account with the provided account ID. | +| | `EXEC` | | List Confluent accounts. | +| | `EXEC` | | Update the Confluent account with the provided account ID. | diff --git a/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_resources/index.md b/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_resources/index.md index e29930564c..f9e70bd397 100644 --- a/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_resources/index.md +++ b/docs/datadog-docs/providers/datadog/confluent_cloud/confluent_resources/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameconfluent_resources
TypeResource
Iddatadog.confluent_cloud.confluent_resources
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID associated with the Confluent resource. | -| `attributes` | `object` | Model representation of a Confluent Cloud resource. | -| `type` | `string` | The JSON:API type for this request. | +| | `string` | The ID associated with the Confluent resource. | +| | `object` | Model representation of a Confluent Cloud resource. | +| | `string` | The JSON:API type for this request. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_confluent_resource` | `SELECT` | `account_id, resource_id, dd_site` | Get a Confluent resource with the provided resource id for the account associated with the provided account ID. | -| `list_confluent_resource` | `SELECT` | `account_id, dd_site` | Get a Confluent resource for the account associated with the provided ID. | -| `create_confluent_resource` | `INSERT` | `account_id, data__data, dd_site` | Create a Confluent resource for the account associated with the provided ID. | -| `delete_confluent_resource` | `DELETE` | `account_id, resource_id, dd_site` | Delete a Confluent resource with the provided resource id for the account associated with the provided account ID. | -| `_get_confluent_resource` | `EXEC` | `account_id, resource_id, dd_site` | Get a Confluent resource with the provided resource id for the account associated with the provided account ID. | -| `_list_confluent_resource` | `EXEC` | `account_id, dd_site` | Get a Confluent resource for the account associated with the provided ID. | -| `update_confluent_resource` | `EXEC` | `account_id, resource_id, data__data, dd_site` | Update a Confluent resource with the provided resource id for the account associated with the provided account ID. | +| | `SELECT` | | Get a Confluent resource with the provided resource id for the account associated with the provided account ID. | +| | `SELECT` | | Get a Confluent resource for the account associated with the provided ID. | +| | `INSERT` | | Create a Confluent resource for the account associated with the provided ID. | +| | `DELETE` | | Delete a Confluent resource with the provided resource id for the account associated with the provided account ID. | +| | `EXEC` | | Get a Confluent resource with the provided resource id for the account associated with the provided account ID. | +| | `EXEC` | | Get a Confluent resource for the account associated with the provided ID. | +| | `EXEC` | | Update a Confluent resource with the provided resource id for the account associated with the provided account ID. | diff --git a/docs/datadog-docs/providers/datadog/confluent_cloud/index.md b/docs/datadog-docs/providers/datadog/confluent_cloud/index.md index 2660fb1c43..b185d04c46 100644 --- a/docs/datadog-docs/providers/datadog/confluent_cloud/index.md +++ b/docs/datadog-docs/providers/datadog/confluent_cloud/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Confluent Cloud :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/containers/containers/index.md b/docs/datadog-docs/providers/datadog/containers/containers/index.md index 3d121eebba..04c94d7439 100644 --- a/docs/datadog-docs/providers/datadog/containers/containers/index.md +++ b/docs/datadog-docs/providers/datadog/containers/containers/index.md @@ -14,28 +14,31 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecontainers
TypeResource
Iddatadog.containers.containers
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Container ID. | -| `ContainerGroup_attributes` | `object` | Attributes for a container group. | -| `ContainerGroup_id` | `string` | Container Group ID. | -| `ContainerGroup_type` | `string` | Type of container group. | -| `attributes` | `object` | Attributes for a container. | -| `relationships` | `object` | Relationships to containers inside a container group. | -| `type` | `string` | Type of container. | +| | `string` | Container ID. | +| | `object` | Attributes for a container group. | +| | `string` | Container Group ID. | +| | `string` | Type of container group. | +| | `object` | Attributes for a container. | +| | `object` | Relationships to containers inside a container group. | +| | `string` | Type of container. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_containers` | `SELECT` | `dd_site` | -| `_list_containers` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/containers/images/index.md b/docs/datadog-docs/providers/datadog/containers/images/index.md index bf9f32c137..d43e921882 100644 --- a/docs/datadog-docs/providers/datadog/containers/images/index.md +++ b/docs/datadog-docs/providers/datadog/containers/images/index.md @@ -14,28 +14,31 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameimages
TypeResource
Iddatadog.containers.images
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Container Image ID. | -| `ContainerImageGroup_attributes` | `object` | Attributes for a Container Image Group. | -| `ContainerImageGroup_id` | `string` | Container Image Group ID. | -| `ContainerImageGroup_type` | `string` | Type of Container Image Group. | -| `attributes` | `object` | Attributes for a Container Image. | -| `relationships` | `object` | Relationships inside a Container Image Group. | -| `type` | `string` | Type of Container Image. | +| | `string` | Container Image ID. | +| | `object` | Attributes for a Container Image Group. | +| | `string` | Container Image Group ID. | +| | `string` | Type of Container Image Group. | +| | `object` | Attributes for a Container Image. | +| | `object` | Relationships inside a Container Image Group. | +| | `string` | Type of Container Image. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_container_images` | `SELECT` | `dd_site` | -| `_list_container_images` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/containers/index.md b/docs/datadog-docs/providers/datadog/containers/index.md index 1800054d84..91a2936f9a 100644 --- a/docs/datadog-docs/providers/datadog/containers/index.md +++ b/docs/datadog-docs/providers/datadog/containers/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Container Images :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/dashboard_lists/dashboard_list_items/index.md b/docs/datadog-docs/providers/datadog/dashboard_lists/dashboard_list_items/index.md index 098a144349..3a1e607e0f 100644 --- a/docs/datadog-docs/providers/datadog/dashboard_lists/dashboard_list_items/index.md +++ b/docs/datadog-docs/providers/datadog/dashboard_lists/dashboard_list_items/index.md @@ -14,38 +14,41 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedashboard_list_items
TypeResource
Iddatadog.dashboard_lists.dashboard_list_items
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the dashboard. | -| `author` | `object` | Creator of the object. | -| `created` | `string` | Date of creation of the dashboard. | -| `icon` | `string` | URL to the icon of the dashboard. | -| `integration_id` | `string` | The short name of the integration. | -| `is_favorite` | `boolean` | Whether or not the dashboard is in the favorites. | -| `is_read_only` | `boolean` | Whether or not the dashboard is read only. | -| `is_shared` | `boolean` | Whether the dashboard is publicly shared or not. | -| `modified` | `string` | Date of last edition of the dashboard. | -| `popularity` | `integer` | Popularity of the dashboard. | -| `tags` | `array` | List of team names representing ownership of a dashboard. | -| `title` | `string` | Title of the dashboard. | -| `type` | `string` | The type of the dashboard. | -| `url` | `string` | URL path to the dashboard. | +| | `string` | ID of the dashboard. | +| | `object` | Creator of the object. | +| | `string` | Date of creation of the dashboard. | +| | `string` | URL to the icon of the dashboard. | +| | `string` | The short name of the integration. | +| | `boolean` | Whether or not the dashboard is in the favorites. | +| | `boolean` | Whether or not the dashboard is read only. | +| | `boolean` | Whether the dashboard is publicly shared or not. | +| | `string` | Date of last edition of the dashboard. | +| | `integer` | Popularity of the dashboard. | +| | `array` | List of team names representing ownership of a dashboard. | +| | `string` | Title of the dashboard. | +| | `string` | The type of the dashboard. | +| | `string` | URL path to the dashboard. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_dashboard_list_items` | `SELECT` | `dashboard_list_id, dd_site` | Fetch the dashboard list’s dashboard definitions. | -| `create_dashboard_list_items` | `INSERT` | `dashboard_list_id, dd_site` | Add dashboards to an existing dashboard list. | -| `delete_dashboard_list_items` | `DELETE` | `dashboard_list_id, dd_site` | Delete dashboards from an existing dashboard list. | -| `_get_dashboard_list_items` | `EXEC` | `dashboard_list_id, dd_site` | Fetch the dashboard list’s dashboard definitions. | -| `update_dashboard_list_items` | `EXEC` | `dashboard_list_id, dd_site` | Update dashboards of an existing dashboard list. | +| | `SELECT` | | Fetch the dashboard list’s dashboard definitions. | +| | `INSERT` | | Add dashboards to an existing dashboard list. | +| | `DELETE` | | Delete dashboards from an existing dashboard list. | +| | `EXEC` | | Fetch the dashboard list’s dashboard definitions. | +| | `EXEC` | | Update dashboards of an existing dashboard list. | diff --git a/docs/datadog-docs/providers/datadog/dashboard_lists/index.md b/docs/datadog-docs/providers/datadog/dashboard_lists/index.md index c53c318d89..cfa2bfa44b 100644 --- a/docs/datadog-docs/providers/datadog/dashboard_lists/index.md +++ b/docs/datadog-docs/providers/datadog/dashboard_lists/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Dashboard Lists :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/dora_metrics/deployments/index.md b/docs/datadog-docs/providers/datadog/dora_metrics/deployments/index.md index aab32595af..999ae1e8a0 100644 --- a/docs/datadog-docs/providers/datadog/dora_metrics/deployments/index.md +++ b/docs/datadog-docs/providers/datadog/dora_metrics/deployments/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedeployments
TypeResource
Iddatadog.dora_metrics.deployments
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `create_dora_deployment` | `INSERT` | `data__data, dd_site` | +| | `INSERT` | | diff --git a/docs/datadog-docs/providers/datadog/dora_metrics/incidents/index.md b/docs/datadog-docs/providers/datadog/dora_metrics/incidents/index.md index d1ed141090..53d2b5129c 100644 --- a/docs/datadog-docs/providers/datadog/dora_metrics/incidents/index.md +++ b/docs/datadog-docs/providers/datadog/dora_metrics/incidents/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincidents
TypeResource
Iddatadog.dora_metrics.incidents
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `create_dora_incident` | `INSERT` | `data__data, dd_site` | +| | `INSERT` | | diff --git a/docs/datadog-docs/providers/datadog/dora_metrics/index.md b/docs/datadog-docs/providers/datadog/dora_metrics/index.md index d04b96e4fe..7949f3dd59 100644 --- a/docs/datadog-docs/providers/datadog/dora_metrics/index.md +++ b/docs/datadog-docs/providers/datadog/dora_metrics/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + DORA Metrics :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/downtimes/downtimes/index.md b/docs/datadog-docs/providers/datadog/downtimes/downtimes/index.md index fbded8186d..1c336eafaf 100644 --- a/docs/datadog-docs/providers/datadog/downtimes/downtimes/index.md +++ b/docs/datadog-docs/providers/datadog/downtimes/downtimes/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namedowntimes
TypeResource
Iddatadog.downtimes.downtimes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The downtime ID. | -| `attributes` | `object` | Downtime details. | -| `relationships` | `object` | All relationships associated with downtime. | -| `type` | `string` | Downtime resource type. | +| | `string` | The downtime ID. | +| | `object` | Downtime details. | +| | `object` | All relationships associated with downtime. | +| | `string` | Downtime resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_downtime` | `SELECT` | `downtime_id, dd_site` | Get downtime detail by `downtime_id`. | -| `list_downtimes` | `SELECT` | `dd_site` | Get all scheduled downtimes. | -| `create_downtime` | `INSERT` | `data__data, dd_site` | Schedule a downtime. | -| `_get_downtime` | `EXEC` | `downtime_id, dd_site` | Get downtime detail by `downtime_id`. | -| `_list_downtimes` | `EXEC` | `dd_site` | Get all scheduled downtimes. | -| `cancel_downtime` | `EXEC` | `downtime_id, dd_site` | Cancel a downtime. | -| `update_downtime` | `EXEC` | `downtime_id, data__data, dd_site` | Update a downtime by `downtime_id`. | +| | `SELECT` | | Get downtime detail by `downtime_id`. | +| | `SELECT` | | Get all scheduled downtimes. | +| | `INSERT` | | Schedule a downtime. | +| | `EXEC` | | Get downtime detail by `downtime_id`. | +| | `EXEC` | | Get all scheduled downtimes. | +| | `EXEC` | | Cancel a downtime. | +| | `EXEC` | | Update a downtime by `downtime_id`. | diff --git a/docs/datadog-docs/providers/datadog/downtimes/index.md b/docs/datadog-docs/providers/datadog/downtimes/index.md index 4160721742..348c4820f5 100644 --- a/docs/datadog-docs/providers/datadog/downtimes/index.md +++ b/docs/datadog-docs/providers/datadog/downtimes/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + **Note**: Downtime V2 Is Currently In Private Beta. To Request Access, Contact [Datadog Support](Https://Docs.Datadoghq.Com/Help/). [Downtiming](Https://Docs.Datadoghq.Com/Monitors/Notify/Downtimes) Gives diff --git a/docs/datadog-docs/providers/datadog/downtimes/monitor_downtimes/index.md b/docs/datadog-docs/providers/datadog/downtimes/monitor_downtimes/index.md index e755d5dda9..b4878b41a7 100644 --- a/docs/datadog-docs/providers/datadog/downtimes/monitor_downtimes/index.md +++ b/docs/datadog-docs/providers/datadog/downtimes/monitor_downtimes/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemonitor_downtimes
TypeResource
Iddatadog.downtimes.monitor_downtimes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The downtime ID. | -| `attributes` | `object` | Downtime match details. | -| `type` | `string` | Monitor Downtime Match resource type. | +| | `string` | The downtime ID. | +| | `object` | Downtime match details. | +| | `string` | Monitor Downtime Match resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_monitor_downtimes` | `SELECT` | `monitor_id, dd_site` | -| `_list_monitor_downtimes` | `EXEC` | `monitor_id, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/events/events/index.md b/docs/datadog-docs/providers/datadog/events/events/index.md index 6bae301ace..0e906be37a 100644 --- a/docs/datadog-docs/providers/datadog/events/events/index.md +++ b/docs/datadog-docs/providers/datadog/events/events/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevents
TypeResource
Iddatadog.events.events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | the unique ID of the event. | -| `attributes` | `object` | The object description of an event response attribute. | -| `type` | `string` | Type of the event. | +| | `string` | the unique ID of the event. | +| | `object` | The object description of an event response attribute. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_events` | `SELECT` | `dd_site` | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest events. | -| `_list_events` | `EXEC` | `dd_site` | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest events. | -| `search_events` | `EXEC` | `dd_site` | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | +| | `SELECT` | | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest events. | +| | `EXEC` | | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to see your latest events. | +| | `EXEC` | | List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Use this endpoint to build complex events filtering and search. | diff --git a/docs/datadog-docs/providers/datadog/events/index.md b/docs/datadog-docs/providers/datadog/events/index.md index c5c6071765..1ebee83484 100644 --- a/docs/datadog-docs/providers/datadog/events/index.md +++ b/docs/datadog-docs/providers/datadog/events/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + The Events Service Allows You To Programmatically Post Events To The Event Stream And Fetch Events From The Event Stream. Events Are Limited To 4000 Characters. If An Event Is Sent Out With A Message Containing More Than 4000 Characters, Only The diff --git a/docs/datadog-docs/providers/datadog/fastly_integration/fastly_accounts/index.md b/docs/datadog-docs/providers/datadog/fastly_integration/fastly_accounts/index.md index b8d1ec2d3d..606e6ac577 100644 --- a/docs/datadog-docs/providers/datadog/fastly_integration/fastly_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/fastly_integration/fastly_accounts/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefastly_accounts
TypeResource
Iddatadog.fastly_integration.fastly_accounts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Fastly account, a hash of the account name. | -| `attributes` | `object` | Attributes object of a Fastly account. | -| `type` | `string` | The JSON:API type for this API. Should always be `fastly-accounts`. | +| | `string` | The ID of the Fastly account, a hash of the account name. | +| | `object` | Attributes object of a Fastly account. | +| | `string` | The JSON:API type for this API. Should always be `fastly-accounts`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_fastly_account` | `SELECT` | `account_id, dd_site` | Get a Fastly account. | -| `list_fastly_accounts` | `SELECT` | `dd_site` | List Fastly accounts. | -| `create_fastly_account` | `INSERT` | `data__data, dd_site` | Create a Fastly account. | -| `delete_fastly_account` | `DELETE` | `account_id, dd_site` | Delete a Fastly account. | -| `_get_fastly_account` | `EXEC` | `account_id, dd_site` | Get a Fastly account. | -| `_list_fastly_accounts` | `EXEC` | `dd_site` | List Fastly accounts. | -| `update_fastly_account` | `EXEC` | `account_id, data__data, dd_site` | Update a Fastly account. | +| | `SELECT` | | Get a Fastly account. | +| | `SELECT` | | List Fastly accounts. | +| | `INSERT` | | Create a Fastly account. | +| | `DELETE` | | Delete a Fastly account. | +| | `EXEC` | | Get a Fastly account. | +| | `EXEC` | | List Fastly accounts. | +| | `EXEC` | | Update a Fastly account. | diff --git a/docs/datadog-docs/providers/datadog/fastly_integration/fastly_services/index.md b/docs/datadog-docs/providers/datadog/fastly_integration/fastly_services/index.md index 66996569e1..4c5766776e 100644 --- a/docs/datadog-docs/providers/datadog/fastly_integration/fastly_services/index.md +++ b/docs/datadog-docs/providers/datadog/fastly_integration/fastly_services/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefastly_services
TypeResource
Iddatadog.fastly_integration.fastly_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Fastly service. | -| `attributes` | `object` | Attributes object for Fastly service requests. | -| `type` | `string` | The JSON:API type for this API. Should always be `fastly-services`. | +| | `string` | The ID of the Fastly service. | +| | `object` | Attributes object for Fastly service requests. | +| | `string` | The JSON:API type for this API. Should always be `fastly-services`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_fastly_service` | `SELECT` | `account_id, service_id, dd_site` | Get a Fastly service for an account. | -| `list_fastly_services` | `SELECT` | `account_id, dd_site` | List Fastly services for an account. | -| `create_fastly_service` | `INSERT` | `account_id, data__data, dd_site` | Create a Fastly service for an account. | -| `delete_fastly_service` | `DELETE` | `account_id, service_id, dd_site` | Delete a Fastly service for an account. | -| `_get_fastly_service` | `EXEC` | `account_id, service_id, dd_site` | Get a Fastly service for an account. | -| `_list_fastly_services` | `EXEC` | `account_id, dd_site` | List Fastly services for an account. | -| `update_fastly_service` | `EXEC` | `account_id, service_id, data__data, dd_site` | Update a Fastly service for an account. | +| | `SELECT` | | Get a Fastly service for an account. | +| | `SELECT` | | List Fastly services for an account. | +| | `INSERT` | | Create a Fastly service for an account. | +| | `DELETE` | | Delete a Fastly service for an account. | +| | `EXEC` | | Get a Fastly service for an account. | +| | `EXEC` | | List Fastly services for an account. | +| | `EXEC` | | Update a Fastly service for an account. | diff --git a/docs/datadog-docs/providers/datadog/fastly_integration/index.md b/docs/datadog-docs/providers/datadog/fastly_integration/index.md index 5654dbed48..99e3b7044e 100644 --- a/docs/datadog-docs/providers/datadog/fastly_integration/index.md +++ b/docs/datadog-docs/providers/datadog/fastly_integration/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Fastly Integration :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/gcp_integration/index.md b/docs/datadog-docs/providers/datadog/gcp_integration/index.md index c65a424371..e684ce54f9 100644 --- a/docs/datadog-docs/providers/datadog/gcp_integration/index.md +++ b/docs/datadog-docs/providers/datadog/gcp_integration/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + GCP Integration :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/gcp_integration/sts_accounts/index.md b/docs/datadog-docs/providers/datadog/gcp_integration/sts_accounts/index.md index ecb970c6c6..5ae9862a96 100644 --- a/docs/datadog-docs/providers/datadog/gcp_integration/sts_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/gcp_integration/sts_accounts/index.md @@ -14,28 +14,31 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namests_accounts
TypeResource
Iddatadog.gcp_integration.sts_accounts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Your service account's unique ID. | -| `attributes` | `object` | Attributes associated with your service account. | -| `meta` | `object` | Additional information related to your service account. | -| `type` | `string` | The type of account. | +| | `string` | Your service account's unique ID. | +| | `object` | Attributes associated with your service account. | +| | `object` | Additional information related to your service account. | +| | `string` | The type of account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_gcpsts_accounts` | `SELECT` | `dd_site` | List all GCP STS-enabled service accounts configured in your Datadog account. | -| `create_gcpsts_account` | `INSERT` | `dd_site` | Create a new entry within Datadog for your STS enabled service account. | -| `delete_gcpsts_account` | `DELETE` | `account_id, dd_site` | Delete an STS enabled GCP account from within Datadog. | -| `_list_gcpsts_accounts` | `EXEC` | `dd_site` | List all GCP STS-enabled service accounts configured in your Datadog account. | -| `update_gcpsts_account` | `EXEC` | `account_id, dd_site` | Update an STS enabled service account. | +| | `SELECT` | | List all GCP STS-enabled service accounts configured in your Datadog account. | +| | `INSERT` | | Create a new entry within Datadog for your STS enabled service account. | +| | `DELETE` | | Delete an STS enabled GCP account from within Datadog. | +| | `EXEC` | | List all GCP STS-enabled service accounts configured in your Datadog account. | +| | `EXEC` | | Update an STS enabled service account. | diff --git a/docs/datadog-docs/providers/datadog/gcp_integration/sts_delegates/index.md b/docs/datadog-docs/providers/datadog/gcp_integration/sts_delegates/index.md index eabee0f532..b3cf0f2e47 100644 --- a/docs/datadog-docs/providers/datadog/gcp_integration/sts_delegates/index.md +++ b/docs/datadog-docs/providers/datadog/gcp_integration/sts_delegates/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namests_delegates
TypeResource
Iddatadog.gcp_integration.sts_delegates
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the delegate service account. | -| `attributes` | `object` | Your delegate account attributes. | -| `type` | `string` | The type of account. | +| | `string` | The ID of the delegate service account. | +| | `object` | Your delegate account attributes. | +| | `string` | The type of account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_gcpsts_delegate` | `SELECT` | `dd_site` | List your Datadog-GCP STS delegate account configured in your Datadog account. | -| `_get_gcpsts_delegate` | `EXEC` | `dd_site` | List your Datadog-GCP STS delegate account configured in your Datadog account. | -| `make_gcpsts_delegate` | `EXEC` | `dd_site` | Create a Datadog GCP principal. | +| | `SELECT` | | List your Datadog-GCP STS delegate account configured in your Datadog account. | +| | `EXEC` | | List your Datadog-GCP STS delegate account configured in your Datadog account. | +| | `EXEC` | | Create a Datadog GCP principal. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incident_attachments/index.md b/docs/datadog-docs/providers/datadog/incidents/incident_attachments/index.md index 2f0cf2d910..ed0cb6a81a 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incident_attachments/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incident_attachments/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_attachments
TypeResource
Iddatadog.incidents.incident_attachments
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | A unique identifier that represents the incident attachment. | -| `attributes` | `` | The attributes object for an attachment. | -| `relationships` | `object` | The incident attachment's relationships. | -| `type` | `string` | The incident attachment resource type. | +| | `string` | A unique identifier that represents the incident attachment. | +| | `` | The attributes object for an attachment. | +| | `object` | The incident attachment's relationships. | +| | `string` | The incident attachment resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_incident_attachments` | `SELECT` | `incident_id, dd_site` | Get all attachments for a given incident. | -| `_list_incident_attachments` | `EXEC` | `incident_id, dd_site` | Get all attachments for a given incident. | -| `update_incident_attachments` | `EXEC` | `incident_id, data__data, dd_site` | The bulk update endpoint for creating, updating, and deleting attachments for a given incident. | +| | `SELECT` | | Get all attachments for a given incident. | +| | `EXEC` | | Get all attachments for a given incident. | +| | `EXEC` | | The bulk update endpoint for creating, updating, and deleting attachments for a given incident. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incident_integrations/index.md b/docs/datadog-docs/providers/datadog/incidents/incident_integrations/index.md index a04a3d01c5..807b9a2fd2 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incident_integrations/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incident_integrations/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_integrations
TypeResource
Iddatadog.incidents.incident_integrations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The incident integration metadata's ID. | -| `attributes` | `object` | Incident integration metadata's attributes for a create request. | -| `relationships` | `object` | The incident's integration relationships from a response. | -| `type` | `string` | Integration metadata resource type. | +| | `string` | The incident integration metadata's ID. | +| | `object` | Incident integration metadata's attributes for a create request. | +| | `object` | The incident's integration relationships from a response. | +| | `string` | Integration metadata resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_integration` | `SELECT` | `incident_id, integration_metadata_id, dd_site` | Get incident integration metadata details. | -| `list_incident_integrations` | `SELECT` | `incident_id, dd_site` | Get all integration metadata for an incident. | -| `create_incident_integration` | `INSERT` | `incident_id, data__data, dd_site` | Create an incident integration metadata. | -| `delete_incident_integration` | `DELETE` | `incident_id, integration_metadata_id, dd_site` | Delete an incident integration metadata. | -| `_get_incident_integration` | `EXEC` | `incident_id, integration_metadata_id, dd_site` | Get incident integration metadata details. | -| `_list_incident_integrations` | `EXEC` | `incident_id, dd_site` | Get all integration metadata for an incident. | -| `update_incident_integration` | `EXEC` | `incident_id, integration_metadata_id, data__data, dd_site` | Update an existing incident integration metadata. | +| | `SELECT` | | Get incident integration metadata details. | +| | `SELECT` | | Get all integration metadata for an incident. | +| | `INSERT` | | Create an incident integration metadata. | +| | `DELETE` | | Delete an incident integration metadata. | +| | `EXEC` | | Get incident integration metadata details. | +| | `EXEC` | | Get all integration metadata for an incident. | +| | `EXEC` | | Update an existing incident integration metadata. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incident_services/index.md b/docs/datadog-docs/providers/datadog/incidents/incident_services/index.md index 0d759fdc8d..af7ce3775b 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incident_services/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incident_services/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_services
TypeResource
Iddatadog.incidents.incident_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The incident service's ID. | -| `attributes` | `object` | The incident service's attributes from a response. | -| `relationships` | `object` | The incident service's relationships. | -| `type` | `string` | Incident service resource type. | +| | `string` | The incident service's ID. | +| | `object` | The incident service's attributes from a response. | +| | `object` | The incident service's relationships. | +| | `string` | Incident service resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_service` | `SELECT` | `service_id, dd_site` | Get details of an incident service. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident services. | -| `list_incident_services` | `SELECT` | `dd_site` | Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services. | -| `create_incident_service` | `INSERT` | `data__data, dd_site` | Creates a new incident service. | -| `delete_incident_service` | `DELETE` | `service_id, dd_site` | Deletes an existing incident service. | -| `_get_incident_service` | `EXEC` | `service_id, dd_site` | Get details of an incident service. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident services. | -| `_list_incident_services` | `EXEC` | `dd_site` | Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services. | -| `update_incident_service` | `EXEC` | `service_id, data__data, dd_site` | Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. | +| | `SELECT` | | Get details of an incident service. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident services. | +| | `SELECT` | | Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services. | +| | `INSERT` | | Creates a new incident service. | +| | `DELETE` | | Deletes an existing incident service. | +| | `EXEC` | | Get details of an incident service. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident services. | +| | `EXEC` | | Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services. | +| | `EXEC` | | Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incident_teams/index.md b/docs/datadog-docs/providers/datadog/incidents/incident_teams/index.md index fb7ffd3036..e8b454d257 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incident_teams/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incident_teams/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_teams
TypeResource
Iddatadog.incidents.incident_teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The incident team's ID. | -| `attributes` | `object` | The incident team's attributes from a response. | -| `relationships` | `object` | The incident team's relationships. | -| `type` | `string` | Incident Team resource type. | +| | `string` | The incident team's ID. | +| | `object` | The incident team's attributes from a response. | +| | `object` | The incident team's relationships. | +| | `string` | Incident Team resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_team` | `SELECT` | `team_id, dd_site` | Get details of an incident team. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident teams. | -| `list_incident_teams` | `SELECT` | `dd_site` | Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams. | -| `create_incident_team` | `INSERT` | `data__data, dd_site` | Creates a new incident team. | -| `delete_incident_team` | `DELETE` | `team_id, dd_site` | Deletes an existing incident team. | -| `_get_incident_team` | `EXEC` | `team_id, dd_site` | Get details of an incident team. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident teams. | -| `_list_incident_teams` | `EXEC` | `dd_site` | Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams. | -| `update_incident_team` | `EXEC` | `team_id, data__data, dd_site` | Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. | +| | `SELECT` | | Get details of an incident team. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident teams. | +| | `SELECT` | | Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams. | +| | `INSERT` | | Creates a new incident team. | +| | `DELETE` | | Deletes an existing incident team. | +| | `EXEC` | | Get details of an incident team. If the `include[users]` query parameter is provided,
the included attribute will contain the users related to these incident teams. | +| | `EXEC` | | Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams. | +| | `EXEC` | | Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incident_todos/index.md b/docs/datadog-docs/providers/datadog/incidents/incident_todos/index.md index cd24a2e300..ef11ec5724 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incident_todos/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incident_todos/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincident_todos
TypeResource
Iddatadog.incidents.incident_todos
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The incident todo's ID. | -| `attributes` | `object` | Incident todo's attributes. | -| `relationships` | `object` | The incident's relationships from a response. | -| `type` | `string` | Todo resource type. | +| | `string` | The incident todo's ID. | +| | `object` | Incident todo's attributes. | +| | `object` | The incident's relationships from a response. | +| | `string` | Todo resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident_todo` | `SELECT` | `incident_id, todo_id, dd_site` | Get incident todo details. | -| `list_incident_todos` | `SELECT` | `incident_id, dd_site` | Get all todos for an incident. | -| `create_incident_todo` | `INSERT` | `incident_id, data__data, dd_site` | Create an incident todo. | -| `delete_incident_todo` | `DELETE` | `incident_id, todo_id, dd_site` | Delete an incident todo. | -| `_get_incident_todo` | `EXEC` | `incident_id, todo_id, dd_site` | Get incident todo details. | -| `_list_incident_todos` | `EXEC` | `incident_id, dd_site` | Get all todos for an incident. | -| `update_incident_todo` | `EXEC` | `incident_id, todo_id, data__data, dd_site` | Update an incident todo. | +| | `SELECT` | | Get incident todo details. | +| | `SELECT` | | Get all todos for an incident. | +| | `INSERT` | | Create an incident todo. | +| | `DELETE` | | Delete an incident todo. | +| | `EXEC` | | Get incident todo details. | +| | `EXEC` | | Get all todos for an incident. | +| | `EXEC` | | Update an incident todo. | diff --git a/docs/datadog-docs/providers/datadog/incidents/incidents/index.md b/docs/datadog-docs/providers/datadog/incidents/incidents/index.md index cf77256020..3922a6e368 100644 --- a/docs/datadog-docs/providers/datadog/incidents/incidents/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/incidents/index.md @@ -14,32 +14,35 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameincidents
TypeResource
Iddatadog.incidents.incidents
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The incident's ID. | -| `attributes` | `object` | The incident's attributes from a response. | -| `relationships` | `object` | The incident's relationships from a response. | -| `type` | `string` | Incident resource type. | +| | `string` | The incident's ID. | +| | `object` | The incident's attributes from a response. | +| | `object` | The incident's relationships from a response. | +| | `string` | Incident resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_incident` | `SELECT` | `incident_id, dd_site` | Get the details of an incident by `incident_id`. | -| `list_incidents` | `SELECT` | `dd_site` | Get all incidents for the user's organization. | -| `search_incidents` | `SELECT` | `query, dd_site` | Search for incidents matching a certain query. | -| `create_incident` | `INSERT` | `data__data, dd_site` | Create an incident. | -| `delete_incident` | `DELETE` | `incident_id, dd_site` | Deletes an existing incident from the users organization. | -| `_get_incident` | `EXEC` | `incident_id, dd_site` | Get the details of an incident by `incident_id`. | -| `_list_incidents` | `EXEC` | `dd_site` | Get all incidents for the user's organization. | -| `_search_incidents` | `EXEC` | `query, dd_site` | Search for incidents matching a certain query. | -| `update_incident` | `EXEC` | `incident_id, data__data, dd_site` | Updates an incident. Provide only the attributes that should be updated as this request is a partial update. | +| | `SELECT` | | Get the details of an incident by `incident_id`. | +| | `SELECT` | | Get all incidents for the user's organization. | +| | `SELECT` | | Search for incidents matching a certain query. | +| | `INSERT` | | Create an incident. | +| | `DELETE` | | Deletes an existing incident from the users organization. | +| | `EXEC` | | Get the details of an incident by `incident_id`. | +| | `EXEC` | | Get all incidents for the user's organization. | +| | `EXEC` | | Search for incidents matching a certain query. | +| | `EXEC` | | Updates an incident. Provide only the attributes that should be updated as this request is a partial update. | diff --git a/docs/datadog-docs/providers/datadog/incidents/index.md b/docs/datadog-docs/providers/datadog/incidents/index.md index 6a6f5b5e59..657f96c917 100644 --- a/docs/datadog-docs/providers/datadog/incidents/index.md +++ b/docs/datadog-docs/providers/datadog/incidents/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Manage Incident Response. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/ip_allowlist/index.md b/docs/datadog-docs/providers/datadog/ip_allowlist/index.md index b09a9e03a9..3898ecc91c 100644 --- a/docs/datadog-docs/providers/datadog/ip_allowlist/index.md +++ b/docs/datadog-docs/providers/datadog/ip_allowlist/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + IP Allowlist :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/ip_allowlist/ip_allowlists/index.md b/docs/datadog-docs/providers/datadog/ip_allowlist/ip_allowlists/index.md index 245c400b44..21fefe5579 100644 --- a/docs/datadog-docs/providers/datadog/ip_allowlist/ip_allowlists/index.md +++ b/docs/datadog-docs/providers/datadog/ip_allowlist/ip_allowlists/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameip_allowlists
TypeResource
Iddatadog.ip_allowlist.ip_allowlists
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the org. | -| `attributes` | `object` | Attributes of the IP allowlist. | -| `type` | `string` | IP allowlist type. | +| | `string` | The unique identifier of the org. | +| | `object` | Attributes of the IP allowlist. | +| | `string` | IP allowlist type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_ip_allowlist` | `SELECT` | `dd_site` | Returns the IP allowlist and its enabled or disabled state. | -| `_get_ip_allowlist` | `EXEC` | `dd_site` | Returns the IP allowlist and its enabled or disabled state. | -| `update_ip_allowlist` | `EXEC` | `data__data, dd_site` | Edit the entries in the IP allowlist, and enable or disable it. | +| | `SELECT` | | Returns the IP allowlist and its enabled or disabled state. | +| | `EXEC` | | Returns the IP allowlist and its enabled or disabled state. | +| | `EXEC` | | Edit the entries in the IP allowlist, and enable or disable it. | diff --git a/docs/datadog-docs/providers/datadog/key_management/api_keys/index.md b/docs/datadog-docs/providers/datadog/key_management/api_keys/index.md index 8df5e613b7..e52ee735a1 100644 --- a/docs/datadog-docs/providers/datadog/key_management/api_keys/index.md +++ b/docs/datadog-docs/providers/datadog/key_management/api_keys/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapi_keys
TypeResource
Iddatadog.key_management.api_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the API key. | -| `attributes` | `object` | Attributes of a full API key. | -| `relationships` | `object` | Resources related to the API key. | -| `type` | `string` | API Keys resource type. | +| | `string` | ID of the API key. | +| | `object` | Attributes of a full API key. | +| | `object` | Resources related to the API key. | +| | `string` | API Keys resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_api_key` | `SELECT` | `api_key_id, dd_site` | Get an API key. | -| `list_api_keys` | `SELECT` | `dd_site` | List all API keys available for your account. | -| `create_api_key` | `INSERT` | `data__data, dd_site` | Create an API key. | -| `delete_api_key` | `DELETE` | `api_key_id, dd_site` | Delete an API key. | -| `_get_api_key` | `EXEC` | `api_key_id, dd_site` | Get an API key. | -| `_list_api_keys` | `EXEC` | `dd_site` | List all API keys available for your account. | -| `update_api_key` | `EXEC` | `api_key_id, data__data, dd_site` | Update an API key. | +| | `SELECT` | | Get an API key. | +| | `SELECT` | | List all API keys available for your account. | +| | `INSERT` | | Create an API key. | +| | `DELETE` | | Delete an API key. | +| | `EXEC` | | Get an API key. | +| | `EXEC` | | List all API keys available for your account. | +| | `EXEC` | | Update an API key. | diff --git a/docs/datadog-docs/providers/datadog/key_management/application_keys/index.md b/docs/datadog-docs/providers/datadog/key_management/application_keys/index.md index 7c7579e653..a704e28f97 100644 --- a/docs/datadog-docs/providers/datadog/key_management/application_keys/index.md +++ b/docs/datadog-docs/providers/datadog/key_management/application_keys/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapplication_keys
TypeResource
Iddatadog.key_management.application_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the application key. | -| `attributes` | `object` | Attributes of a full application key. | -| `relationships` | `object` | Resources related to the application key. | -| `type` | `string` | Application Keys resource type. | +| | `string` | ID of the application key. | +| | `object` | Attributes of a full application key. | +| | `object` | Resources related to the application key. | +| | `string` | Application Keys resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_application_key` | `SELECT` | `app_key_id, dd_site` | Get an application key for your org. | -| `list_application_keys` | `SELECT` | `dd_site` | List all application keys available for your org | -| `delete_application_key` | `DELETE` | `app_key_id, dd_site` | Delete an application key | -| `_get_application_key` | `EXEC` | `app_key_id, dd_site` | Get an application key for your org. | -| `_list_application_keys` | `EXEC` | `dd_site` | List all application keys available for your org | -| `update_application_key` | `EXEC` | `app_key_id, data__data, dd_site` | Edit an application key | +| | `SELECT` | | Get an application key for your org. | +| | `SELECT` | | List all application keys available for your org | +| | `DELETE` | | Delete an application key | +| | `EXEC` | | Get an application key for your org. | +| | `EXEC` | | List all application keys available for your org | +| | `EXEC` | | Edit an application key | diff --git a/docs/datadog-docs/providers/datadog/key_management/current_user_application_keys/index.md b/docs/datadog-docs/providers/datadog/key_management/current_user_application_keys/index.md index eda64a8dc0..002b6b3f9d 100644 --- a/docs/datadog-docs/providers/datadog/key_management/current_user_application_keys/index.md +++ b/docs/datadog-docs/providers/datadog/key_management/current_user_application_keys/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecurrent_user_application_keys
TypeResource
Iddatadog.key_management.current_user_application_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the application key. | -| `attributes` | `object` | Attributes of a full application key. | -| `relationships` | `object` | Resources related to the application key. | -| `type` | `string` | Application Keys resource type. | +| | `string` | ID of the application key. | +| | `object` | Attributes of a full application key. | +| | `object` | Resources related to the application key. | +| | `string` | Application Keys resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_current_user_application_key` | `SELECT` | `app_key_id, dd_site` | Get an application key owned by current user | -| `list_current_user_application_keys` | `SELECT` | `dd_site` | List all application keys available for current user | -| `create_current_user_application_key` | `INSERT` | `data__data, dd_site` | Create an application key for current user | -| `delete_current_user_application_key` | `DELETE` | `app_key_id, dd_site` | Delete an application key owned by current user | -| `_get_current_user_application_key` | `EXEC` | `app_key_id, dd_site` | Get an application key owned by current user | -| `_list_current_user_application_keys` | `EXEC` | `dd_site` | List all application keys available for current user | -| `update_current_user_application_key` | `EXEC` | `app_key_id, data__data, dd_site` | Edit an application key owned by current user | +| | `SELECT` | | Get an application key owned by current user | +| | `SELECT` | | List all application keys available for current user | +| | `INSERT` | | Create an application key for current user | +| | `DELETE` | | Delete an application key owned by current user | +| | `EXEC` | | Get an application key owned by current user | +| | `EXEC` | | List all application keys available for current user | +| | `EXEC` | | Edit an application key owned by current user | diff --git a/docs/datadog-docs/providers/datadog/key_management/index.md b/docs/datadog-docs/providers/datadog/key_management/index.md index 082bb06a9e..66b8653e32 100644 --- a/docs/datadog-docs/providers/datadog/key_management/index.md +++ b/docs/datadog-docs/providers/datadog/key_management/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Key Management :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/log_archives/archive_read_roles/index.md b/docs/datadog-docs/providers/datadog/log_archives/archive_read_roles/index.md index fe32796b18..f96864f79a 100644 --- a/docs/datadog-docs/providers/datadog/log_archives/archive_read_roles/index.md +++ b/docs/datadog-docs/providers/datadog/log_archives/archive_read_roles/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namearchive_read_roles
TypeResource
Iddatadog.log_archives.archive_read_roles
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the role. | -| `attributes` | `object` | Attributes of the role. | -| `relationships` | `object` | Relationships of the role object returned by the API. | -| `type` | `string` | Roles type. | +| | `string` | The unique identifier of the role. | +| | `object` | Attributes of the role. | +| | `object` | Relationships of the role object returned by the API. | +| | `string` | Roles type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_archive_read_roles` | `SELECT` | `archive_id, dd_site` | -| `_list_archive_read_roles` | `EXEC` | `archive_id, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/log_archives/index.md b/docs/datadog-docs/providers/datadog/log_archives/index.md index e501a2b6c2..61330bb43d 100644 --- a/docs/datadog-docs/providers/datadog/log_archives/index.md +++ b/docs/datadog-docs/providers/datadog/log_archives/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Logs Archives :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/log_archives/log_archive_orders/index.md b/docs/datadog-docs/providers/datadog/log_archives/log_archive_orders/index.md index e450b55f75..b5a3168b23 100644 --- a/docs/datadog-docs/providers/datadog/log_archives/log_archive_orders/index.md +++ b/docs/datadog-docs/providers/datadog/log_archives/log_archive_orders/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_archive_orders
TypeResource
Iddatadog.log_archives.log_archive_orders
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `attributes` | `object` | The attributes associated with the archive order. | -| `type` | `string` | Type of the archive order definition. | +| | `object` | The attributes associated with the archive order. | +| | `string` | Type of the archive order definition. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_logs_archive_order` | `SELECT` | `dd_site` | Get the current order of your archives.
This endpoint takes no JSON arguments. | -| `_get_logs_archive_order` | `EXEC` | `dd_site` | Get the current order of your archives.
This endpoint takes no JSON arguments. | -| `update_logs_archive_order` | `EXEC` | `dd_site` | Update the order of your archives. Since logs are processed sequentially, reordering an archive may change
the structure and content of the data processed by other archives.

**Note**: Using the `PUT` method updates your archive's order by replacing the current order
with the new one. | +| | `SELECT` | | Get the current order of your archives.
This endpoint takes no JSON arguments. | +| | `EXEC` | | Get the current order of your archives.
This endpoint takes no JSON arguments. | +| | `EXEC` | | Update the order of your archives. Since logs are processed sequentially, reordering an archive may change
the structure and content of the data processed by other archives.

**Note**: Using the `PUT` method updates your archive's order by replacing the current order
with the new one. | diff --git a/docs/datadog-docs/providers/datadog/log_archives/log_archives/index.md b/docs/datadog-docs/providers/datadog/log_archives/log_archives/index.md index 7d1cf4275a..7ce72d4e14 100644 --- a/docs/datadog-docs/providers/datadog/log_archives/log_archives/index.md +++ b/docs/datadog-docs/providers/datadog/log_archives/log_archives/index.md @@ -14,31 +14,34 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_archives
TypeResource
Iddatadog.log_archives.log_archives
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The archive ID. | -| `attributes` | `object` | The attributes associated with the archive. | -| `type` | `string` | The type of the resource. The value should always be archives. | +| | `string` | The archive ID. | +| | `object` | The attributes associated with the archive. | +| | `string` | The type of the resource. The value should always be archives. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_logs_archive` | `SELECT` | `archive_id, dd_site` | Get a specific archive from your organization. | -| `list_logs_archives` | `SELECT` | `dd_site` | Get the list of configured logs archives with their definitions. | -| `create_logs_archive` | `INSERT` | `dd_site` | Create an archive in your organization. | -| `delete_logs_archive` | `DELETE` | `archive_id, dd_site` | Delete a given archive from your organization. | -| `_get_logs_archive` | `EXEC` | `archive_id, dd_site` | Get a specific archive from your organization. | -| `_list_logs_archives` | `EXEC` | `dd_site` | Get the list of configured logs archives with their definitions. | -| `add_read_role_to_archive` | `EXEC` | `archive_id, dd_site` | Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) | -| `remove_role_from_archive` | `EXEC` | `archive_id, dd_site` | Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) | -| `update_logs_archive` | `EXEC` | `archive_id, dd_site` | Update a given archive configuration.

**Note**: Using this method updates your archive configuration by **replacing**
your current configuration with the new one sent to your Datadog organization. | +| | `SELECT` | | Get a specific archive from your organization. | +| | `SELECT` | | Get the list of configured logs archives with their definitions. | +| | `INSERT` | | Create an archive in your organization. | +| | `DELETE` | | Delete a given archive from your organization. | +| | `EXEC` | | Get a specific archive from your organization. | +| | `EXEC` | | Get the list of configured logs archives with their definitions. | +| | `EXEC` | | Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) | +| | `EXEC` | | Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) | +| | `EXEC` | | Update a given archive configuration.

**Note**: Using this method updates your archive configuration by **replacing**
your current configuration with the new one sent to your Datadog organization. | diff --git a/docs/datadog-docs/providers/datadog/log_metrics/index.md b/docs/datadog-docs/providers/datadog/log_metrics/index.md index 61a8bd2a33..d70d8a5af4 100644 --- a/docs/datadog-docs/providers/datadog/log_metrics/index.md +++ b/docs/datadog-docs/providers/datadog/log_metrics/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Logs Metrics :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/log_metrics/log_metrics/index.md b/docs/datadog-docs/providers/datadog/log_metrics/log_metrics/index.md index 5901d404e3..4bedc874db 100644 --- a/docs/datadog-docs/providers/datadog/log_metrics/log_metrics/index.md +++ b/docs/datadog-docs/providers/datadog/log_metrics/log_metrics/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_metrics
TypeResource
Iddatadog.log_metrics.log_metrics
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The name of the log-based metric. | -| `attributes` | `object` | The object describing a Datadog log-based metric. | -| `type` | `string` | The type of the resource. The value should always be logs_metrics. | +| | `string` | The name of the log-based metric. | +| | `object` | The object describing a Datadog log-based metric. | +| | `string` | The type of the resource. The value should always be logs_metrics. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_logs_metric` | `SELECT` | `metric_id, dd_site` | Get a specific log-based metric from your organization. | -| `list_logs_metrics` | `SELECT` | `dd_site` | Get the list of configured log-based metrics with their definitions. | -| `create_logs_metric` | `INSERT` | `data__data, dd_site` | Create a metric based on your ingested logs in your organization.
Returns the log-based metric object from the request body when the request is successful. | -| `delete_logs_metric` | `DELETE` | `metric_id, dd_site` | Delete a specific log-based metric from your organization. | -| `_get_logs_metric` | `EXEC` | `metric_id, dd_site` | Get a specific log-based metric from your organization. | -| `_list_logs_metrics` | `EXEC` | `dd_site` | Get the list of configured log-based metrics with their definitions. | -| `update_logs_metric` | `EXEC` | `metric_id, data__data, dd_site` | Update a specific log-based metric from your organization.
Returns the log-based metric object from the request body when the request is successful. | +| | `SELECT` | | Get a specific log-based metric from your organization. | +| | `SELECT` | | Get the list of configured log-based metrics with their definitions. | +| | `INSERT` | | Create a metric based on your ingested logs in your organization.
Returns the log-based metric object from the request body when the request is successful. | +| | `DELETE` | | Delete a specific log-based metric from your organization. | +| | `EXEC` | | Get a specific log-based metric from your organization. | +| | `EXEC` | | Get the list of configured log-based metrics with their definitions. | +| | `EXEC` | | Update a specific log-based metric from your organization.
Returns the log-based metric object from the request body when the request is successful. | diff --git a/docs/datadog-docs/providers/datadog/logs/index.md b/docs/datadog-docs/providers/datadog/logs/index.md index 9ad9daa0a3..198961fe82 100644 --- a/docs/datadog-docs/providers/datadog/logs/index.md +++ b/docs/datadog-docs/providers/datadog/logs/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Search Your Logs And Send Them To Your Datadog Platform Over HTTP. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/logs/log_search/index.md b/docs/datadog-docs/providers/datadog/logs/log_search/index.md index f3cb73a5b9..4e7eeb1ff7 100644 --- a/docs/datadog-docs/providers/datadog/logs/log_search/index.md +++ b/docs/datadog-docs/providers/datadog/logs/log_search/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelog_search
TypeResource
Iddatadog.logs.log_search
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the Log. | -| `attributes` | `object` | JSON object containing all log attributes and their associated values. | -| `type` | `string` | Type of the event. | +| | `string` | Unique ID of the Log. | +| | `object` | JSON object containing all log attributes and their associated values. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_logs_get` | `SELECT` | `dd_site` | -| `_list_logs_get` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/logs/logs/index.md b/docs/datadog-docs/providers/datadog/logs/logs/index.md index 9414c3ca80..4e7e061217 100644 --- a/docs/datadog-docs/providers/datadog/logs/logs/index.md +++ b/docs/datadog-docs/providers/datadog/logs/logs/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namelogs
TypeResource
Iddatadog.logs.logs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `array` | Array of logs matching the request. | -| `links` | `object` | Links attributes. | -| `meta` | `object` | The metadata associated with a request | +| | `array` | Array of logs matching the request. | +| | `object` | Links attributes. | +| | `object` | The metadata associated with a request | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_logs` | `SELECT` | `dd_site` | List endpoint returns logs that match a log search query.
[Results are paginated][1].

Use this endpoint to build complex logs filtering and search.

**If you are considering archiving logs for your organization,
consider use of the Datadog archive capabilities instead of the log list API.
See [Datadog Logs Archive documentation][2].**

[1]: /logs/guide/collect-multiple-logs-with-pagination
[2]: https://docs.datadoghq.com/logs/archives | -| `aggregate_logs` | `EXEC` | `dd_site` | The API endpoint to aggregate events into buckets and compute metrics and timeseries. | -| `submit_log` | `EXEC` | `dd_site` | Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:

- Maximum content size per payload (uncompressed): 5MB
- Maximum size for a single log: 1MB
- Maximum array size if sending multiple logs in an array: 1000 entries

Any log exceeding 1MB is accepted and truncated by Datadog:
- For a single log request, the API truncates the log at 1MB and returns a 2xx.
- For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.

Datadog recommends sending your logs compressed.
Add the `Content-Encoding: gzip` header to the request when sending compressed logs.
Log events can be submitted with a timestamp that is up to 18 hours in the past.

The status codes answered by the HTTP API are:
- 202: Accepted: the request has been accepted for processing
- 400: Bad request (likely an issue in the payload formatting)
- 401: Unauthorized (likely a missing API Key)
- 403: Permission issue (likely using an invalid API Key)
- 408: Request Timeout, request should be retried after some time
- 413: Payload too large (batch is above 5MB uncompressed)
- 429: Too Many Requests, request should be retried after some time
- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time
- 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time | +| | `SELECT` | | List endpoint returns logs that match a log search query.
[Results are paginated][1].

Use this endpoint to build complex logs filtering and search.

**If you are considering archiving logs for your organization,
consider use of the Datadog archive capabilities instead of the log list API.
See [Datadog Logs Archive documentation][2].**

[1]: /logs/guide/collect-multiple-logs-with-pagination
[2]: https://docs.datadoghq.com/logs/archives | +| | `EXEC` | | The API endpoint to aggregate events into buckets and compute metrics and timeseries. | +| | `EXEC` | | Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:

- Maximum content size per payload (uncompressed): 5MB
- Maximum size for a single log: 1MB
- Maximum array size if sending multiple logs in an array: 1000 entries

Any log exceeding 1MB is accepted and truncated by Datadog:
- For a single log request, the API truncates the log at 1MB and returns a 2xx.
- For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.

Datadog recommends sending your logs compressed.
Add the `Content-Encoding: gzip` header to the request when sending compressed logs.
Log events can be submitted with a timestamp that is up to 18 hours in the past.

The status codes answered by the HTTP API are:
- 202: Accepted: the request has been accepted for processing
- 400: Bad request (likely an issue in the payload formatting)
- 401: Unauthorized (likely a missing API Key)
- 403: Permission issue (likely using an invalid API Key)
- 408: Request Timeout, request should be retried after some time
- 413: Payload too large (batch is above 5MB uncompressed)
- 429: Too Many Requests, request should be retried after some time
- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time
- 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time | diff --git a/docs/datadog-docs/providers/datadog/metrics/active_metric_configurations/index.md b/docs/datadog-docs/providers/datadog/metrics/active_metric_configurations/index.md index e5967f10f1..b024562d55 100644 --- a/docs/datadog-docs/providers/datadog/metrics/active_metric_configurations/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/active_metric_configurations/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactive_metric_configurations
TypeResource
Iddatadog.metrics.active_metric_configurations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The metric name for this resource. | -| `attributes` | `object` | Object containing the definition of a metric's actively queried tags and aggregations. | -| `type` | `string` | The metric actively queried configuration resource type. | +| | `string` | The metric name for this resource. | +| | `object` | Object containing the definition of a metric's actively queried tags and aggregations. | +| | `string` | The metric actively queried configuration resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_active_metric_configurations` | `SELECT` | `metric_name, dd_site` | List tags and aggregations that are actively queried on dashboards and monitors for a given metric name. | -| `create_bulk_tags_metrics_configuration` | `INSERT` | `data__data, dd_site` | Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | -| `delete_bulk_tags_metrics_configuration` | `DELETE` | `data__data, dd_site` | Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | -| `_list_active_metric_configurations` | `EXEC` | `metric_name, dd_site` | List tags and aggregations that are actively queried on dashboards and monitors for a given metric name. | +| | `SELECT` | | List tags and aggregations that are actively queried on dashboards and monitors for a given metric name. | +| | `INSERT` | | Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | +| | `DELETE` | | Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix.
Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | +| | `EXEC` | | List tags and aggregations that are actively queried on dashboards and monitors for a given metric name. | diff --git a/docs/datadog-docs/providers/datadog/metrics/index.md b/docs/datadog-docs/providers/datadog/metrics/index.md index 2115fb2ddc..8cc6230d34 100644 --- a/docs/datadog-docs/providers/datadog/metrics/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + The Metrics Endpoint Allows You To: - Post Metrics Data So It Can Be Graphed On Datadog’S Dashboards diff --git a/docs/datadog-docs/providers/datadog/metrics/metrics/index.md b/docs/datadog-docs/providers/datadog/metrics/metrics/index.md index c3feb97d7d..1a3bec70a4 100644 --- a/docs/datadog-docs/providers/datadog/metrics/metrics/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/metrics/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics
TypeResource
Iddatadog.metrics.metrics
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `submit_metrics` | `EXEC` | `data__series, dd_site` | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/metrics_output_series/index.md b/docs/datadog-docs/providers/datadog/metrics/metrics_output_series/index.md index c6d61c7a74..d5debac4b4 100644 --- a/docs/datadog-docs/providers/datadog/metrics/metrics_output_series/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/metrics_output_series/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemetrics_output_series
TypeResource
Iddatadog.metrics.metrics_output_series
Id
## Fields @@ -29,5 +32,5 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `_estimate_metrics_output_series` | `EXEC` | `metric_name, dd_site` | -| `estimate_metrics_output_series` | `EXEC` | `metric_name, dd_site` | +| | `EXEC` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/scalar_data/index.md b/docs/datadog-docs/providers/datadog/metrics/scalar_data/index.md index 521139e3dd..1443968962 100644 --- a/docs/datadog-docs/providers/datadog/metrics/scalar_data/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/scalar_data/index.md @@ -14,22 +14,25 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescalar_data
TypeResource
Iddatadog.metrics.scalar_data
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `object` | A message containing the response to a scalar query. | -| `errors` | `string` | An error generated when processing a request. | +| | `object` | A message containing the response to a scalar query. | +| | `string` | An error generated when processing a request. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `query_scalar_data` | `SELECT` | `data__data, dd_site` | +| | `SELECT` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/tag_configuration_by_name/index.md b/docs/datadog-docs/providers/datadog/metrics/tag_configuration_by_name/index.md index cf6f9a5f36..d4c27c02da 100644 --- a/docs/datadog-docs/providers/datadog/metrics/tag_configuration_by_name/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/tag_configuration_by_name/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametag_configuration_by_name
TypeResource
Iddatadog.metrics.tag_configuration_by_name
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The metric name for this resource. | -| `attributes` | `object` | Object containing the definition of a metric tag configuration attributes. | -| `type` | `string` | The metric tag configuration resource type. | +| | `string` | The metric name for this resource. | +| | `object` | Object containing the definition of a metric tag configuration attributes. | +| | `string` | The metric tag configuration resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_tag_configuration_by_name` | `SELECT` | `metric_name, dd_site` | -| `_list_tag_configuration_by_name` | `EXEC` | `metric_name, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/tag_configurations/index.md b/docs/datadog-docs/providers/datadog/metrics/tag_configurations/index.md index 6ff682ad6d..7618050f3c 100644 --- a/docs/datadog-docs/providers/datadog/metrics/tag_configurations/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/tag_configurations/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametag_configurations
TypeResource
Iddatadog.metrics.tag_configurations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The metric name for this resource. | -| `MetricTagConfiguration_id` | `string` | The metric name for this resource. | -| `MetricTagConfiguration_type` | `string` | The metric tag configuration resource type. | -| `attributes` | `object` | Object containing the definition of a metric tag configuration attributes. | -| `type` | `string` | The metric resource type. | +| | `string` | The metric name for this resource. | +| | `string` | The metric name for this resource. | +| | `string` | The metric tag configuration resource type. | +| | `object` | Object containing the definition of a metric tag configuration attributes. | +| | `string` | The metric resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_tag_configurations` | `SELECT` | `dd_site` | Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified). | -| `create_tag_configuration` | `INSERT` | `metric_name, data__data, dd_site` | Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | -| `delete_tag_configuration` | `DELETE` | `metric_name, dd_site` | Deletes a metric's tag configuration. Can only be used with application
keys from users with the `Manage Tags for Metrics` permission. | -| `_list_tag_configurations` | `EXEC` | `dd_site` | Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified). | -| `update_tag_configuration` | `EXEC` | `metric_name, data__data, dd_site` | Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires
a tag configuration to be created first. | +| | `SELECT` | | Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified). | +| | `INSERT` | | Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys of users with the `Manage Tags for Metrics` permission. | +| | `DELETE` | | Deletes a metric's tag configuration. Can only be used with application
keys from users with the `Manage Tags for Metrics` permission. | +| | `EXEC` | | Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified). | +| | `EXEC` | | Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires
a tag configuration to be created first. | diff --git a/docs/datadog-docs/providers/datadog/metrics/tags_by_metric_names/index.md b/docs/datadog-docs/providers/datadog/metrics/tags_by_metric_names/index.md index 4b572911dc..a0f5aee2d6 100644 --- a/docs/datadog-docs/providers/datadog/metrics/tags_by_metric_names/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/tags_by_metric_names/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametags_by_metric_names
TypeResource
Iddatadog.metrics.tags_by_metric_names
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The metric name for this resource. | -| `attributes` | `object` | Object containing the definition of a metric's tags. | -| `type` | `string` | The metric resource type. | +| | `string` | The metric name for this resource. | +| | `object` | Object containing the definition of a metric's tags. | +| | `string` | The metric resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_tags_by_metric_name` | `SELECT` | `metric_name, dd_site` | -| `_list_tags_by_metric_name` | `EXEC` | `metric_name, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/timeseries_data/index.md b/docs/datadog-docs/providers/datadog/metrics/timeseries_data/index.md index 234e3b95f4..ba17381b5a 100644 --- a/docs/datadog-docs/providers/datadog/metrics/timeseries_data/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/timeseries_data/index.md @@ -14,22 +14,25 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nametimeseries_data
TypeResource
Iddatadog.metrics.timeseries_data
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `object` | A message containing the response to a timeseries query. | -| `errors` | `string` | The error generated by the request. | +| | `object` | A message containing the response to a timeseries query. | +| | `string` | The error generated by the request. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `query_timeseries_data` | `SELECT` | `data__data, dd_site` | +| | `SELECT` | | diff --git a/docs/datadog-docs/providers/datadog/metrics/volumes_by_metric_name/index.md b/docs/datadog-docs/providers/datadog/metrics/volumes_by_metric_name/index.md index 6e79c9e297..3c899a7bef 100644 --- a/docs/datadog-docs/providers/datadog/metrics/volumes_by_metric_name/index.md +++ b/docs/datadog-docs/providers/datadog/metrics/volumes_by_metric_name/index.md @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevolumes_by_metric_name
TypeResource
Iddatadog.metrics.volumes_by_metric_name
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The metric name for this resource. | -| `MetricIngestedIndexedVolume_attributes` | `object` | Object containing the definition of a metric's ingested and indexed volume. | -| `MetricIngestedIndexedVolume_id` | `string` | The metric name for this resource. | -| `MetricIngestedIndexedVolume_type` | `string` | The metric ingested and indexed volume type. | -| `attributes` | `object` | Object containing the definition of a metric's distinct volume. | -| `type` | `string` | The metric distinct volume type. | +| | `string` | The metric name for this resource. | +| | `object` | Object containing the definition of a metric's ingested and indexed volume. | +| | `string` | The metric name for this resource. | +| | `string` | The metric ingested and indexed volume type. | +| | `object` | Object containing the definition of a metric's distinct volume. | +| | `string` | The metric distinct volume type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_volumes_by_metric_name` | `SELECT` | `metric_name, dd_site` | -| `_list_volumes_by_metric_name` | `EXEC` | `metric_name, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/monitors/index.md b/docs/datadog-docs/providers/datadog/monitors/index.md index 5a39eefe29..1bfb7ca93f 100644 --- a/docs/datadog-docs/providers/datadog/monitors/index.md +++ b/docs/datadog-docs/providers/datadog/monitors/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + [Monitors](Https://Docs.Datadoghq.Com/Monitors) Allow You To Watch A Metric Or Check That You Care About And Notifies Your Team When A Defined Threshold Has Exceeded. diff --git a/docs/datadog-docs/providers/datadog/monitors/monitor_config_policies/index.md b/docs/datadog-docs/providers/datadog/monitors/monitor_config_policies/index.md index 49022bc19c..c1ce388503 100644 --- a/docs/datadog-docs/providers/datadog/monitors/monitor_config_policies/index.md +++ b/docs/datadog-docs/providers/datadog/monitors/monitor_config_policies/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemonitor_config_policies
TypeResource
Iddatadog.monitors.monitor_config_policies
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of this monitor configuration policy. | -| `attributes` | `object` | Policy and policy type for a monitor configuration policy. | -| `type` | `string` | Monitor configuration policy resource type. | +| | `string` | ID of this monitor configuration policy. | +| | `object` | Policy and policy type for a monitor configuration policy. | +| | `string` | Monitor configuration policy resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_monitor_config_policy` | `SELECT` | `policy_id, dd_site` | Get a monitor configuration policy by `policy_id`. | -| `list_monitor_config_policies` | `SELECT` | `dd_site` | Get all monitor configuration policies. | -| `create_monitor_config_policy` | `INSERT` | `data__data, dd_site` | Create a monitor configuration policy. | -| `delete_monitor_config_policy` | `DELETE` | `policy_id, dd_site` | Delete a monitor configuration policy. | -| `_get_monitor_config_policy` | `EXEC` | `policy_id, dd_site` | Get a monitor configuration policy by `policy_id`. | -| `_list_monitor_config_policies` | `EXEC` | `dd_site` | Get all monitor configuration policies. | -| `update_monitor_config_policy` | `EXEC` | `policy_id, data__data, dd_site` | Edit a monitor configuration policy. | +| | `SELECT` | | Get a monitor configuration policy by `policy_id`. | +| | `SELECT` | | Get all monitor configuration policies. | +| | `INSERT` | | Create a monitor configuration policy. | +| | `DELETE` | | Delete a monitor configuration policy. | +| | `EXEC` | | Get a monitor configuration policy by `policy_id`. | +| | `EXEC` | | Get all monitor configuration policies. | +| | `EXEC` | | Edit a monitor configuration policy. | diff --git a/docs/datadog-docs/providers/datadog/okta_integration/index.md b/docs/datadog-docs/providers/datadog/okta_integration/index.md index 5a9782d969..a984ec9fd5 100644 --- a/docs/datadog-docs/providers/datadog/okta_integration/index.md +++ b/docs/datadog-docs/providers/datadog/okta_integration/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Okta Integration :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/okta_integration/okta_accounts/index.md b/docs/datadog-docs/providers/datadog/okta_integration/okta_accounts/index.md index 906f07b844..38c35e6b19 100644 --- a/docs/datadog-docs/providers/datadog/okta_integration/okta_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/okta_integration/okta_accounts/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameokta_accounts
TypeResource
Iddatadog.okta_integration.okta_accounts
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Okta account, a UUID hash of the account name. | -| `attributes` | `object` | Attributes object for an Okta account. | -| `type` | `string` | Account type for an Okta account. | +| | `string` | The ID of the Okta account, a UUID hash of the account name. | +| | `object` | Attributes object for an Okta account. | +| | `string` | Account type for an Okta account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_okta_account` | `SELECT` | `account_id, dd_site` | Get an Okta account. | -| `list_okta_accounts` | `SELECT` | `dd_site` | List Okta accounts. | -| `create_okta_account` | `INSERT` | `data__data, dd_site` | Create an Okta account. | -| `delete_okta_account` | `DELETE` | `account_id, dd_site` | Delete an Okta account. | -| `_get_okta_account` | `EXEC` | `account_id, dd_site` | Get an Okta account. | -| `_list_okta_accounts` | `EXEC` | `dd_site` | List Okta accounts. | -| `update_okta_account` | `EXEC` | `account_id, data__data, dd_site` | Update an Okta account. | +| | `SELECT` | | Get an Okta account. | +| | `SELECT` | | List Okta accounts. | +| | `INSERT` | | Create an Okta account. | +| | `DELETE` | | Delete an Okta account. | +| | `EXEC` | | Get an Okta account. | +| | `EXEC` | | List Okta accounts. | +| | `EXEC` | | Update an Okta account. | diff --git a/docs/datadog-docs/providers/datadog/opsgenie_integration/index.md b/docs/datadog-docs/providers/datadog/opsgenie_integration/index.md index 1925f5ed3b..d9edf46baf 100644 --- a/docs/datadog-docs/providers/datadog/opsgenie_integration/index.md +++ b/docs/datadog-docs/providers/datadog/opsgenie_integration/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Opsgenie Integration :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/opsgenie_integration/opsgenie_services/index.md b/docs/datadog-docs/providers/datadog/opsgenie_integration/opsgenie_services/index.md index 9cd3ebec92..7719683341 100644 --- a/docs/datadog-docs/providers/datadog/opsgenie_integration/opsgenie_services/index.md +++ b/docs/datadog-docs/providers/datadog/opsgenie_integration/opsgenie_services/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameopsgenie_services
TypeResource
Iddatadog.opsgenie_integration.opsgenie_services
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the Opsgenie service. | -| `attributes` | `object` | The attributes from an Opsgenie service response. | -| `type` | `string` | Opsgenie service resource type. | +| | `string` | The ID of the Opsgenie service. | +| | `object` | The attributes from an Opsgenie service response. | +| | `string` | Opsgenie service resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_opsgenie_service` | `SELECT` | `integration_service_id, dd_site` | Get a single service from the Datadog Opsgenie integration. | -| `list_opsgenie_services` | `SELECT` | `dd_site` | Get a list of all services from the Datadog Opsgenie integration. | -| `create_opsgenie_service` | `INSERT` | `data__data, dd_site` | Create a new service object in the Opsgenie integration. | -| `delete_opsgenie_service` | `DELETE` | `integration_service_id, dd_site` | Delete a single service object in the Datadog Opsgenie integration. | -| `_get_opsgenie_service` | `EXEC` | `integration_service_id, dd_site` | Get a single service from the Datadog Opsgenie integration. | -| `_list_opsgenie_services` | `EXEC` | `dd_site` | Get a list of all services from the Datadog Opsgenie integration. | -| `update_opsgenie_service` | `EXEC` | `integration_service_id, data__data, dd_site` | Update a single service object in the Datadog Opsgenie integration. | +| | `SELECT` | | Get a single service from the Datadog Opsgenie integration. | +| | `SELECT` | | Get a list of all services from the Datadog Opsgenie integration. | +| | `INSERT` | | Create a new service object in the Opsgenie integration. | +| | `DELETE` | | Delete a single service object in the Datadog Opsgenie integration. | +| | `EXEC` | | Get a single service from the Datadog Opsgenie integration. | +| | `EXEC` | | Get a list of all services from the Datadog Opsgenie integration. | +| | `EXEC` | | Update a single service object in the Datadog Opsgenie integration. | diff --git a/docs/datadog-docs/providers/datadog/organizations/idp_metadata/index.md b/docs/datadog-docs/providers/datadog/organizations/idp_metadata/index.md index ec9806b1db..b04dd65294 100644 --- a/docs/datadog-docs/providers/datadog/organizations/idp_metadata/index.md +++ b/docs/datadog-docs/providers/datadog/organizations/idp_metadata/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameidp_metadata
TypeResource
Iddatadog.organizations.idp_metadata
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `uploadidp_metadata` | `EXEC` | `dd_site` | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/organizations/index.md b/docs/datadog-docs/providers/datadog/organizations/index.md index 8a6eff0579..3bfc3eb11a 100644 --- a/docs/datadog-docs/providers/datadog/organizations/index.md +++ b/docs/datadog-docs/providers/datadog/organizations/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Create, Edit, And Manage Your Organizations. Read More About [Multi-Org Accounts](Https://Docs.Datadoghq.Com/Account Management/Multi Organization). :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/powerpack/index.md b/docs/datadog-docs/providers/datadog/powerpack/index.md index 02699de42d..d9d58b7352 100644 --- a/docs/datadog-docs/providers/datadog/powerpack/index.md +++ b/docs/datadog-docs/providers/datadog/powerpack/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + The Powerpack Endpoints Allow You To: - Get A Powerpack diff --git a/docs/datadog-docs/providers/datadog/powerpack/powerpacks/index.md b/docs/datadog-docs/providers/datadog/powerpack/powerpacks/index.md index 0e233b0b3f..57a97588cb 100644 --- a/docs/datadog-docs/providers/datadog/powerpack/powerpacks/index.md +++ b/docs/datadog-docs/providers/datadog/powerpack/powerpacks/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepowerpacks
TypeResource
Iddatadog.powerpack.powerpacks
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the powerpack. | -| `attributes` | `object` | Powerpack attribute object. | -| `relationships` | `object` | Powerpack relationship object. | -| `type` | `string` | Type of widget, must be powerpack. | +| | `string` | ID of the powerpack. | +| | `object` | Powerpack attribute object. | +| | `object` | Powerpack relationship object. | +| | `string` | Type of widget, must be powerpack. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_powerpack` | `SELECT` | `powerpack_id, dd_site` | Get a powerpack. | -| `list_powerpacks` | `SELECT` | `dd_site` | Get a list of all powerpacks. | -| `create_powerpack` | `INSERT` | `dd_site` | Create a powerpack. | -| `delete_powerpack` | `DELETE` | `powerpack_id, dd_site` | Delete a powerpack. | -| `_get_powerpack` | `EXEC` | `powerpack_id, dd_site` | Get a powerpack. | -| `_list_powerpacks` | `EXEC` | `dd_site` | Get a list of all powerpacks. | -| `update_powerpack` | `EXEC` | `powerpack_id, dd_site` | Update a powerpack. | +| | `SELECT` | | Get a powerpack. | +| | `SELECT` | | Get a list of all powerpacks. | +| | `INSERT` | | Create a powerpack. | +| | `DELETE` | | Delete a powerpack. | +| | `EXEC` | | Get a powerpack. | +| | `EXEC` | | Get a list of all powerpacks. | +| | `EXEC` | | Update a powerpack. | diff --git a/docs/datadog-docs/providers/datadog/processes/index.md b/docs/datadog-docs/providers/datadog/processes/index.md index c05e268585..17572d64ec 100644 --- a/docs/datadog-docs/providers/datadog/processes/index.md +++ b/docs/datadog-docs/providers/datadog/processes/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + The Processes API Allows You To Query Processes Data For Your Organization. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/processes/processes/index.md b/docs/datadog-docs/providers/datadog/processes/processes/index.md index 0e974b4438..3229697353 100644 --- a/docs/datadog-docs/providers/datadog/processes/processes/index.md +++ b/docs/datadog-docs/providers/datadog/processes/processes/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprocesses
TypeResource
Iddatadog.processes.processes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Process ID. | -| `attributes` | `object` | Attributes for a process summary. | -| `type` | `string` | Type of process summary. | +| | `string` | Process ID. | +| | `object` | Attributes for a process summary. | +| | `string` | Type of process summary. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_processes` | `SELECT` | `dd_site` | -| `_list_processes` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/restriction_policies/index.md b/docs/datadog-docs/providers/datadog/restriction_policies/index.md index 289b84853d..2b8b99cdbc 100644 --- a/docs/datadog-docs/providers/datadog/restriction_policies/index.md +++ b/docs/datadog-docs/providers/datadog/restriction_policies/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Restriction Policies :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/restriction_policies/restriction_policies/index.md b/docs/datadog-docs/providers/datadog/restriction_policies/restriction_policies/index.md index 18e0876106..128b953430 100644 --- a/docs/datadog-docs/providers/datadog/restriction_policies/restriction_policies/index.md +++ b/docs/datadog-docs/providers/datadog/restriction_policies/restriction_policies/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerestriction_policies
TypeResource
Iddatadog.restriction_policies.restriction_policies
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The identifier, always equivalent to the value specified in the `resource_id` path parameter. | -| `attributes` | `object` | Restriction policy attributes. | -| `type` | `string` | Restriction policy type. | +| | `string` | The identifier, always equivalent to the value specified in the `resource_id` path parameter. | +| | `object` | Restriction policy attributes. | +| | `string` | Restriction policy type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_restriction_policy` | `SELECT` | `resource_id, dd_site` | Retrieves the restriction policy associated with a specified resource. | -| `delete_restriction_policy` | `DELETE` | `resource_id, dd_site` | Deletes the restriction policy associated with a specified resource. | -| `_get_restriction_policy` | `EXEC` | `resource_id, dd_site` | Retrieves the restriction policy associated with a specified resource. | -| `update_restriction_policy` | `EXEC` | `resource_id, data__data, dd_site` | Updates the restriction policy associated with a resource.

#### Supported resources
Restriction policies can be applied to the following resources:
- Connections: `connection`
- Dashboards: `dashboard`
- Notebooks: `notebook`
- Security Rules: `security-rule`
- Service Level Objectives: `slo`

#### Supported relations for resources
Resource Type \| Supported Relations
-------------------------\|--------------------------
Connections \| `viewer`, `editor`, `resolver`
Dashboards \| `viewer`, `editor`
Notebooks \| `viewer`, `editor`
Security Rules \| `viewer`, `editor`
Service Level Objectives \| `viewer`, `editor` | +| | `SELECT` | | Retrieves the restriction policy associated with a specified resource. | +| | `DELETE` | | Deletes the restriction policy associated with a specified resource. | +| | `EXEC` | | Retrieves the restriction policy associated with a specified resource. | +| | `EXEC` | | Updates the restriction policy associated with a resource.

#### Supported resources
Restriction policies can be applied to the following resources:
- Connections: `connection`
- Dashboards: `dashboard`
- Notebooks: `notebook`
- Security Rules: `security-rule`
- Service Level Objectives: `slo`

#### Supported relations for resources
Resource Type \| Supported Relations
-------------------------\|--------------------------
Connections \| `viewer`, `editor`, `resolver`
Dashboards \| `viewer`, `editor`
Notebooks \| `viewer`, `editor`
Security Rules \| `viewer`, `editor`
Service Level Objectives \| `viewer`, `editor` | diff --git a/docs/datadog-docs/providers/datadog/roles/index.md b/docs/datadog-docs/providers/datadog/roles/index.md index 63646fa226..4b7a257474 100644 --- a/docs/datadog-docs/providers/datadog/roles/index.md +++ b/docs/datadog-docs/providers/datadog/roles/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + The Roles API Is Used To Create And Manage Datadog Roles, What [Global Permissions](Https://Docs.Datadoghq.Com/Account Management/Rbac/) They Grant, And Which Users Belong To Them. diff --git a/docs/datadog-docs/providers/datadog/roles/permissions/index.md b/docs/datadog-docs/providers/datadog/roles/permissions/index.md index 7da88fe497..3472bb36bb 100644 --- a/docs/datadog-docs/providers/datadog/roles/permissions/index.md +++ b/docs/datadog-docs/providers/datadog/roles/permissions/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namepermissions
TypeResource
Iddatadog.roles.permissions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the permission. | -| `attributes` | `object` | Attributes of a permission. | -| `type` | `string` | Permissions resource type. | +| | `string` | ID of the permission. | +| | `object` | Attributes of a permission. | +| | `string` | Permissions resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_permissions` | `SELECT` | `dd_site` | -| `_list_permissions` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/roles/role_permissions/index.md b/docs/datadog-docs/providers/datadog/roles/role_permissions/index.md index 8f64ce8fce..77474fb30a 100644 --- a/docs/datadog-docs/providers/datadog/roles/role_permissions/index.md +++ b/docs/datadog-docs/providers/datadog/roles/role_permissions/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerole_permissions
TypeResource
Iddatadog.roles.role_permissions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the permission. | -| `attributes` | `object` | Attributes of a permission. | -| `type` | `string` | Permissions resource type. | +| | `string` | ID of the permission. | +| | `object` | Attributes of a permission. | +| | `string` | Permissions resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_role_permissions` | `SELECT` | `role_id, dd_site` | Returns a list of all permissions for a single role. | -| `remove_permission_from_role` | `DELETE` | `role_id, dd_site` | Removes a permission from a role. | -| `_list_role_permissions` | `EXEC` | `role_id, dd_site` | Returns a list of all permissions for a single role. | -| `add_permission_to_role` | `EXEC` | `role_id, dd_site` | Adds a permission to a role. | +| | `SELECT` | | Returns a list of all permissions for a single role. | +| | `DELETE` | | Removes a permission from a role. | +| | `EXEC` | | Returns a list of all permissions for a single role. | +| | `EXEC` | | Adds a permission to a role. | diff --git a/docs/datadog-docs/providers/datadog/roles/role_users/index.md b/docs/datadog-docs/providers/datadog/roles/role_users/index.md index 7a50577953..84b80bd667 100644 --- a/docs/datadog-docs/providers/datadog/roles/role_users/index.md +++ b/docs/datadog-docs/providers/datadog/roles/role_users/index.md @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namerole_users
TypeResource
Iddatadog.roles.role_users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the user. | -| `attributes` | `object` | Attributes of user object returned by the API. | -| `relationships` | `object` | Relationships of the user object returned by the API. | -| `type` | `string` | Users resource type. | +| | `string` | ID of the user. | +| | `object` | Attributes of user object returned by the API. | +| | `object` | Relationships of the user object returned by the API. | +| | `string` | Users resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_role_users` | `SELECT` | `role_id, dd_site` | Gets all users of a role. | -| `remove_user_from_role` | `DELETE` | `role_id, data__data, dd_site` | Removes a user from a role. | -| `_list_role_users` | `EXEC` | `role_id, dd_site` | Gets all users of a role. | -| `add_user_to_role` | `EXEC` | `role_id, data__data, dd_site` | Adds a user to a role. | +| | `SELECT` | | Gets all users of a role. | +| | `DELETE` | | Removes a user from a role. | +| | `EXEC` | | Gets all users of a role. | +| | `EXEC` | | Adds a user to a role. | diff --git a/docs/datadog-docs/providers/datadog/roles/roles/index.md b/docs/datadog-docs/providers/datadog/roles/roles/index.md index 1868b2315d..6aa3ed648c 100644 --- a/docs/datadog-docs/providers/datadog/roles/roles/index.md +++ b/docs/datadog-docs/providers/datadog/roles/roles/index.md @@ -14,31 +14,34 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameroles
TypeResource
Iddatadog.roles.roles
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique identifier of the role. | -| `attributes` | `object` | Attributes of the role. | -| `relationships` | `object` | Relationships of the role object returned by the API. | -| `type` | `string` | Roles type. | +| | `string` | The unique identifier of the role. | +| | `object` | Attributes of the role. | +| | `object` | Relationships of the role object returned by the API. | +| | `string` | Roles type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_role` | `SELECT` | `role_id, dd_site` | Get a role in the organization specified by the role’s `role_id`. | -| `list_roles` | `SELECT` | `dd_site` | Returns all roles, including their names and their unique identifiers. | -| `create_role` | `INSERT` | `data__data, dd_site` | Create a new role for your organization. | -| `delete_role` | `DELETE` | `role_id, dd_site` | Disables a role. | -| `_get_role` | `EXEC` | `role_id, dd_site` | Get a role in the organization specified by the role’s `role_id`. | -| `_list_roles` | `EXEC` | `dd_site` | Returns all roles, including their names and their unique identifiers. | -| `clone_role` | `EXEC` | `role_id, data__data, dd_site` | Clone an existing role | -| `update_role` | `EXEC` | `role_id, data__data, dd_site` | Edit a role. Can only be used with application keys belonging to administrators. | +| | `SELECT` | | Get a role in the organization specified by the role’s `role_id`. | +| | `SELECT` | | Returns all roles, including their names and their unique identifiers. | +| | `INSERT` | | Create a new role for your organization. | +| | `DELETE` | | Disables a role. | +| | `EXEC` | | Get a role in the organization specified by the role’s `role_id`. | +| | `EXEC` | | Returns all roles, including their names and their unique identifiers. | +| | `EXEC` | | Clone an existing role | +| | `EXEC` | | Edit a role. Can only be used with application keys belonging to administrators. | diff --git a/docs/datadog-docs/providers/datadog/rum/applications/index.md b/docs/datadog-docs/providers/datadog/rum/applications/index.md index 06b0fbf676..4a2f35303a 100644 --- a/docs/datadog-docs/providers/datadog/rum/applications/index.md +++ b/docs/datadog-docs/providers/datadog/rum/applications/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameapplications
TypeResource
Iddatadog.rum.applications
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | RUM application ID. | -| `attributes` | `object` | RUM application attributes. | -| `type` | `string` | RUM application response type. | +| | `string` | RUM application ID. | +| | `object` | RUM application attributes. | +| | `string` | RUM application response type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_rum_application` | `SELECT` | `id, dd_site` | Get the RUM application with given ID in your organization. | -| `get_rum_applications` | `SELECT` | `dd_site` | List all the RUM applications in your organization. | -| `create_rum_application` | `INSERT` | `data__data, dd_site` | Create a new RUM application in your organization. | -| `delete_rum_application` | `DELETE` | `id, dd_site` | Delete an existing RUM application in your organization. | -| `_get_rum_application` | `EXEC` | `id, dd_site` | Get the RUM application with given ID in your organization. | -| `_get_rum_applications` | `EXEC` | `dd_site` | List all the RUM applications in your organization. | -| `update_rum_application` | `EXEC` | `id, data__data, dd_site` | Update the RUM application with given ID in your organization. | +| | `SELECT` | | Get the RUM application with given ID in your organization. | +| | `SELECT` | | List all the RUM applications in your organization. | +| | `INSERT` | | Create a new RUM application in your organization. | +| | `DELETE` | | Delete an existing RUM application in your organization. | +| | `EXEC` | | Get the RUM application with given ID in your organization. | +| | `EXEC` | | List all the RUM applications in your organization. | +| | `EXEC` | | Update the RUM application with given ID in your organization. | diff --git a/docs/datadog-docs/providers/datadog/rum/events/index.md b/docs/datadog-docs/providers/datadog/rum/events/index.md index 2a5270e789..28ca0909e5 100644 --- a/docs/datadog-docs/providers/datadog/rum/events/index.md +++ b/docs/datadog-docs/providers/datadog/rum/events/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameevents
TypeResource
Iddatadog.rum.events
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the event. | -| `attributes` | `object` | JSON object containing all event attributes and their associated values. | -| `type` | `string` | Type of the event. | +| | `string` | Unique ID of the event. | +| | `object` | JSON object containing all event attributes and their associated values. | +| | `string` | Type of the event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_rum_events` | `SELECT` | `dd_site` | List endpoint returns events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to see your latest RUM events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | -| `_list_rum_events` | `EXEC` | `dd_site` | List endpoint returns events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to see your latest RUM events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | -| `aggregate_rum_events` | `EXEC` | `dd_site` | The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries. | -| `search_rum_events` | `EXEC` | `dd_site` | List endpoint returns RUM events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to build complex RUM events filtering and search.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `SELECT` | | List endpoint returns events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to see your latest RUM events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `EXEC` | | List endpoint returns events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to see your latest RUM events.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | +| | `EXEC` | | The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries. | +| | `EXEC` | | List endpoint returns RUM events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to build complex RUM events filtering and search.

[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination | diff --git a/docs/datadog-docs/providers/datadog/rum/index.md b/docs/datadog-docs/providers/datadog/rum/index.md index 94c9f8ad9d..bd198f692d 100644 --- a/docs/datadog-docs/providers/datadog/rum/index.md +++ b/docs/datadog-docs/providers/datadog/rum/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Search Or Aggregate Your RUM Events Over HTTP. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/security_monitoring/findings/index.md b/docs/datadog-docs/providers/datadog/security_monitoring/findings/index.md index 82ce047771..918d23b1de 100644 --- a/docs/datadog-docs/providers/datadog/security_monitoring/findings/index.md +++ b/docs/datadog-docs/providers/datadog/security_monitoring/findings/index.md @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namefindings
TypeResource
Iddatadog.security_monitoring.findings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID for this finding. | -| `attributes` | `object` | The JSON:API attributes of the detailed finding. | -| `type` | `string` | The JSON:API type for findings that have the message and resource configuration. | +| | `string` | The unique ID for this finding. | +| | `object` | The JSON:API attributes of the detailed finding. | +| | `string` | The JSON:API type for findings that have the message and resource configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_finding` | `SELECT` | `finding_id, dd_site` | Returns a single finding with message and resource configuration. | -| `list_findings` | `SELECT` | `dd_site` | Get a list of CSPM findings.

### Filtering

Filters can be applied by appending query parameters to the URL.

- Using a single filter: `?filter[attribute_key]=attribute_value`
- Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`
- Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`

Here, `attribute_key` can be any of the filter keys described further below.

Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.

You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.

The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.

Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.

### Response

The response includes an array of finding objects, pagination metadata, and a count of items that match the query.

Each finding object contains the following:

- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.
- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
- `evaluation_changed_at` and `resource_discovery_date` time stamps.
- An array of associated tags.
| -| `_get_finding` | `EXEC` | `finding_id, dd_site` | Returns a single finding with message and resource configuration. | -| `_list_findings` | `EXEC` | `dd_site` | Get a list of CSPM findings.

### Filtering

Filters can be applied by appending query parameters to the URL.

- Using a single filter: `?filter[attribute_key]=attribute_value`
- Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`
- Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`

Here, `attribute_key` can be any of the filter keys described further below.

Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.

You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.

The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.

Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.

### Response

The response includes an array of finding objects, pagination metadata, and a count of items that match the query.

Each finding object contains the following:

- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.
- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
- `evaluation_changed_at` and `resource_discovery_date` time stamps.
- An array of associated tags.
| -| `mute_findings` | `EXEC` | `data__data, dd_site` | Mute or unmute findings. | +| | `SELECT` | | Returns a single finding with message and resource configuration. | +| | `SELECT` | | Get a list of CSPM findings.

### Filtering

Filters can be applied by appending query parameters to the URL.

- Using a single filter: `?filter[attribute_key]=attribute_value`
- Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`
- Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`

Here, `attribute_key` can be any of the filter keys described further below.

Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.

You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.

The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.

Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.

### Response

The response includes an array of finding objects, pagination metadata, and a count of items that match the query.

Each finding object contains the following:

- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.
- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
- `evaluation_changed_at` and `resource_discovery_date` time stamps.
- An array of associated tags.
| +| | `EXEC` | | Returns a single finding with message and resource configuration. | +| | `EXEC` | | Get a list of CSPM findings.

### Filtering

Filters can be applied by appending query parameters to the URL.

- Using a single filter: `?filter[attribute_key]=attribute_value`
- Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`
- Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`

Here, `attribute_key` can be any of the filter keys described further below.

Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.

You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.

The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.

Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.

### Response

The response includes an array of finding objects, pagination metadata, and a count of items that match the query.

Each finding object contains the following:

- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.
- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
- `evaluation_changed_at` and `resource_discovery_date` time stamps.
- An array of associated tags.
| +| | `EXEC` | | Mute or unmute findings. | diff --git a/docs/datadog-docs/providers/datadog/security_monitoring/index.md b/docs/datadog-docs/providers/datadog/security_monitoring/index.md index 5f6da04263..965dc83cf5 100644 --- a/docs/datadog-docs/providers/datadog/security_monitoring/index.md +++ b/docs/datadog-docs/providers/datadog/security_monitoring/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Security Monitoring :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/security_monitoring/security_filters/index.md b/docs/datadog-docs/providers/datadog/security_monitoring/security_filters/index.md index 0edb199d1c..beda96763f 100644 --- a/docs/datadog-docs/providers/datadog/security_monitoring/security_filters/index.md +++ b/docs/datadog-docs/providers/datadog/security_monitoring/security_filters/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesecurity_filters
TypeResource
Iddatadog.security_monitoring.security_filters
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the security filter. | -| `attributes` | `object` | The object describing a security filter. | -| `type` | `string` | The type of the resource. The value should always be `security_filters`. | +| | `string` | The ID of the security filter. | +| | `object` | The object describing a security filter. | +| | `string` | The type of the resource. The value should always be `security_filters`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_security_filter` | `SELECT` | `security_filter_id, dd_site` | Get the details of a specific security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | -| `list_security_filters` | `SELECT` | `dd_site` | Get the list of configured security filters with their definitions. | -| `create_security_filter` | `INSERT` | `data__data, dd_site` | Create a security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | -| `delete_security_filter` | `DELETE` | `security_filter_id, dd_site` | Delete a specific security filter. | -| `_get_security_filter` | `EXEC` | `security_filter_id, dd_site` | Get the details of a specific security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | -| `_list_security_filters` | `EXEC` | `dd_site` | Get the list of configured security filters with their definitions. | -| `update_security_filter` | `EXEC` | `security_filter_id, data__data, dd_site` | Update a specific security filter.
Returns the security filter object when the request is successful. | +| | `SELECT` | | Get the details of a specific security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | +| | `SELECT` | | Get the list of configured security filters with their definitions. | +| | `INSERT` | | Create a security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | +| | `DELETE` | | Delete a specific security filter. | +| | `EXEC` | | Get the details of a specific security filter.

See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
for more examples. | +| | `EXEC` | | Get the list of configured security filters with their definitions. | +| | `EXEC` | | Update a specific security filter.
Returns the security filter object when the request is successful. | diff --git a/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_rules/index.md b/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_rules/index.md index 8e95f9f4ee..0b1da472cb 100644 --- a/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_rules/index.md +++ b/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_rules/index.md @@ -14,61 +14,64 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesecurity_monitoring_rules
TypeResource
Iddatadog.security_monitoring.security_monitoring_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of the rule. | -| `name` | `string` | The name of the rule. | -| `SecurityMonitoringSignalRuleResponse_cases` | `array` | Cases for generating signals. | -| `SecurityMonitoringSignalRuleResponse_createdAt` | `integer` | When the rule was created, timestamp in milliseconds. | -| `SecurityMonitoringSignalRuleResponse_creationAuthorId` | `integer` | User ID of the user who created the rule. | -| `SecurityMonitoringSignalRuleResponse_deprecationDate` | `integer` | When the rule will be deprecated, timestamp in milliseconds. | -| `SecurityMonitoringSignalRuleResponse_filters` | `array` | Additional queries to filter matched events before they are processed. | -| `SecurityMonitoringSignalRuleResponse_hasExtendedTitle` | `boolean` | Whether the notifications include the triggering group-by values in their title. | -| `SecurityMonitoringSignalRuleResponse_id` | `string` | The ID of the rule. | -| `SecurityMonitoringSignalRuleResponse_isDefault` | `boolean` | Whether the rule is included by default. | -| `SecurityMonitoringSignalRuleResponse_isDeleted` | `boolean` | Whether the rule has been deleted. | -| `SecurityMonitoringSignalRuleResponse_isEnabled` | `boolean` | Whether the rule is enabled. | -| `SecurityMonitoringSignalRuleResponse_message` | `string` | Message for generated signals. | -| `SecurityMonitoringSignalRuleResponse_name` | `string` | The name of the rule. | -| `SecurityMonitoringSignalRuleResponse_options` | `object` | Options on rules. | -| `SecurityMonitoringSignalRuleResponse_queries` | `array` | Queries for selecting logs which are part of the rule. | -| `SecurityMonitoringSignalRuleResponse_tags` | `array` | Tags for generated signals. | -| `SecurityMonitoringSignalRuleResponse_type` | `string` | The rule type. | -| `SecurityMonitoringSignalRuleResponse_updateAuthorId` | `integer` | User ID of the user who updated the rule. | -| `SecurityMonitoringSignalRuleResponse_version` | `integer` | The version of the rule. | -| `cases` | `array` | Cases for generating signals. | -| `complianceSignalOptions` | `object` | How to generate compliance signals. Useful for cloud_configuration rules only. | -| `createdAt` | `integer` | When the rule was created, timestamp in milliseconds. | -| `creationAuthorId` | `integer` | User ID of the user who created the rule. | -| `deprecationDate` | `integer` | When the rule will be deprecated, timestamp in milliseconds. | -| `filters` | `array` | Additional queries to filter matched events before they are processed. | -| `hasExtendedTitle` | `boolean` | Whether the notifications include the triggering group-by values in their title. | -| `isDefault` | `boolean` | Whether the rule is included by default. | -| `isDeleted` | `boolean` | Whether the rule has been deleted. | -| `isEnabled` | `boolean` | Whether the rule is enabled. | -| `message` | `string` | Message for generated signals. | -| `options` | `object` | Options on rules. | -| `queries` | `array` | Queries for selecting logs which are part of the rule. | -| `tags` | `array` | Tags for generated signals. | -| `type` | `string` | The rule type. | -| `updateAuthorId` | `integer` | User ID of the user who updated the rule. | -| `version` | `integer` | The version of the rule. | +| | `string` | The ID of the rule. | +| | `string` | The name of the rule. | +| | `array` | Cases for generating signals. | +| | `integer` | When the rule was created, timestamp in milliseconds. | +| | `integer` | User ID of the user who created the rule. | +| | `integer` | When the rule will be deprecated, timestamp in milliseconds. | +| | `array` | Additional queries to filter matched events before they are processed. | +| | `boolean` | Whether the notifications include the triggering group-by values in their title. | +| | `string` | The ID of the rule. | +| | `boolean` | Whether the rule is included by default. | +| | `boolean` | Whether the rule has been deleted. | +| | `boolean` | Whether the rule is enabled. | +| | `string` | Message for generated signals. | +| | `string` | The name of the rule. | +| | `object` | Options on rules. | +| | `array` | Queries for selecting logs which are part of the rule. | +| | `array` | Tags for generated signals. | +| | `string` | The rule type. | +| | `integer` | User ID of the user who updated the rule. | +| | `integer` | The version of the rule. | +| | `array` | Cases for generating signals. | +| | `object` | How to generate compliance signals. Useful for cloud_configuration rules only. | +| | `integer` | When the rule was created, timestamp in milliseconds. | +| | `integer` | User ID of the user who created the rule. | +| | `integer` | When the rule will be deprecated, timestamp in milliseconds. | +| | `array` | Additional queries to filter matched events before they are processed. | +| | `boolean` | Whether the notifications include the triggering group-by values in their title. | +| | `boolean` | Whether the rule is included by default. | +| | `boolean` | Whether the rule has been deleted. | +| | `boolean` | Whether the rule is enabled. | +| | `string` | Message for generated signals. | +| | `object` | Options on rules. | +| | `array` | Queries for selecting logs which are part of the rule. | +| | `array` | Tags for generated signals. | +| | `string` | The rule type. | +| | `integer` | User ID of the user who updated the rule. | +| | `integer` | The version of the rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_security_monitoring_rule` | `SELECT` | `rule_id, dd_site` | Get a rule's details. | -| `list_security_monitoring_rules` | `SELECT` | `dd_site` | List rules. | -| `create_security_monitoring_rule` | `INSERT` | `dd_site` | Create a detection rule. | -| `delete_security_monitoring_rule` | `DELETE` | `rule_id, dd_site` | Delete an existing rule. Default rules cannot be deleted. | -| `update_security_monitoring_rule` | `EXEC` | `rule_id, dd_site` | Update an existing rule. When updating `cases`, `queries` or `options`, the whole field
must be included. For example, when modifying a query all queries must be included.
Default rules can only be updated to be enabled and to change notifications. | +| | `SELECT` | | Get a rule's details. | +| | `SELECT` | | List rules. | +| | `INSERT` | | Create a detection rule. | +| | `DELETE` | | Delete an existing rule. Default rules cannot be deleted. | +| | `EXEC` | | Update an existing rule. When updating `cases`, `queries` or `options`, the whole field
must be included. For example, when modifying a query all queries must be included.
Default rules can only be updated to be enabled and to change notifications. | diff --git a/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_signals/index.md b/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_signals/index.md index 057f8ea99f..ed873e6a1d 100644 --- a/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_signals/index.md +++ b/docs/datadog-docs/providers/datadog/security_monitoring/security_monitoring_signals/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namesecurity_monitoring_signals
TypeResource
Iddatadog.security_monitoring.security_monitoring_signals
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID of the security signal. | -| `attributes` | `object` | The object containing all signal attributes and their
associated values. | -| `type` | `string` | The type of event. | +| | `string` | The unique ID of the security signal. | +| | `object` | The object containing all signal attributes and their
associated values. | +| | `string` | The type of event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_security_monitoring_signal` | `SELECT` | `signal_id, dd_site` | Get a signal's details. | -| `list_security_monitoring_signals` | `SELECT` | `dd_site` | The list endpoint returns security signals that match a search query.
Both this endpoint and the POST endpoint can be used interchangeably when listing
security signals. | -| `_get_security_monitoring_signal` | `EXEC` | `signal_id, dd_site` | Get a signal's details. | -| `_list_security_monitoring_signals` | `EXEC` | `dd_site` | The list endpoint returns security signals that match a search query.
Both this endpoint and the POST endpoint can be used interchangeably when listing
security signals. | -| `edit_security_monitoring_signal_assignee` | `EXEC` | `signal_id, data__data, dd_site` | Modify the triage assignee of a security signal. | -| `edit_security_monitoring_signal_incidents` | `EXEC` | `signal_id, data__data, dd_site` | Change the related incidents for a security signal. | -| `edit_security_monitoring_signal_state` | `EXEC` | `signal_id, data__data, dd_site` | Change the triage state of a security signal. | -| `search_security_monitoring_signals` | `EXEC` | `dd_site` | Returns security signals that match a search query.
Both this endpoint and the GET endpoint can be used interchangeably for listing
security signals. | +| | `SELECT` | | Get a signal's details. | +| | `SELECT` | | The list endpoint returns security signals that match a search query.
Both this endpoint and the POST endpoint can be used interchangeably when listing
security signals. | +| | `EXEC` | | Get a signal's details. | +| | `EXEC` | | The list endpoint returns security signals that match a search query.
Both this endpoint and the POST endpoint can be used interchangeably when listing
security signals. | +| | `EXEC` | | Modify the triage assignee of a security signal. | +| | `EXEC` | | Change the related incidents for a security signal. | +| | `EXEC` | | Change the triage state of a security signal. | +| | `EXEC` | | Returns security signals that match a search query.
Both this endpoint and the GET endpoint can be used interchangeably for listing
security signals. | diff --git a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/index.md b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/index.md index 5d61c8f48f..6d2a2a58c7 100644 --- a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/index.md +++ b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Sensitive Data Scanner :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_groups/index.md b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_groups/index.md index 5940deddc3..397304abec 100644 --- a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_groups/index.md +++ b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_groups/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescanning_groups
TypeResource
Iddatadog.sensitive_data_scanner.scanning_groups
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the configuration. | -| `attributes` | `object` | Attributes of the Sensitive Data configuration. | -| `relationships` | `object` | Relationships of the configuration. | -| `type` | `string` | Sensitive Data Scanner configuration type. | +| | `string` | ID of the configuration. | +| | `object` | Attributes of the Sensitive Data configuration. | +| | `object` | Relationships of the configuration. | +| | `string` | Sensitive Data Scanner configuration type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_scanning_groups` | `SELECT` | `dd_site` | List all the Scanning groups in your organization. | -| `create_scanning_group` | `INSERT` | `dd_site` | Create a scanning group.
The request MAY include a configuration relationship.
A rules relationship can be omitted entirely, but if it is included it MUST be
null or an empty array (rules cannot be created at the same time).
The new group will be ordered last within the configuration. | -| `delete_scanning_group` | `DELETE` | `group_id, data__meta, dd_site` | Delete a given group. | -| `_list_scanning_groups` | `EXEC` | `dd_site` | List all the Scanning groups in your organization. | -| `reorder_scanning_groups` | `EXEC` | `data__data, data__meta, dd_site` | Reorder the list of groups. | -| `update_scanning_group` | `EXEC` | `group_id, data__data, data__meta, dd_site` | Update a group, including the order of the rules.
Rules within the group are reordered by including a rules relationship. If the rules
relationship is present, its data section MUST contain linkages for all of the rules
currently in the group, and MUST NOT contain any others. | +| | `SELECT` | | List all the Scanning groups in your organization. | +| | `INSERT` | | Create a scanning group.
The request MAY include a configuration relationship.
A rules relationship can be omitted entirely, but if it is included it MUST be
null or an empty array (rules cannot be created at the same time).
The new group will be ordered last within the configuration. | +| | `DELETE` | | Delete a given group. | +| | `EXEC` | | List all the Scanning groups in your organization. | +| | `EXEC` | | Reorder the list of groups. | +| | `EXEC` | | Update a group, including the order of the rules.
Rules within the group are reordered by including a rules relationship. If the rules
relationship is present, its data section MUST contain linkages for all of the rules
currently in the group, and MUST NOT contain any others. | diff --git a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_rules/index.md b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_rules/index.md index 4fe3d8a4c7..2273438e07 100644 --- a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_rules/index.md +++ b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/scanning_rules/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescanning_rules
TypeResource
Iddatadog.sensitive_data_scanner.scanning_rules
Id
## Fields @@ -29,6 +32,6 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `create_scanning_rule` | `INSERT` | `data__data, data__meta, dd_site` | Create a scanning rule in a sensitive data scanner group, ordered last.
The posted rule MUST include a group relationship.
It MUST include either a standard_pattern relationship or a regex attribute, but not both.
If included_attributes is empty or missing, we will scan all attributes except
excluded_attributes. If both are missing, we will scan the whole event. | -| `delete_scanning_rule` | `DELETE` | `rule_id, data__meta, dd_site` | Delete a given rule. | -| `update_scanning_rule` | `EXEC` | `rule_id, data__data, data__meta, dd_site` | Update a scanning rule.
The request body MUST NOT include a standard_pattern relationship, as that relationship
is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern
relationship will also result in an error. | +| | `INSERT` | | Create a scanning rule in a sensitive data scanner group, ordered last.
The posted rule MUST include a group relationship.
It MUST include either a standard_pattern relationship or a regex attribute, but not both.
If included_attributes is empty or missing, we will scan all attributes except
excluded_attributes. If both are missing, we will scan the whole event. | +| | `DELETE` | | Delete a given rule. | +| | `EXEC` | | Update a scanning rule.
The request body MUST NOT include a standard_pattern relationship, as that relationship
is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern
relationship will also result in an error. | diff --git a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/standard_patterns/index.md b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/standard_patterns/index.md index cf0916afc4..48195fcc0d 100644 --- a/docs/datadog-docs/providers/datadog/sensitive_data_scanner/standard_patterns/index.md +++ b/docs/datadog-docs/providers/datadog/sensitive_data_scanner/standard_patterns/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namestandard_patterns
TypeResource
Iddatadog.sensitive_data_scanner.standard_patterns
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the standard pattern. | -| `attributes` | `object` | Attributes of the Sensitive Data Scanner standard pattern. | -| `type` | `string` | Sensitive Data Scanner standard pattern type. | +| | `string` | ID of the standard pattern. | +| | `object` | Attributes of the Sensitive Data Scanner standard pattern. | +| | `string` | Sensitive Data Scanner standard pattern type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_standard_patterns` | `SELECT` | `dd_site` | -| `_list_standard_patterns` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/service_accounts/index.md b/docs/datadog-docs/providers/datadog/service_accounts/index.md index 9eebf8b1db..4157f9d937 100644 --- a/docs/datadog-docs/providers/datadog/service_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/service_accounts/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Service Accounts :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/service_accounts/service_account_application_keys/index.md b/docs/datadog-docs/providers/datadog/service_accounts/service_account_application_keys/index.md index 88c77b7b46..a5582bb8e8 100644 --- a/docs/datadog-docs/providers/datadog/service_accounts/service_account_application_keys/index.md +++ b/docs/datadog-docs/providers/datadog/service_accounts/service_account_application_keys/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_account_application_keys
TypeResource
Iddatadog.service_accounts.service_account_application_keys
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the application key. | -| `attributes` | `object` | Attributes of a partial application key. | -| `relationships` | `object` | Resources related to the application key. | -| `type` | `string` | Application Keys resource type. | +| | `string` | ID of the application key. | +| | `object` | Attributes of a partial application key. | +| | `object` | Resources related to the application key. | +| | `string` | Application Keys resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_service_account_application_key` | `SELECT` | `app_key_id, service_account_id, dd_site` | Get an application key owned by this service account. | -| `list_service_account_application_keys` | `SELECT` | `service_account_id, dd_site` | List all application keys available for this service account. | -| `create_service_account_application_key` | `INSERT` | `service_account_id, data__data, dd_site` | Create an application key for this service account. | -| `delete_service_account_application_key` | `DELETE` | `app_key_id, service_account_id, dd_site` | Delete an application key owned by this service account. | -| `_get_service_account_application_key` | `EXEC` | `app_key_id, service_account_id, dd_site` | Get an application key owned by this service account. | -| `_list_service_account_application_keys` | `EXEC` | `service_account_id, dd_site` | List all application keys available for this service account. | -| `update_service_account_application_key` | `EXEC` | `app_key_id, service_account_id, data__data, dd_site` | Edit an application key owned by this service account. | +| | `SELECT` | | Get an application key owned by this service account. | +| | `SELECT` | | List all application keys available for this service account. | +| | `INSERT` | | Create an application key for this service account. | +| | `DELETE` | | Delete an application key owned by this service account. | +| | `EXEC` | | Get an application key owned by this service account. | +| | `EXEC` | | List all application keys available for this service account. | +| | `EXEC` | | Edit an application key owned by this service account. | diff --git a/docs/datadog-docs/providers/datadog/service_accounts/service_accounts/index.md b/docs/datadog-docs/providers/datadog/service_accounts/service_accounts/index.md index 132e291b58..25f9093848 100644 --- a/docs/datadog-docs/providers/datadog/service_accounts/service_accounts/index.md +++ b/docs/datadog-docs/providers/datadog/service_accounts/service_accounts/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_accounts
TypeResource
Iddatadog.service_accounts.service_accounts
Id
## Fields @@ -29,4 +32,4 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `create_service_account` | `INSERT` | `data__data, dd_site` | +| | `INSERT` | | diff --git a/docs/datadog-docs/providers/datadog/service_definition/index.md b/docs/datadog-docs/providers/datadog/service_definition/index.md index 8b1122ed05..a643a654bf 100644 --- a/docs/datadog-docs/providers/datadog/service_definition/index.md +++ b/docs/datadog-docs/providers/datadog/service_definition/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Service Definition :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/service_definition/service_definitions/index.md b/docs/datadog-docs/providers/datadog/service_definition/service_definitions/index.md index 27aafc61c5..bc241c5efe 100644 --- a/docs/datadog-docs/providers/datadog/service_definition/service_definitions/index.md +++ b/docs/datadog-docs/providers/datadog/service_definition/service_definitions/index.md @@ -14,28 +14,31 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameservice_definitions
TypeResource
Iddatadog.service_definition.service_definitions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Service definition id. | -| `attributes` | `object` | Service definition attributes. | -| `type` | `string` | Service definition type. | +| | `string` | Service definition id. | +| | `object` | Service definition attributes. | +| | `string` | Service definition type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_service_definition` | `SELECT` | `service_name, dd_site` | Get a single service definition from the Datadog Service Catalog. | -| `list_service_definitions` | `SELECT` | `dd_site` | Get a list of all service definitions from the Datadog Service Catalog. | -| `create_or_update_service_definitions` | `INSERT` | `dd_site` | Create or update service definition in the Datadog Service Catalog. | -| `delete_service_definition` | `DELETE` | `service_name, dd_site` | Delete a single service definition in the Datadog Service Catalog. | -| `_get_service_definition` | `EXEC` | `service_name, dd_site` | Get a single service definition from the Datadog Service Catalog. | -| `_list_service_definitions` | `EXEC` | `dd_site` | Get a list of all service definitions from the Datadog Service Catalog. | +| | `SELECT` | | Get a single service definition from the Datadog Service Catalog. | +| | `SELECT` | | Get a list of all service definitions from the Datadog Service Catalog. | +| | `INSERT` | | Create or update service definition in the Datadog Service Catalog. | +| | `DELETE` | | Delete a single service definition in the Datadog Service Catalog. | +| | `EXEC` | | Get a single service definition from the Datadog Service Catalog. | +| | `EXEC` | | Get a list of all service definitions from the Datadog Service Catalog. | diff --git a/docs/datadog-docs/providers/datadog/service_scorecards/index.md b/docs/datadog-docs/providers/datadog/service_scorecards/index.md index 17918db69a..cfc0292f3e 100644 --- a/docs/datadog-docs/providers/datadog/service_scorecards/index.md +++ b/docs/datadog-docs/providers/datadog/service_scorecards/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Service Scorecards :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_outcomes/index.md b/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_outcomes/index.md index 352fc49bb3..5d5adb1f60 100644 --- a/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_outcomes/index.md +++ b/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_outcomes/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescorecard_outcomes
TypeResource
Iddatadog.service_scorecards.scorecard_outcomes
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID for a rule outcome. | -| `attributes` | `object` | The JSON:API attributes for an outcome. | -| `relationships` | `object` | The JSON:API relationship to a scorecard rule. | -| `type` | `string` | The JSON:API type for an outcome. | +| | `string` | The unique ID for a rule outcome. | +| | `object` | The JSON:API attributes for an outcome. | +| | `object` | The JSON:API relationship to a scorecard rule. | +| | `string` | The JSON:API type for an outcome. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_scorecard_outcomes` | `SELECT` | `dd_site` | Fetches all rule outcomes. | -| `create_scorecard_outcomes_batch` | `INSERT` | `dd_site` | Sets multiple service-rule outcomes in a single batched request. | -| `_list_scorecard_outcomes` | `EXEC` | `dd_site` | Fetches all rule outcomes. | +| | `SELECT` | | Fetches all rule outcomes. | +| | `INSERT` | | Sets multiple service-rule outcomes in a single batched request. | +| | `EXEC` | | Fetches all rule outcomes. | diff --git a/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_rules/index.md b/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_rules/index.md index b82aec8b5a..83d66adf8f 100644 --- a/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_rules/index.md +++ b/docs/datadog-docs/providers/datadog/service_scorecards/scorecard_rules/index.md @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namescorecard_rules
TypeResource
Iddatadog.service_scorecards.scorecard_rules
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The unique ID for a scorecard rule. | -| `attributes` | `object` | Details of a rule. | -| `relationships` | `object` | Scorecard create rule response relationship. | -| `type` | `string` | The JSON:API type for scorecard rules. | +| | `string` | The unique ID for a scorecard rule. | +| | `object` | Details of a rule. | +| | `object` | Scorecard create rule response relationship. | +| | `string` | The JSON:API type for scorecard rules. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_scorecard_rules` | `SELECT` | `dd_site` | Fetch all rules. | -| `create_scorecard_rule` | `INSERT` | `dd_site` | Creates a new rule. | -| `delete_scorecard_rule` | `DELETE` | `rule_id, dd_site` | Deletes a single rule. | -| `_list_scorecard_rules` | `EXEC` | `dd_site` | Fetch all rules. | +| | `SELECT` | | Fetch all rules. | +| | `INSERT` | | Creates a new rule. | +| | `DELETE` | | Deletes a single rule. | +| | `EXEC` | | Fetch all rules. | diff --git a/docs/datadog-docs/providers/datadog/span_metrics/index.md b/docs/datadog-docs/providers/datadog/span_metrics/index.md index da264274af..837e9daa48 100644 --- a/docs/datadog-docs/providers/datadog/span_metrics/index.md +++ b/docs/datadog-docs/providers/datadog/span_metrics/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Spans Metrics :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/span_metrics/span_metrics/index.md b/docs/datadog-docs/providers/datadog/span_metrics/span_metrics/index.md index 6d6da6d9a4..d234719487 100644 --- a/docs/datadog-docs/providers/datadog/span_metrics/span_metrics/index.md +++ b/docs/datadog-docs/providers/datadog/span_metrics/span_metrics/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespan_metrics
TypeResource
Iddatadog.span_metrics.span_metrics
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The name of the span-based metric. | -| `attributes` | `object` | The object describing a Datadog span-based metric. | -| `type` | `string` | The type of resource. The value should always be spans_metrics. | +| | `string` | The name of the span-based metric. | +| | `object` | The object describing a Datadog span-based metric. | +| | `string` | The type of resource. The value should always be spans_metrics. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_spans_metric` | `SELECT` | `metric_id, dd_site` | Get a specific span-based metric from your organization. | -| `list_spans_metrics` | `SELECT` | `dd_site` | Get the list of configured span-based metrics with their definitions. | -| `create_spans_metric` | `INSERT` | `data__data, dd_site` | Create a metric based on your ingested spans in your organization.
Returns the span-based metric object from the request body when the request is successful. | -| `delete_spans_metric` | `DELETE` | `metric_id, dd_site` | Delete a specific span-based metric from your organization. | -| `_get_spans_metric` | `EXEC` | `metric_id, dd_site` | Get a specific span-based metric from your organization. | -| `_list_spans_metrics` | `EXEC` | `dd_site` | Get the list of configured span-based metrics with their definitions. | -| `update_spans_metric` | `EXEC` | `metric_id, data__data, dd_site` | Update a specific span-based metric from your organization.
Returns the span-based metric object from the request body when the request is successful. | +| | `SELECT` | | Get a specific span-based metric from your organization. | +| | `SELECT` | | Get the list of configured span-based metrics with their definitions. | +| | `INSERT` | | Create a metric based on your ingested spans in your organization.
Returns the span-based metric object from the request body when the request is successful. | +| | `DELETE` | | Delete a specific span-based metric from your organization. | +| | `EXEC` | | Get a specific span-based metric from your organization. | +| | `EXEC` | | Get the list of configured span-based metrics with their definitions. | +| | `EXEC` | | Update a specific span-based metric from your organization.
Returns the span-based metric object from the request body when the request is successful. | diff --git a/docs/datadog-docs/providers/datadog/spans/index.md b/docs/datadog-docs/providers/datadog/spans/index.md index 29e74a0804..82d1e406d9 100644 --- a/docs/datadog-docs/providers/datadog/spans/index.md +++ b/docs/datadog-docs/providers/datadog/spans/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Search And Aggregate Your Spans From Your Datadog Platform Over HTTP. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/spans/span_query/index.md b/docs/datadog-docs/providers/datadog/spans/span_query/index.md index c67833ea1d..cd7e2d63ca 100644 --- a/docs/datadog-docs/providers/datadog/spans/span_query/index.md +++ b/docs/datadog-docs/providers/datadog/spans/span_query/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespan_query
TypeResource
Iddatadog.spans.span_query
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the Span. | -| `attributes` | `object` | JSON object containing all span attributes and their associated values. | -| `type` | `string` | Type of the span. | +| | `string` | Unique ID of the Span. | +| | `object` | JSON object containing all span attributes and their associated values. | +| | `string` | Type of the span. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_spans_get` | `SELECT` | `dd_site` | -| `_list_spans_get` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/spans/spans/index.md b/docs/datadog-docs/providers/datadog/spans/spans/index.md index 6dd34db55c..ee46843819 100644 --- a/docs/datadog-docs/providers/datadog/spans/spans/index.md +++ b/docs/datadog-docs/providers/datadog/spans/spans/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namespans
TypeResource
Iddatadog.spans.spans
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `array` | Array of spans matching the request. | -| `links` | `object` | Links attributes. | -| `meta` | `object` | The metadata associated with a request. | +| | `array` | Array of spans matching the request. | +| | `object` | Links attributes. | +| | `object` | The metadata associated with a request. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list_spans` | `SELECT` | `dd_site` | List endpoint returns spans that match a span search query.
[Results are paginated][1].

Use this endpoint to build complex spans filtering and search.
This endpoint is rate limited to `300` requests per hour.

[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api | -| `aggregate_spans` | `EXEC` | `dd_site` | The API endpoint to aggregate spans into buckets and compute metrics and timeseries.
This endpoint is rate limited to `300` requests per hour. | +| | `SELECT` | | List endpoint returns spans that match a span search query.
[Results are paginated][1].

Use this endpoint to build complex spans filtering and search.
This endpoint is rate limited to `300` requests per hour.

[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api | +| | `EXEC` | | The API endpoint to aggregate spans into buckets and compute metrics and timeseries.
This endpoint is rate limited to `300` requests per hour. | diff --git a/docs/datadog-docs/providers/datadog/synthetics/index.md b/docs/datadog-docs/providers/datadog/synthetics/index.md index 730afde086..ac4a7baf54 100644 --- a/docs/datadog-docs/providers/datadog/synthetics/index.md +++ b/docs/datadog-docs/providers/datadog/synthetics/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Datadog Synthetics Uses Simulated User Requests And Browser Rendering To Help You Ensure Uptime, Identify Regional Issues, And Track Your Application Performance. Datadog Synthetics Tests Come In Two Different Flavors, [API Tests](Https://Docs.Datadoghq.Com/Synthetics/Api Tests/) diff --git a/docs/datadog-docs/providers/datadog/synthetics/on_demand_concurrency_caps/index.md b/docs/datadog-docs/providers/datadog/synthetics/on_demand_concurrency_caps/index.md index 376f217b0a..a5162ba9d3 100644 --- a/docs/datadog-docs/providers/datadog/synthetics/on_demand_concurrency_caps/index.md +++ b/docs/datadog-docs/providers/datadog/synthetics/on_demand_concurrency_caps/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameon_demand_concurrency_caps
TypeResource
Iddatadog.synthetics.on_demand_concurrency_caps
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `attributes` | `object` | On-demand concurrency cap attributes. | -| `type` | `string` | On-demand concurrency cap type. | +| | `object` | On-demand concurrency cap attributes. | +| | `string` | On-demand concurrency cap type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_on_demand_concurrency_cap` | `SELECT` | `dd_site` | Get the on-demand concurrency cap. | -| `_get_on_demand_concurrency_cap` | `EXEC` | `dd_site` | Get the on-demand concurrency cap. | -| `set_on_demand_concurrency_cap` | `EXEC` | `dd_site` | Save new value for on-demand concurrency cap. | +| | `SELECT` | | Get the on-demand concurrency cap. | +| | `EXEC` | | Get the on-demand concurrency cap. | +| | `EXEC` | | Save new value for on-demand concurrency cap. | diff --git a/docs/datadog-docs/providers/datadog/teams/index.md b/docs/datadog-docs/providers/datadog/teams/index.md index ad5de1bee1..76f4dfa11c 100644 --- a/docs/datadog-docs/providers/datadog/teams/index.md +++ b/docs/datadog-docs/providers/datadog/teams/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + View And Manage Teams Within Datadog. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/teams/team_links/index.md b/docs/datadog-docs/providers/datadog/teams/team_links/index.md index 7fa91970ac..dd75a7f408 100644 --- a/docs/datadog-docs/providers/datadog/teams/team_links/index.md +++ b/docs/datadog-docs/providers/datadog/teams/team_links/index.md @@ -14,29 +14,32 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteam_links
TypeResource
Iddatadog.teams.team_links
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The team link's identifier | -| `attributes` | `object` | Team link attributes | -| `type` | `string` | Team link type | +| | `string` | The team link's identifier | +| | `object` | Team link attributes | +| | `string` | Team link type | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_link` | `SELECT` | `link_id, team_id, dd_site` | Get a single link for a team. | -| `get_team_links` | `SELECT` | `team_id, dd_site` | Get all links for a given team. | -| `create_team_link` | `INSERT` | `team_id, data__data, dd_site` | Add a new link to a team. | -| `delete_team_link` | `DELETE` | `link_id, team_id, dd_site` | Remove a link from a team. | -| `_get_team_link` | `EXEC` | `link_id, team_id, dd_site` | Get a single link for a team. | -| `_get_team_links` | `EXEC` | `team_id, dd_site` | Get all links for a given team. | -| `update_team_link` | `EXEC` | `link_id, team_id, data__data, dd_site` | Update a team link. | +| | `SELECT` | | Get a single link for a team. | +| | `SELECT` | | Get all links for a given team. | +| | `INSERT` | | Add a new link to a team. | +| | `DELETE` | | Remove a link from a team. | +| | `EXEC` | | Get a single link for a team. | +| | `EXEC` | | Get all links for a given team. | +| | `EXEC` | | Update a team link. | diff --git a/docs/datadog-docs/providers/datadog/teams/team_memberships/index.md b/docs/datadog-docs/providers/datadog/teams/team_memberships/index.md index 03139fff75..e74b8adec9 100644 --- a/docs/datadog-docs/providers/datadog/teams/team_memberships/index.md +++ b/docs/datadog-docs/providers/datadog/teams/team_memberships/index.md @@ -14,28 +14,31 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteam_memberships
TypeResource
Iddatadog.teams.team_memberships
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of a user's relationship with a team | -| `attributes` | `object` | Team membership attributes | -| `relationships` | `object` | Relationship between membership and a user | -| `type` | `string` | Team membership type | +| | `string` | The ID of a user's relationship with a team | +| | `object` | Team membership attributes | +| | `object` | Relationship between membership and a user | +| | `string` | Team membership type | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_memberships` | `SELECT` | `team_id, dd_site` | Get a paginated list of members for a team | -| `create_team_membership` | `INSERT` | `team_id, data__data, dd_site` | Add a user to a team. | -| `delete_team_membership` | `DELETE` | `team_id, user_id, dd_site` | Remove a user from a team. | -| `_get_team_memberships` | `EXEC` | `team_id, dd_site` | Get a paginated list of members for a team | -| `update_team_membership` | `EXEC` | `team_id, user_id, data__data, dd_site` | Update a user's membership attributes on a team. | +| | `SELECT` | | Get a paginated list of members for a team | +| | `INSERT` | | Add a user to a team. | +| | `DELETE` | | Remove a user from a team. | +| | `EXEC` | | Get a paginated list of members for a team | +| | `EXEC` | | Update a user's membership attributes on a team. | diff --git a/docs/datadog-docs/providers/datadog/teams/team_permission_settings/index.md b/docs/datadog-docs/providers/datadog/teams/team_permission_settings/index.md index 3e5260a813..265ec84cdc 100644 --- a/docs/datadog-docs/providers/datadog/teams/team_permission_settings/index.md +++ b/docs/datadog-docs/providers/datadog/teams/team_permission_settings/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteam_permission_settings
TypeResource
Iddatadog.teams.team_permission_settings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The team permission setting's identifier | -| `attributes` | `object` | Team permission setting attributes | -| `type` | `string` | Team permission setting type | +| | `string` | The team permission setting's identifier | +| | `object` | Team permission setting attributes | +| | `string` | Team permission setting type | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team_permission_settings` | `SELECT` | `team_id, dd_site` | Get all permission settings for a given team. | -| `_get_team_permission_settings` | `EXEC` | `team_id, dd_site` | Get all permission settings for a given team. | -| `update_team_permission_setting` | `EXEC` | `action, team_id, data__data, dd_site` | Update a team permission setting for a given team. | +| | `SELECT` | | Get all permission settings for a given team. | +| | `EXEC` | | Get all permission settings for a given team. | +| | `EXEC` | | Update a team permission setting for a given team. | diff --git a/docs/datadog-docs/providers/datadog/teams/teams/index.md b/docs/datadog-docs/providers/datadog/teams/teams/index.md index 371e95e0b7..82d10d7aa4 100644 --- a/docs/datadog-docs/providers/datadog/teams/teams/index.md +++ b/docs/datadog-docs/providers/datadog/teams/teams/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameteams
TypeResource
Iddatadog.teams.teams
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The team's identifier | -| `attributes` | `object` | Team attributes | -| `relationships` | `object` | Resources related to a team | -| `type` | `string` | Team type | +| | `string` | The team's identifier | +| | `object` | Team attributes | +| | `object` | Resources related to a team | +| | `string` | Team type | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_team` | `SELECT` | `team_id, dd_site` | Get a single team using the team's `id`. | -| `list_teams` | `SELECT` | `dd_site` | Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters. | -| `create_team` | `INSERT` | `data__data, dd_site` | Create a new team.
User IDs passed through the `users` relationship field are added to the team. | -| `delete_team` | `DELETE` | `team_id, dd_site` | Remove a team using the team's `id`. | -| `_get_team` | `EXEC` | `team_id, dd_site` | Get a single team using the team's `id`. | -| `_list_teams` | `EXEC` | `dd_site` | Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters. | -| `update_team` | `EXEC` | `team_id, data__data, dd_site` | Update a team using the team's `id`.
If the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed. | +| | `SELECT` | | Get a single team using the team's `id`. | +| | `SELECT` | | Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters. | +| | `INSERT` | | Create a new team.
User IDs passed through the `users` relationship field are added to the team. | +| | `DELETE` | | Remove a team using the team's `id`. | +| | `EXEC` | | Get a single team using the team's `id`. | +| | `EXEC` | | Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters. | +| | `EXEC` | | Update a team using the team's `id`.
If the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed. | diff --git a/docs/datadog-docs/providers/datadog/teams/user_memberships/index.md b/docs/datadog-docs/providers/datadog/teams/user_memberships/index.md index 0965692294..d13bfedf30 100644 --- a/docs/datadog-docs/providers/datadog/teams/user_memberships/index.md +++ b/docs/datadog-docs/providers/datadog/teams/user_memberships/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser_memberships
TypeResource
Iddatadog.teams.user_memberships
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | The ID of a user's relationship with a team | -| `attributes` | `object` | Team membership attributes | -| `relationships` | `object` | Relationship between membership and a user | -| `type` | `string` | Team membership type | +| | `string` | The ID of a user's relationship with a team | +| | `object` | Team membership attributes | +| | `object` | Relationship between membership and a user | +| | `string` | Team membership type | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_user_memberships` | `SELECT` | `user_uuid, dd_site` | -| `_get_user_memberships` | `EXEC` | `user_uuid, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/active_billing_dimensions/index.md b/docs/datadog-docs/providers/datadog/usage_metering/active_billing_dimensions/index.md index 7e912396c7..d41c1b4188 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/active_billing_dimensions/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/active_billing_dimensions/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameactive_billing_dimensions
TypeResource
Iddatadog.usage_metering.active_billing_dimensions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | List of active billing dimensions. | -| `type` | `string` | Type of active billing dimensions data. | +| | `string` | Unique ID of the response. | +| | `object` | List of active billing dimensions. | +| | `string` | Type of active billing dimensions data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_active_billing_dimensions` | `SELECT` | `dd_site` | -| `_get_active_billing_dimensions` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/cost_by_orgs/index.md b/docs/datadog-docs/providers/datadog/usage_metering/cost_by_orgs/index.md index 35da56a503..2f7e65da5e 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/cost_by_orgs/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/cost_by_orgs/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namecost_by_orgs
TypeResource
Iddatadog.usage_metering.cost_by_orgs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Cost attributes data. | -| `type` | `string` | Type of cost data. | +| | `string` | Unique ID of the response. | +| | `object` | Cost attributes data. | +| | `string` | Type of cost data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_cost_by_org` | `SELECT` | `start_month, dd_site` | -| `_get_cost_by_org` | `EXEC` | `start_month, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/estimated_cost_by_orgs/index.md b/docs/datadog-docs/providers/datadog/usage_metering/estimated_cost_by_orgs/index.md index d6d30036d8..2fda83b454 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/estimated_cost_by_orgs/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/estimated_cost_by_orgs/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameestimated_cost_by_orgs
TypeResource
Iddatadog.usage_metering.estimated_cost_by_orgs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Cost attributes data. | -| `type` | `string` | Type of cost data. | +| | `string` | Unique ID of the response. | +| | `object` | Cost attributes data. | +| | `string` | Type of cost data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_estimated_cost_by_org` | `SELECT` | `dd_site` | -| `_get_estimated_cost_by_org` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/historical_cost_by_orgs/index.md b/docs/datadog-docs/providers/datadog/usage_metering/historical_cost_by_orgs/index.md index db4ecc408c..2648b4a0d1 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/historical_cost_by_orgs/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/historical_cost_by_orgs/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehistorical_cost_by_orgs
TypeResource
Iddatadog.usage_metering.historical_cost_by_orgs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Cost attributes data. | -| `type` | `string` | Type of cost data. | +| | `string` | Unique ID of the response. | +| | `object` | Cost attributes data. | +| | `string` | Type of cost data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_historical_cost_by_org` | `SELECT` | `start_month, dd_site` | -| `_get_historical_cost_by_org` | `EXEC` | `start_month, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/hourly_usages/index.md b/docs/datadog-docs/providers/datadog/usage_metering/hourly_usages/index.md index 7e70c5919d..d4f2913731 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/hourly_usages/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/hourly_usages/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namehourly_usages
TypeResource
Iddatadog.usage_metering.hourly_usages
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Attributes of hourly usage for a product family for an org for a time period. | -| `type` | `string` | Type of usage data. | +| | `string` | Unique ID of the response. | +| | `object` | Attributes of hourly usage for a product family for an org for a time period. | +| | `string` | Type of usage data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_hourly_usage` | `SELECT` | `filter[product_families], filter[timestamp][start], dd_site` | -| `_get_hourly_usage` | `EXEC` | `filter[product_families], filter[timestamp][start], dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/index.md b/docs/datadog-docs/providers/datadog/usage_metering/index.md index 228963cdf1..2064a68553 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Usage Metering :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/usage_metering/monthly_cost_attributions/index.md b/docs/datadog-docs/providers/datadog/usage_metering/monthly_cost_attributions/index.md index bfc11576fa..5df45dfa3b 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/monthly_cost_attributions/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/monthly_cost_attributions/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namemonthly_cost_attributions
TypeResource
Iddatadog.usage_metering.monthly_cost_attributions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Cost Attribution by Tag for a given organization. | -| `type` | `string` | Type of cost attribution data. | +| | `string` | Unique ID of the response. | +| | `object` | Cost Attribution by Tag for a given organization. | +| | `string` | Type of cost attribution data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_monthly_cost_attribution` | `SELECT` | `end_month, fields, start_month, dd_site` | -| `_get_monthly_cost_attribution` | `EXEC` | `end_month, fields, start_month, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/projected_costs/index.md b/docs/datadog-docs/providers/datadog/usage_metering/projected_costs/index.md index dd489ddb8e..09d1a9a6af 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/projected_costs/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/projected_costs/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameprojected_costs
TypeResource
Iddatadog.usage_metering.projected_costs
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Projected Cost attributes data. | -| `type` | `string` | Type of cost data. | +| | `string` | Unique ID of the response. | +| | `object` | Projected Cost attributes data. | +| | `string` | Type of cost data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_projected_cost` | `SELECT` | `dd_site` | -| `_get_projected_cost` | `EXEC` | `dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/usage_application_security_monitorings/index.md b/docs/datadog-docs/providers/datadog/usage_metering/usage_application_security_monitorings/index.md index 1f6926c6b4..ab520b5d5c 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/usage_application_security_monitorings/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/usage_application_security_monitorings/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_application_security_monitorings
TypeResource
Iddatadog.usage_metering.usage_application_security_monitorings
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Usage attributes data. | -| `type` | `string` | Type of usage data. | +| | `string` | Unique ID of the response. | +| | `object` | Usage attributes data. | +| | `string` | Type of usage data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_usage_application_security_monitoring` | `SELECT` | `start_hr, dd_site` | -| `_get_usage_application_security_monitoring` | `EXEC` | `start_hr, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/usage_lambda_traced_invocations/index.md b/docs/datadog-docs/providers/datadog/usage_metering/usage_lambda_traced_invocations/index.md index 6ad8d863a1..480cb459a0 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/usage_lambda_traced_invocations/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/usage_lambda_traced_invocations/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_lambda_traced_invocations
TypeResource
Iddatadog.usage_metering.usage_lambda_traced_invocations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Usage attributes data. | -| `type` | `string` | Type of usage data. | +| | `string` | Unique ID of the response. | +| | `object` | Usage attributes data. | +| | `string` | Type of usage data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_usage_lambda_traced_invocations` | `SELECT` | `start_hr, dd_site` | -| `_get_usage_lambda_traced_invocations` | `EXEC` | `start_hr, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/usage_metering/usage_observability_pipelines/index.md b/docs/datadog-docs/providers/datadog/usage_metering/usage_observability_pipelines/index.md index 2d20ebe8fd..089f765263 100644 --- a/docs/datadog-docs/providers/datadog/usage_metering/usage_observability_pipelines/index.md +++ b/docs/datadog-docs/providers/datadog/usage_metering/usage_observability_pipelines/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusage_observability_pipelines
TypeResource
Iddatadog.usage_metering.usage_observability_pipelines
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique ID of the response. | -| `attributes` | `object` | Usage attributes data. | -| `type` | `string` | Type of usage data. | +| | `string` | Unique ID of the response. | +| | `object` | Usage attributes data. | +| | `string` | Type of usage data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_usage_observability_pipelines` | `SELECT` | `start_hr, dd_site` | -| `_get_usage_observability_pipelines` | `EXEC` | `start_hr, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/users/index.md b/docs/datadog-docs/providers/datadog/users/index.md index 7a34f41ab9..f27745b582 100644 --- a/docs/datadog-docs/providers/datadog/users/index.md +++ b/docs/datadog-docs/providers/datadog/users/index.md @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- + Create, Edit, And Disable Users. :::info Service Summary diff --git a/docs/datadog-docs/providers/datadog/users/invitations/index.md b/docs/datadog-docs/providers/datadog/users/invitations/index.md index 5af1df418e..d0337b8e19 100644 --- a/docs/datadog-docs/providers/datadog/users/invitations/index.md +++ b/docs/datadog-docs/providers/datadog/users/invitations/index.md @@ -14,26 +14,29 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameinvitations
TypeResource
Iddatadog.users.invitations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the user invitation. | -| `attributes` | `object` | Attributes of a user invitation. | -| `relationships` | `object` | Relationships data for user invitation. | -| `type` | `string` | User invitations type. | +| | `string` | ID of the user invitation. | +| | `object` | Attributes of a user invitation. | +| | `object` | Relationships data for user invitation. | +| | `string` | User invitations type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_invitation` | `SELECT` | `user_invitation_uuid, dd_site` | Returns a single user invitation by its UUID. | -| `_get_invitation` | `EXEC` | `user_invitation_uuid, dd_site` | Returns a single user invitation by its UUID. | -| `send_invitations` | `EXEC` | `data__data, dd_site` | Sends emails to one or more users inviting them to join the organization. | +| | `SELECT` | | Returns a single user invitation by its UUID. | +| | `EXEC` | | Returns a single user invitation by its UUID. | +| | `EXEC` | | Sends emails to one or more users inviting them to join the organization. | diff --git a/docs/datadog-docs/providers/datadog/users/user_organizations/index.md b/docs/datadog-docs/providers/datadog/users/user_organizations/index.md index 78b50a8dea..8251cc8cc8 100644 --- a/docs/datadog-docs/providers/datadog/users/user_organizations/index.md +++ b/docs/datadog-docs/providers/datadog/users/user_organizations/index.md @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser_organizations
TypeResource
Iddatadog.users.user_organizations
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the user. | -| `attributes` | `object` | Attributes of user object returned by the API. | -| `relationships` | `object` | Relationships of the user object returned by the API. | -| `type` | `string` | Users resource type. | +| | `string` | ID of the user. | +| | `object` | Attributes of user object returned by the API. | +| | `object` | Relationships of the user object returned by the API. | +| | `string` | Users resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_user_organizations` | `SELECT` | `user_id, dd_site` | -| `_list_user_organizations` | `EXEC` | `user_id, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/users/user_permissions/index.md b/docs/datadog-docs/providers/datadog/users/user_permissions/index.md index 60e901705b..6ec8e9a255 100644 --- a/docs/datadog-docs/providers/datadog/users/user_permissions/index.md +++ b/docs/datadog-docs/providers/datadog/users/user_permissions/index.md @@ -14,24 +14,27 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameuser_permissions
TypeResource
Iddatadog.users.user_permissions
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the permission. | -| `attributes` | `object` | Attributes of a permission. | -| `type` | `string` | Permissions resource type. | +| | `string` | ID of the permission. | +| | `object` | Attributes of a permission. | +| | `string` | Permissions resource type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `list_user_permissions` | `SELECT` | `user_id, dd_site` | -| `_list_user_permissions` | `EXEC` | `user_id, dd_site` | +| | `SELECT` | | +| | `EXEC` | | diff --git a/docs/datadog-docs/providers/datadog/users/users/index.md b/docs/datadog-docs/providers/datadog/users/users/index.md index 509eff6e82..05ccb92aad 100644 --- a/docs/datadog-docs/providers/datadog/users/users/index.md +++ b/docs/datadog-docs/providers/datadog/users/users/index.md @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Nameusers
TypeResource
Iddatadog.users.users
Id
## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | ID of the user. | -| `attributes` | `object` | Attributes of user object returned by the API. | -| `relationships` | `object` | Relationships of the user object returned by the API. | -| `type` | `string` | Users resource type. | +| | `string` | ID of the user. | +| | `object` | Attributes of user object returned by the API. | +| | `object` | Relationships of the user object returned by the API. | +| | `string` | Users resource type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_user` | `SELECT` | `user_id, dd_site` | Get a user in the organization specified by the user’s `user_id`. | -| `list_users` | `SELECT` | `dd_site` | Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified. | -| `create_user` | `INSERT` | `data__data, dd_site` | Create a user for your organization. | -| `_get_user` | `EXEC` | `user_id, dd_site` | Get a user in the organization specified by the user’s `user_id`. | -| `_list_users` | `EXEC` | `dd_site` | Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified. | -| `disable_user` | `EXEC` | `user_id, dd_site` | Disable a user. Can only be used with an application key belonging
to an administrator user. | -| `update_user` | `EXEC` | `user_id, data__data, dd_site` | Edit a user. Can only be used with an application key belonging
to an administrator user. | +| | `SELECT` | | Get a user in the organization specified by the user’s `user_id`. | +| | `SELECT` | | Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified. | +| | `INSERT` | | Create a user for your organization. | +| | `EXEC` | | Get a user in the organization specified by the user’s `user_id`. | +| | `EXEC` | | Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified. | +| | `EXEC` | | Disable a user. Can only be used with an application key belonging
to an administrator user. | +| | `EXEC` | | Edit a user. Can only be used with an application key belonging
to an administrator user. | diff --git a/docs/datadog-docs/providers/datadog/users/vw_users/index.md b/docs/datadog-docs/providers/datadog/users/vw_users/index.md index 0d466ded45..bd6d1e70e0 100644 --- a/docs/datadog-docs/providers/datadog/users/vw_users/index.md +++ b/docs/datadog-docs/providers/datadog/users/vw_users/index.md @@ -14,14 +14,17 @@ description: Query, monitor, and manage Datadog resources using SQL custom_edit_url: null image: /img/providers/datadog/stackql-datadog-provider-featured-image.png --- - - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + + + ## Overview - +
Namevw_users
TypeResource
Iddatadog.users.vw_users
Id
## Fields @@ -29,19 +32,19 @@ image: /img/providers/datadog/stackql-datadog-provider-featured-image.png | Name | Datatype | |:-----|:---------| -| `id` | `text` | -| `name` || -| `allowed_login_methods` || -| `created_at` || -| `disabled` || -| `email` || -| `handle` || -| `icon` || -| `mfa_enabled` || -| `modified_at` || -| `service_account` || -| `status` || -| `title` || -| `verified` || +| | `text` | +| || +| || +| || +| || +| || +| || +| || +| || +| || +| || +| || +| || +| || ## Methods No methods available for the resource diff --git a/scripts/docgen/functions.py b/scripts/docgen/functions.py index 97a6de2822..b8615373a1 100644 --- a/scripts/docgen/functions.py +++ b/scripts/docgen/functions.py @@ -49,8 +49,10 @@ def generate_front_matter(title, meta_description, description, image, keyword2= image: %s id: %s-doc slug: /providers/%s - --- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + %s """ % (title, title, meta_description, image, title, title, description) @@ -72,6 +74,7 @@ def generate_front_matter(title, meta_description, description, image, keyword2= custom_edit_url: null image: %s --- + %s """ % (title, title, keyword2, meta_description, image, description) @@ -94,8 +97,11 @@ def generate_front_matter(title, meta_description, description, image, keyword2= custom_edit_url: null image: %s --- -%s - + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +%s + """ % (title, title, keyword2, keyword3, meta_description, image, description) @@ -216,7 +222,7 @@ def generate_resource_overview(provider, serviceName, resourceObj): - +
Name%s
TypeResource
Id%s
Id
""" % (resourceObj["name"], resourceObj["id"]) @@ -226,7 +232,7 @@ def generate_resource_overview(provider, serviceName, resourceObj): - +
Name%s
TypeResource
Id%s
Id
Description%s
@@ -250,14 +256,14 @@ def generate_fields_table(provider, serviceName, resourceName, fields, is_view=F output = output + "|:-----|:---------|\n" for fieldIx, fieldRow in fields.iterrows(): if len(fieldRow["type"]) == 0: - output = output + "| `%s` ||\n" % (fieldRow["name"]) + output = output + '| ||\n' % (fieldRow["name"]) else: - output = output + "| `%s` | `%s` |\n" % (fieldRow["name"], fieldRow["type"]) + output = output + '| | `%s` |\n' % (fieldRow["name"], fieldRow["type"]) else: output = output + "| Name | Datatype | Description |\n" output = output + "|:-----|:---------|:------------|\n" for fieldIx, fieldRow in fields.iterrows(): - output = output + "| `%s` | `%s` | %s |\n" % (fieldRow["name"], fieldRow["type"], make_markdown_table_safe(fieldRow["description"])) + output = output + '| | `%s` | %s |\n' % (fieldRow["name"], fieldRow["type"], make_markdown_table_safe(fieldRow["description"])) return output def generate_methods_table(methods): @@ -268,17 +274,17 @@ def generate_methods_table(methods): output = output + "|:-----|:--------------|:----------------|\n" for methodIx, methodRow in methods.iterrows(): if (methodRow["RequiredParams"] == ""): - output = output + "| `%s` | `%s` | %s |\n" % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"]) + output = output + '| | `%s` | %s |\n' % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"]) else: - output = output + "| `%s` | `%s` | `%s` |\n" % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"]) + output = output + '| | `%s` | |\n' % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"]) else: output = output + "| Name | Accessible by | Required Params | Description |\n" output = output + "|:-----|:--------------|:----------------|:------------|\n" for methodIx, methodRow in methods.iterrows(): if (methodRow["RequiredParams"] == ""): - output = output + "| `%s` | `%s` | %s | %s |\n" % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"], make_markdown_table_safe(methodRow["description"])) + output = output + '| | `%s` | %s | %s |\n' % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"], make_markdown_table_safe(methodRow["description"])) else: - output = output + "| `%s` | `%s` | `%s` | %s |\n" % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"], make_markdown_table_safe(methodRow["description"])) + output = output + '| | `%s` | | %s |\n' % (methodRow["MethodName"], methodRow["SQLVerb"], methodRow["RequiredParams"], make_markdown_table_safe(methodRow["description"])) return output except: output = output + "No methods available for the resource\n" diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 3ccd0d3f1e..0d840d0620 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -414,8 +414,8 @@ 'datadog': { 'custom': False, 'variables': """ -- `DD_API_KEY` - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) -- `DD_APP_KEY` - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) +- - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)) +- - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys)) """, 'linux': """ AUTH='{ "datadog": { "type": "custom", "location": "header", "name": "DD-API-KEY", "credentialsenvvar": "YOUR_DD_API_KEY_VAR", "successor": { "type": "custom", "location": "header", "name": "DD-APPLICATION-KEY", "credentialsenvvar": "YOUR_DD_APP_KEY_VAR" }}}'