datadog_api_client 2.14.0 → 2.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +6 -6
- data/.generator/schemas/v1/openapi.yaml +808 -143
- data/.generator/schemas/v2/openapi.yaml +1808 -166
- data/.generator/src/generator/openapi.py +3 -1
- data/.generator/src/generator/templates/api.j2 +8 -2
- data/.generator/src/generator/templates/api_client.j2 +19 -1
- data/.generator/src/generator/templates/model_base.j2 +1 -0
- data/CHANGELOG.md +56 -0
- data/examples/v1/dashboards/CreateDashboard_1754992756.rb +44 -0
- data/examples/v1/dashboards/CreateDashboard_2278756614.rb +91 -0
- data/examples/v1/dashboards/CreateDashboard_2618036642.rb +36 -0
- data/examples/v1/dashboards/CreateDashboard_2705593938.rb +3 -0
- data/examples/v1/dashboards/CreateDashboard_3777304439.rb +50 -0
- data/examples/v1/dashboards/ListDashboards_1062671515.rb +8 -0
- data/examples/v1/monitors/CreateMonitor_1539578087.rb +36 -0
- data/examples/v1/monitors/ListMonitors_2966492814.rb +8 -0
- data/examples/v1/notebooks/ListNotebooks_788665428.rb +8 -0
- data/examples/v1/service-level-objective-corrections/ListSLOCorrection_2647266873.rb +8 -0
- data/examples/v1/service-level-objectives/ListSLOs_3036942817.rb +8 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +1 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +1 -1
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_397420811.rb +1 -1
- data/examples/v1/synthetics/ListTests_1938827783.rb +8 -0
- data/examples/v1/usage-metering/GetUsageCIApp.rb +4 -1
- data/examples/v1/usage-metering/GetUsageCWS.rb +4 -1
- data/examples/v1/usage-metering/GetUsageCloudSecurityPostureManagement.rb +1 -1
- data/examples/v2/apm-retention-filters/CreateApmRetentionFilter.rb +20 -0
- data/examples/v2/apm-retention-filters/DeleteApmRetentionFilter.rb +8 -0
- data/examples/v2/apm-retention-filters/GetApmRetentionFilter.rb +8 -0
- data/examples/v2/apm-retention-filters/ListApmRetentionFilters.rb +5 -0
- data/examples/v2/apm-retention-filters/ReorderApmRetentionFilters.rb +18 -0
- data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb +24 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +0 -3
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +0 -8
- data/examples/v2/container-images/ListContainerImages.rb +8 -0
- data/examples/v2/container-images/ListContainerImages_3088586393.rb +11 -0
- data/examples/v2/container-images/ListContainerImages_3974828736.rb +11 -0
- data/examples/v2/downtimes/CancelDowntime.rb +0 -3
- data/examples/v2/downtimes/CreateDowntime.rb +0 -3
- data/examples/v2/downtimes/GetDowntime.rb +0 -3
- data/examples/v2/downtimes/ListDowntimes.rb +0 -3
- data/examples/v2/downtimes/ListDowntimes_805770330.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +0 -3
- data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +0 -3
- data/examples/v2/downtimes/UpdateDowntime.rb +0 -3
- data/examples/v2/gcp-integration/CreateGCPSTSAccount_109518525.rb +19 -0
- data/examples/v2/powerpack/CreatePowerpack.rb +47 -0
- data/examples/v2/powerpack/DeletePowerpack.rb +8 -0
- data/examples/v2/powerpack/GetPowerpack.rb +8 -0
- data/examples/v2/powerpack/ListPowerpacks.rb +8 -0
- data/examples/v2/powerpack/ListPowerpacks_1173755071.rb +8 -0
- data/examples/v2/powerpack/UpdatePowerpack.rb +50 -0
- data/examples/v2/rum/CreateRUMApplication.rb +1 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.rb +1 -1
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule_428087276.rb +1 -1
- data/examples/v2/service-accounts/CreateServiceAccountApplicationKey.rb +5 -7
- data/examples/v2/service-accounts/DeleteServiceAccountApplicationKey.rb +7 -1
- data/examples/v2/service-accounts/GetServiceAccountApplicationKey.rb +7 -1
- data/examples/v2/service-accounts/ListServiceAccountApplicationKeys.rb +4 -1
- data/examples/v2/service-accounts/UpdateServiceAccountApplicationKey.rb +11 -9
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +23 -12
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions_2621709423.rb +53 -0
- data/examples/v2/teams/ListTeams_3592098458.rb +8 -0
- data/examples/v2/users/ListUsers_4075885358.rb +8 -0
- data/lib/datadog_api_client/api_client.rb +19 -1
- data/lib/datadog_api_client/configuration.rb +1 -7
- data/lib/datadog_api_client/inflector.rb +81 -0
- data/lib/datadog_api_client/v1/api/dashboards_api.rb +25 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +23 -20
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +21 -0
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +21 -0
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +21 -0
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +25 -3
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +6 -6
- data/lib/datadog_api_client/v1/api/webhooks_integration_api.rb +1 -1
- data/lib/datadog_api_client/v1/model_base.rb +1 -0
- data/lib/datadog_api_client/v1/models/heat_map_widget_request.rb +35 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +7 -4
- data/lib/datadog_api_client/v1/models/ip_prefixes_global.rb +94 -0
- data/lib/datadog_api_client/v1/models/ip_ranges.rb +11 -1
- data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_options_custom_schedule.rb +82 -0
- data/lib/datadog_api_client/v1/models/monitor_options_custom_schedule_recurrence.rb +100 -0
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options.rb +11 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +6 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +65 -5
- data/lib/datadog_api_client/v1/models/powerpack_template_variable_contents.rb +131 -0
- data/lib/datadog_api_client/v1/models/powerpack_template_variables.rb +94 -0
- data/lib/datadog_api_client/v1/models/powerpack_widget_definition.rb +169 -0
- data/lib/datadog_api_client/v1/models/powerpack_widget_definition_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/split_config.rb +181 -0
- data/lib/datadog_api_client/v1/models/split_config_sort_compute.rb +119 -0
- data/lib/datadog_api_client/v1/models/split_dimension.rb +98 -0
- data/lib/datadog_api_client/v1/models/split_graph_source_widget_definition.rb +70 -0
- data/lib/datadog_api_client/v1/models/split_graph_viz_size.rb +29 -0
- data/lib/datadog_api_client/v1/models/split_graph_widget_definition.rb +191 -0
- data/lib/datadog_api_client/v1/models/split_graph_widget_definition_type.rb +26 -0
- data/lib/datadog_api_client/v1/models/split_sort.rb +108 -0
- data/lib/datadog_api_client/v1/models/split_vector_entry_item.rb +125 -0
- data/lib/datadog_api_client/v1/models/sunburst_widget_request.rb +14 -4
- data/lib/datadog_api_client/v1/models/synthetics_assertion_target.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_timings_scope.rb +27 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +4 -4
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_hour.rb +8 -8
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_response.rb +2 -2
- data/lib/datadog_api_client/v1/models/usage_profiling_hour.rb +12 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +168 -8
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +168 -8
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +168 -8
- data/lib/datadog_api_client/v1/models/widget_definition.rb +8 -6
- data/lib/datadog_api_client/v2/api/apm_retention_filters_api.rb +423 -0
- data/lib/datadog_api_client/v2/api/audit_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +5 -11
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +4 -4
- data/lib/datadog_api_client/v2/api/container_images_api.rb +129 -0
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +25 -36
- data/lib/datadog_api_client/v2/api/events_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/incidents_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/logs_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/powerpack_api.rb +383 -0
- data/lib/datadog_api_client/v2/api/processes_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/rum_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +4 -4
- data/lib/datadog_api_client/v2/api/spans_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/teams_api.rb +22 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/users_api.rb +22 -0
- data/lib/datadog_api_client/v2/model_base.rb +1 -0
- data/lib/datadog_api_client/v2/models/apm_retention_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image.rb +100 -0
- data/lib/datadog_api_client/v2/models/container_image_attributes.rb +261 -0
- data/lib/datadog_api_client/v2/models/container_image_flavor.rb +120 -0
- data/lib/datadog_api_client/v2/models/container_image_group.rb +110 -0
- data/lib/datadog_api_client/v2/models/container_image_group_attributes.rb +100 -0
- data/lib/datadog_api_client/v2/models/container_image_group_images_relationships_link.rb +92 -0
- data/lib/datadog_api_client/v2/models/container_image_group_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_group_relationships_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_group_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_item.rb +63 -0
- data/lib/datadog_api_client/v2/models/container_image_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/container_image_meta_page.rb +160 -0
- data/lib/datadog_api_client/v2/models/container_image_meta_page_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/container_image_vulnerabilities.rb +140 -0
- data/lib/datadog_api_client/v2/models/container_images_response.rb +102 -0
- data/lib/datadog_api_client/v2/models/container_images_response_links.rb +130 -0
- data/lib/datadog_api_client/v2/models/data_scalar_column.rb +2 -2
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/group_scalar_column.rb +2 -2
- data/lib/datadog_api_client/v2/models/list_powerpacks_response.rb +114 -0
- data/lib/datadog_api_client/v2/models/powerpack.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpack_attributes.rb +164 -0
- data/lib/datadog_api_client/v2/models/powerpack_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget.rb +108 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget_definition.rb +162 -0
- data/lib/datadog_api_client/v2/models/powerpack_group_widget_layout.rb +177 -0
- data/lib/datadog_api_client/v2/models/powerpack_inner_widget_layout.rb +177 -0
- data/lib/datadog_api_client/v2/models/powerpack_inner_widgets.rb +108 -0
- data/lib/datadog_api_client/v2/models/powerpack_relationships.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpack_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/powerpack_response_links.rb +129 -0
- data/lib/datadog_api_client/v2/models/powerpack_template_variable.rb +110 -0
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta_pagination.rb +150 -0
- data/lib/datadog_api_client/v2/models/reorder_retention_filters_request.rb +100 -0
- data/lib/datadog_api_client/v2/models/restriction_policy_binding.rb +1 -1
- data/lib/datadog_api_client/v2/models/retention_filter.rb +140 -0
- data/lib/datadog_api_client/v2/models/retention_filter_all.rb +140 -0
- data/lib/datadog_api_client/v2/models/retention_filter_all_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/retention_filter_all_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/retention_filter_attributes.rb +181 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_attributes.rb +183 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/retention_filter_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/retention_filter_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/retention_filter_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/retention_filter_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/retention_filter_without_attributes.rb +119 -0
- data/lib/datadog_api_client/v2/models/retention_filters_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/scalar_column_type_group.rb +26 -0
- data/lib/datadog_api_client/v2/models/scalar_column_type_number.rb +26 -0
- data/lib/datadog_api_client/v2/models/scalar_meta.rb +8 -0
- data/lib/datadog_api_client/v2/models/service_definition_schema.rb +2 -1
- data/lib/datadog_api_client/v2/models/service_definition_schema_versions.rb +1 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +247 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_contact.rb +129 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_integrations.rb +90 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_link.rb +150 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_opsgenie.rb +108 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_opsgenie_region.rb +27 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_pagerduty.rb +80 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_type.rb +32 -0
- data/lib/datadog_api_client/v2/models/service_definition_v2_dot2_version.rb +26 -0
- data/lib/datadog_api_client/v2/models/service_definitions_create_request.rb +1 -0
- data/lib/datadog_api_client/v2/models/spans_filter.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_filter_create.rb +98 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/run-tests.sh +6 -5
- metadata +114 -9
- data/examples/v1/usage-metering/GetUsageCIApp_1064440884.rb +0 -8
- data/examples/v1/usage-metering/GetUsageCWS_736958514.rb +0 -8
- data/examples/v2/service-accounts/CreateServiceAccountApplicationKey_1761876297.rb +0 -17
- data/examples/v2/service-accounts/DeleteServiceAccountApplicationKey_992091161.rb +0 -11
- data/examples/v2/service-accounts/GetServiceAccountApplicationKey_819075131.rb +0 -11
- data/examples/v2/service-accounts/ListServiceAccountApplicationKeys_1268914341.rb +0 -8
- data/examples/v2/service-accounts/UpdateServiceAccountApplicationKey_768415790.rb +0 -22
|
@@ -234,21 +234,13 @@ components:
|
|
|
234
234
|
schema:
|
|
235
235
|
$ref: '#/components/schemas/IncidentRelatedObject'
|
|
236
236
|
IncidentSearchQueryQueryParameter:
|
|
237
|
-
description: 'Specifies which incidents should be returned.
|
|
238
|
-
|
|
237
|
+
description: 'Specifies which incidents should be returned. The query can contain
|
|
238
|
+
any number of incident facets
|
|
239
239
|
|
|
240
|
-
|
|
241
|
-
|
|
240
|
+
joined by `ANDs`, along with multiple values for each of those facets joined
|
|
241
|
+
by `OR`s. For
|
|
242
242
|
|
|
243
|
-
|
|
244
|
-
The query can contain any number of incident facets joined by `ANDs`, along
|
|
245
|
-
with multiple values for each of
|
|
246
|
-
|
|
247
|
-
those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2
|
|
248
|
-
OR SEV-1)"`.
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
[1]: https://app.datadoghq.com/incidents'
|
|
243
|
+
example: `state:active AND severity:(SEV-2 OR SEV-1)`.'
|
|
252
244
|
explode: false
|
|
253
245
|
in: query
|
|
254
246
|
name: query
|
|
@@ -377,6 +369,13 @@ components:
|
|
|
377
369
|
required: true
|
|
378
370
|
schema:
|
|
379
371
|
type: string
|
|
372
|
+
RetentionFilterIdParam:
|
|
373
|
+
description: The ID of the retention filter.
|
|
374
|
+
in: path
|
|
375
|
+
name: filter_id
|
|
376
|
+
required: true
|
|
377
|
+
schema:
|
|
378
|
+
type: string
|
|
380
379
|
RoleID:
|
|
381
380
|
description: The unique identifier of the role.
|
|
382
381
|
in: path
|
|
@@ -701,6 +700,15 @@ components:
|
|
|
701
700
|
type: string
|
|
702
701
|
x-enum-varnames:
|
|
703
702
|
- API_KEYS
|
|
703
|
+
ApmRetentionFilterType:
|
|
704
|
+
default: apm_retention_filter
|
|
705
|
+
description: The type of the resource.
|
|
706
|
+
enum:
|
|
707
|
+
- apm_retention_filter
|
|
708
|
+
example: apm_retention_filter
|
|
709
|
+
type: string
|
|
710
|
+
x-enum-varnames:
|
|
711
|
+
- apm_retention_filter
|
|
704
712
|
ApplicationKeyCreateAttributes:
|
|
705
713
|
description: Attributes used to create an application Key.
|
|
706
714
|
properties:
|
|
@@ -1760,7 +1768,6 @@ components:
|
|
|
1760
1768
|
- end
|
|
1761
1769
|
- status
|
|
1762
1770
|
- url
|
|
1763
|
-
- git
|
|
1764
1771
|
type: object
|
|
1765
1772
|
CIAppPipelineEventJobLevel:
|
|
1766
1773
|
default: job
|
|
@@ -1913,7 +1920,6 @@ components:
|
|
|
1913
1920
|
- end
|
|
1914
1921
|
- status
|
|
1915
1922
|
- partial_retry
|
|
1916
|
-
- git
|
|
1917
1923
|
type: object
|
|
1918
1924
|
CIAppPipelineEventPipelineLevel:
|
|
1919
1925
|
default: pipeline
|
|
@@ -2029,7 +2035,6 @@ components:
|
|
|
2029
2035
|
- start
|
|
2030
2036
|
- end
|
|
2031
2037
|
- status
|
|
2032
|
-
- git
|
|
2033
2038
|
type: object
|
|
2034
2039
|
CIAppPipelineEventStageLevel:
|
|
2035
2040
|
default: stage
|
|
@@ -2129,7 +2134,6 @@ components:
|
|
|
2129
2134
|
- start
|
|
2130
2135
|
- end
|
|
2131
2136
|
- status
|
|
2132
|
-
- git
|
|
2133
2137
|
type: object
|
|
2134
2138
|
CIAppPipelineEventStepLevel:
|
|
2135
2139
|
default: step
|
|
@@ -3437,6 +3441,316 @@ components:
|
|
|
3437
3441
|
$ref: '#/components/schemas/ConfluentResourceResponseData'
|
|
3438
3442
|
type: array
|
|
3439
3443
|
type: object
|
|
3444
|
+
ContainerImage:
|
|
3445
|
+
description: Container Image object.
|
|
3446
|
+
properties:
|
|
3447
|
+
attributes:
|
|
3448
|
+
$ref: '#/components/schemas/ContainerImageAttributes'
|
|
3449
|
+
id:
|
|
3450
|
+
description: Container Image ID.
|
|
3451
|
+
type: string
|
|
3452
|
+
type:
|
|
3453
|
+
$ref: '#/components/schemas/ContainerImageType'
|
|
3454
|
+
type: object
|
|
3455
|
+
ContainerImageAttributes:
|
|
3456
|
+
description: Attributes for a Container Image.
|
|
3457
|
+
properties:
|
|
3458
|
+
container_count:
|
|
3459
|
+
description: Number of containers running the image.
|
|
3460
|
+
format: int64
|
|
3461
|
+
type: integer
|
|
3462
|
+
image_flavors:
|
|
3463
|
+
description: 'List of platform-specific images associated with the image
|
|
3464
|
+
record.
|
|
3465
|
+
|
|
3466
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3467
|
+
items:
|
|
3468
|
+
$ref: '#/components/schemas/ContainerImageFlavor'
|
|
3469
|
+
type: array
|
|
3470
|
+
image_tags:
|
|
3471
|
+
description: List of image tags associated with the Container Image.
|
|
3472
|
+
items:
|
|
3473
|
+
description: An image tag associated with the Container Image.
|
|
3474
|
+
type: string
|
|
3475
|
+
type: array
|
|
3476
|
+
images_built_at:
|
|
3477
|
+
description: 'List of build times associated with the Container Image.
|
|
3478
|
+
|
|
3479
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3480
|
+
items:
|
|
3481
|
+
description: Time the platform-specific Container Image was built.
|
|
3482
|
+
type: string
|
|
3483
|
+
type: array
|
|
3484
|
+
name:
|
|
3485
|
+
description: Name of the Container Image.
|
|
3486
|
+
type: string
|
|
3487
|
+
os_architectures:
|
|
3488
|
+
description: List of Operating System architectures supported by the Container
|
|
3489
|
+
Image.
|
|
3490
|
+
items:
|
|
3491
|
+
description: Operating System architecture supported by the Container
|
|
3492
|
+
Image.
|
|
3493
|
+
example: amd64
|
|
3494
|
+
type: string
|
|
3495
|
+
type: array
|
|
3496
|
+
os_names:
|
|
3497
|
+
description: List of Operating System names supported by the Container Image.
|
|
3498
|
+
items:
|
|
3499
|
+
description: Operating System supported by the Container Image.
|
|
3500
|
+
example: linux
|
|
3501
|
+
type: string
|
|
3502
|
+
type: array
|
|
3503
|
+
os_versions:
|
|
3504
|
+
description: List of Operating System versions supported by the Container
|
|
3505
|
+
Image.
|
|
3506
|
+
items:
|
|
3507
|
+
description: Operating System version supported by the Container Image.
|
|
3508
|
+
type: string
|
|
3509
|
+
type: array
|
|
3510
|
+
published_at:
|
|
3511
|
+
description: Time the image was pushed to the container registry.
|
|
3512
|
+
type: string
|
|
3513
|
+
registry:
|
|
3514
|
+
description: Registry the Container Image was pushed to.
|
|
3515
|
+
type: string
|
|
3516
|
+
repo_digest:
|
|
3517
|
+
description: Digest of the compressed image manifest.
|
|
3518
|
+
type: string
|
|
3519
|
+
repository:
|
|
3520
|
+
description: Repository where the Container Image is stored in.
|
|
3521
|
+
type: string
|
|
3522
|
+
short_image:
|
|
3523
|
+
description: Short version of the Container Image name.
|
|
3524
|
+
type: string
|
|
3525
|
+
sizes:
|
|
3526
|
+
description: 'List of size for each platform-specific image associated with
|
|
3527
|
+
the image record.
|
|
3528
|
+
|
|
3529
|
+
The list contains more than 1 entry for multi-architecture images.'
|
|
3530
|
+
items:
|
|
3531
|
+
description: Size of the platform-specific Container Image.
|
|
3532
|
+
format: int64
|
|
3533
|
+
type: integer
|
|
3534
|
+
type: array
|
|
3535
|
+
sources:
|
|
3536
|
+
description: List of sources where the Container Image was collected from.
|
|
3537
|
+
items:
|
|
3538
|
+
description: Source where the Container Image was collected from.
|
|
3539
|
+
type: string
|
|
3540
|
+
type: array
|
|
3541
|
+
tags:
|
|
3542
|
+
description: List of tags associated with the Container Image.
|
|
3543
|
+
items:
|
|
3544
|
+
description: A tag associated with the Container Image.
|
|
3545
|
+
type: string
|
|
3546
|
+
type: array
|
|
3547
|
+
vulnerability_count:
|
|
3548
|
+
$ref: '#/components/schemas/ContainerImageVulnerabilities'
|
|
3549
|
+
type: object
|
|
3550
|
+
ContainerImageFlavor:
|
|
3551
|
+
description: Container Image breakdown by supported platform.
|
|
3552
|
+
properties:
|
|
3553
|
+
built_at:
|
|
3554
|
+
description: Time the platform-specific Container Image was built.
|
|
3555
|
+
type: string
|
|
3556
|
+
os_architecture:
|
|
3557
|
+
description: Operating System architecture supported by the Container Image.
|
|
3558
|
+
type: string
|
|
3559
|
+
os_name:
|
|
3560
|
+
description: Operating System name supported by the Container Image.
|
|
3561
|
+
type: string
|
|
3562
|
+
os_version:
|
|
3563
|
+
description: Operating System version supported by the Container Image.
|
|
3564
|
+
type: string
|
|
3565
|
+
size:
|
|
3566
|
+
description: Size of the platform-specific Container Image.
|
|
3567
|
+
format: int64
|
|
3568
|
+
type: integer
|
|
3569
|
+
type: object
|
|
3570
|
+
ContainerImageGroup:
|
|
3571
|
+
description: Container Image Group object.
|
|
3572
|
+
properties:
|
|
3573
|
+
attributes:
|
|
3574
|
+
$ref: '#/components/schemas/ContainerImageGroupAttributes'
|
|
3575
|
+
id:
|
|
3576
|
+
description: Container Image Group ID.
|
|
3577
|
+
type: string
|
|
3578
|
+
relationships:
|
|
3579
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationships'
|
|
3580
|
+
type:
|
|
3581
|
+
$ref: '#/components/schemas/ContainerImageGroupType'
|
|
3582
|
+
type: object
|
|
3583
|
+
ContainerImageGroupAttributes:
|
|
3584
|
+
description: Attributes for a Container Image Group.
|
|
3585
|
+
properties:
|
|
3586
|
+
count:
|
|
3587
|
+
description: Number of Container Images in the group.
|
|
3588
|
+
format: int64
|
|
3589
|
+
type: integer
|
|
3590
|
+
name:
|
|
3591
|
+
description: Name of the Container Image group.
|
|
3592
|
+
type: string
|
|
3593
|
+
tags:
|
|
3594
|
+
description: Tags from the group name parsed in key/value format.
|
|
3595
|
+
type: object
|
|
3596
|
+
type: object
|
|
3597
|
+
ContainerImageGroupImagesRelationshipsLink:
|
|
3598
|
+
description: Relationships to Container Images inside a Container Image Group.
|
|
3599
|
+
properties:
|
|
3600
|
+
data:
|
|
3601
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationshipsData'
|
|
3602
|
+
links:
|
|
3603
|
+
$ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks'
|
|
3604
|
+
type: object
|
|
3605
|
+
ContainerImageGroupRelationships:
|
|
3606
|
+
description: Relationships inside a Container Image Group.
|
|
3607
|
+
properties:
|
|
3608
|
+
container_images:
|
|
3609
|
+
$ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink'
|
|
3610
|
+
type: object
|
|
3611
|
+
ContainerImageGroupRelationshipsData:
|
|
3612
|
+
description: Links data.
|
|
3613
|
+
items:
|
|
3614
|
+
description: A link data.
|
|
3615
|
+
type: string
|
|
3616
|
+
type: array
|
|
3617
|
+
ContainerImageGroupRelationshipsLinks:
|
|
3618
|
+
description: Links attributes.
|
|
3619
|
+
properties:
|
|
3620
|
+
related:
|
|
3621
|
+
description: Link to related Container Images.
|
|
3622
|
+
type: string
|
|
3623
|
+
type: object
|
|
3624
|
+
ContainerImageGroupType:
|
|
3625
|
+
default: container_image_group
|
|
3626
|
+
description: Type of Container Image Group.
|
|
3627
|
+
enum:
|
|
3628
|
+
- container_image_group
|
|
3629
|
+
example: container_image_group
|
|
3630
|
+
type: string
|
|
3631
|
+
x-enum-varnames:
|
|
3632
|
+
- CONTAINER_IMAGE_GROUP
|
|
3633
|
+
ContainerImageItem:
|
|
3634
|
+
description: Possible Container Image models.
|
|
3635
|
+
oneOf:
|
|
3636
|
+
- $ref: '#/components/schemas/ContainerImage'
|
|
3637
|
+
- $ref: '#/components/schemas/ContainerImageGroup'
|
|
3638
|
+
ContainerImageMeta:
|
|
3639
|
+
description: Response metadata object.
|
|
3640
|
+
properties:
|
|
3641
|
+
pagination:
|
|
3642
|
+
$ref: '#/components/schemas/ContainerImageMetaPage'
|
|
3643
|
+
type: object
|
|
3644
|
+
ContainerImageMetaPage:
|
|
3645
|
+
description: Paging attributes.
|
|
3646
|
+
properties:
|
|
3647
|
+
cursor:
|
|
3648
|
+
description: The cursor used to get the current results, if any.
|
|
3649
|
+
type: string
|
|
3650
|
+
limit:
|
|
3651
|
+
description: Number of results returned
|
|
3652
|
+
format: int32
|
|
3653
|
+
maximum: 10000
|
|
3654
|
+
minimum: 0
|
|
3655
|
+
type: integer
|
|
3656
|
+
next_cursor:
|
|
3657
|
+
description: The cursor used to get the next results, if any.
|
|
3658
|
+
type: string
|
|
3659
|
+
prev_cursor:
|
|
3660
|
+
description: The cursor used to get the previous results, if any.
|
|
3661
|
+
nullable: true
|
|
3662
|
+
type: string
|
|
3663
|
+
total:
|
|
3664
|
+
description: Total number of records that match the query.
|
|
3665
|
+
format: int64
|
|
3666
|
+
type: integer
|
|
3667
|
+
type:
|
|
3668
|
+
$ref: '#/components/schemas/ContainerImageMetaPageType'
|
|
3669
|
+
type: object
|
|
3670
|
+
ContainerImageMetaPageType:
|
|
3671
|
+
default: cursor_limit
|
|
3672
|
+
description: Type of Container Image pagination.
|
|
3673
|
+
enum:
|
|
3674
|
+
- cursor_limit
|
|
3675
|
+
example: cursor_limit
|
|
3676
|
+
type: string
|
|
3677
|
+
x-enum-varnames:
|
|
3678
|
+
- CURSOR_LIMIT
|
|
3679
|
+
ContainerImageType:
|
|
3680
|
+
default: container_image
|
|
3681
|
+
description: Type of Container Image.
|
|
3682
|
+
enum:
|
|
3683
|
+
- container_image
|
|
3684
|
+
example: container_image
|
|
3685
|
+
type: string
|
|
3686
|
+
x-enum-varnames:
|
|
3687
|
+
- CONTAINER_IMAGE
|
|
3688
|
+
ContainerImageVulnerabilities:
|
|
3689
|
+
description: Vulnerability counts associated with the Container Image.
|
|
3690
|
+
properties:
|
|
3691
|
+
asset_id:
|
|
3692
|
+
description: ID of the Container Image.
|
|
3693
|
+
type: string
|
|
3694
|
+
critical:
|
|
3695
|
+
description: Number of vulnerabilities with CVSS Critical severity.
|
|
3696
|
+
format: int64
|
|
3697
|
+
type: integer
|
|
3698
|
+
high:
|
|
3699
|
+
description: Number of vulnerabilities with CVSS High severity.
|
|
3700
|
+
format: int64
|
|
3701
|
+
type: integer
|
|
3702
|
+
low:
|
|
3703
|
+
description: Number of vulnerabilities with CVSS Low severity.
|
|
3704
|
+
format: int64
|
|
3705
|
+
type: integer
|
|
3706
|
+
medium:
|
|
3707
|
+
description: Number of vulnerabilities with CVSS Medium severity.
|
|
3708
|
+
format: int64
|
|
3709
|
+
type: integer
|
|
3710
|
+
none:
|
|
3711
|
+
description: Number of vulnerabilities with CVSS None severity.
|
|
3712
|
+
format: int64
|
|
3713
|
+
type: integer
|
|
3714
|
+
unknown:
|
|
3715
|
+
description: Number of vulnerabilities with an unknown CVSS severity.
|
|
3716
|
+
format: int64
|
|
3717
|
+
type: integer
|
|
3718
|
+
type: object
|
|
3719
|
+
ContainerImagesResponse:
|
|
3720
|
+
description: List of Container Images.
|
|
3721
|
+
properties:
|
|
3722
|
+
data:
|
|
3723
|
+
description: Array of Container Image objects.
|
|
3724
|
+
items:
|
|
3725
|
+
$ref: '#/components/schemas/ContainerImageItem'
|
|
3726
|
+
type: array
|
|
3727
|
+
links:
|
|
3728
|
+
$ref: '#/components/schemas/ContainerImagesResponseLinks'
|
|
3729
|
+
meta:
|
|
3730
|
+
$ref: '#/components/schemas/ContainerImageMeta'
|
|
3731
|
+
type: object
|
|
3732
|
+
ContainerImagesResponseLinks:
|
|
3733
|
+
description: Pagination links.
|
|
3734
|
+
properties:
|
|
3735
|
+
first:
|
|
3736
|
+
description: Link to the first page.
|
|
3737
|
+
type: string
|
|
3738
|
+
last:
|
|
3739
|
+
description: Link to the last page.
|
|
3740
|
+
nullable: true
|
|
3741
|
+
type: string
|
|
3742
|
+
next:
|
|
3743
|
+
description: Link to the next page.
|
|
3744
|
+
nullable: true
|
|
3745
|
+
type: string
|
|
3746
|
+
prev:
|
|
3747
|
+
description: Link to previous page.
|
|
3748
|
+
nullable: true
|
|
3749
|
+
type: string
|
|
3750
|
+
self:
|
|
3751
|
+
description: Link to current page.
|
|
3752
|
+
type: string
|
|
3753
|
+
type: object
|
|
3440
3754
|
ContentEncoding:
|
|
3441
3755
|
description: HTTP header used to compress the media-type.
|
|
3442
3756
|
enum:
|
|
@@ -3712,9 +4026,7 @@ components:
|
|
|
3712
4026
|
example: a
|
|
3713
4027
|
type: string
|
|
3714
4028
|
type:
|
|
3715
|
-
|
|
3716
|
-
example: number
|
|
3717
|
-
type: string
|
|
4029
|
+
$ref: '#/components/schemas/ScalarColumnTypeNumber'
|
|
3718
4030
|
values:
|
|
3719
4031
|
description: The array of numerical values for one formula or query.
|
|
3720
4032
|
example:
|
|
@@ -3723,6 +4035,7 @@ components:
|
|
|
3723
4035
|
description: An individual value for a given column and group-by.
|
|
3724
4036
|
example: 0.5
|
|
3725
4037
|
format: double
|
|
4038
|
+
nullable: true
|
|
3726
4039
|
type: number
|
|
3727
4040
|
type: array
|
|
3728
4041
|
type: object
|
|
@@ -4017,9 +4330,8 @@ components:
|
|
|
4017
4330
|
properties:
|
|
4018
4331
|
id:
|
|
4019
4332
|
description: Monitor ID of the downtime.
|
|
4020
|
-
example: 12345
|
|
4021
|
-
|
|
4022
|
-
type: integer
|
|
4333
|
+
example: '12345'
|
|
4334
|
+
type: string
|
|
4023
4335
|
type:
|
|
4024
4336
|
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
|
4025
4337
|
type: object
|
|
@@ -5389,6 +5701,13 @@ components:
|
|
|
5389
5701
|
GCPSTSServiceAccountAttributes:
|
|
5390
5702
|
description: Attributes associated with your service account.
|
|
5391
5703
|
properties:
|
|
5704
|
+
account_tags:
|
|
5705
|
+
description: Tags to be associated with GCP metrics and service checks from
|
|
5706
|
+
your account.
|
|
5707
|
+
items:
|
|
5708
|
+
description: Account Level Tag
|
|
5709
|
+
type: string
|
|
5710
|
+
type: array
|
|
5392
5711
|
automute:
|
|
5393
5712
|
description: Silence monitors for expected GCE instance shutdowns.
|
|
5394
5713
|
type: boolean
|
|
@@ -5510,9 +5829,7 @@ components:
|
|
|
5510
5829
|
example: env
|
|
5511
5830
|
type: string
|
|
5512
5831
|
type:
|
|
5513
|
-
|
|
5514
|
-
example: group
|
|
5515
|
-
type: string
|
|
5832
|
+
$ref: '#/components/schemas/ScalarColumnTypeGroup'
|
|
5516
5833
|
values:
|
|
5517
5834
|
description: The array of tag values for each group found for the results
|
|
5518
5835
|
of the formulas or queries.
|
|
@@ -7652,6 +7969,24 @@ components:
|
|
|
7652
7969
|
- data
|
|
7653
7970
|
- meta
|
|
7654
7971
|
type: object
|
|
7972
|
+
ListPowerpacksResponse:
|
|
7973
|
+
description: Response object which includes all powerpack configurations.
|
|
7974
|
+
properties:
|
|
7975
|
+
data:
|
|
7976
|
+
description: List of powerpack definitions.
|
|
7977
|
+
items:
|
|
7978
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
7979
|
+
type: array
|
|
7980
|
+
included:
|
|
7981
|
+
description: Array of objects related to the users.
|
|
7982
|
+
items:
|
|
7983
|
+
$ref: '#/components/schemas/User'
|
|
7984
|
+
type: array
|
|
7985
|
+
links:
|
|
7986
|
+
$ref: '#/components/schemas/PowerpackResponseLinks'
|
|
7987
|
+
meta:
|
|
7988
|
+
$ref: '#/components/schemas/PowerpacksResponseMeta'
|
|
7989
|
+
type: object
|
|
7655
7990
|
ListTeamsInclude:
|
|
7656
7991
|
description: Included related resources optionally requested.
|
|
7657
7992
|
enum:
|
|
@@ -10556,70 +10891,363 @@ components:
|
|
|
10556
10891
|
type: string
|
|
10557
10892
|
x-enum-varnames:
|
|
10558
10893
|
- PERMISSIONS
|
|
10559
|
-
|
|
10560
|
-
description:
|
|
10894
|
+
Powerpack:
|
|
10895
|
+
description: Powerpacks are templated groups of dashboard widgets you can save
|
|
10896
|
+
from an existing dashboard and turn into reusable packs in the widget tray.
|
|
10561
10897
|
properties:
|
|
10562
|
-
|
|
10563
|
-
$ref: '#/components/schemas/
|
|
10898
|
+
data:
|
|
10899
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
10564
10900
|
type: object
|
|
10565
|
-
|
|
10566
|
-
description:
|
|
10901
|
+
PowerpackAttributes:
|
|
10902
|
+
description: Powerpack attribute object.
|
|
10567
10903
|
properties:
|
|
10568
|
-
|
|
10569
|
-
description:
|
|
10570
|
-
|
|
10571
|
-
|
|
10572
|
-
parameters with the addition of the `page[cursor]`.'
|
|
10573
|
-
example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd
|
|
10904
|
+
description:
|
|
10905
|
+
description: Description of this powerpack.
|
|
10906
|
+
example: Powerpack for ABC
|
|
10574
10907
|
type: string
|
|
10575
|
-
|
|
10576
|
-
|
|
10577
|
-
|
|
10578
|
-
|
|
10579
|
-
|
|
10580
|
-
type:
|
|
10581
|
-
|
|
10582
|
-
|
|
10583
|
-
|
|
10584
|
-
|
|
10585
|
-
data:
|
|
10586
|
-
description: Array of process summary objects.
|
|
10908
|
+
group_widget:
|
|
10909
|
+
$ref: '#/components/schemas/PowerpackGroupWidget'
|
|
10910
|
+
name:
|
|
10911
|
+
description: Name of the powerpack.
|
|
10912
|
+
example: Sample Powerpack
|
|
10913
|
+
type: string
|
|
10914
|
+
tags:
|
|
10915
|
+
description: List of tags to identify this powerpack.
|
|
10916
|
+
example:
|
|
10917
|
+
- tag:foo1
|
|
10587
10918
|
items:
|
|
10588
|
-
|
|
10919
|
+
maxLength: 80
|
|
10920
|
+
type: string
|
|
10921
|
+
maxItems: 8
|
|
10589
10922
|
type: array
|
|
10590
|
-
|
|
10591
|
-
|
|
10923
|
+
template_variables:
|
|
10924
|
+
description: List of template variables for this powerpack.
|
|
10925
|
+
example:
|
|
10926
|
+
- defaults:
|
|
10927
|
+
- '*'
|
|
10928
|
+
name: test
|
|
10929
|
+
items:
|
|
10930
|
+
$ref: '#/components/schemas/PowerpackTemplateVariable'
|
|
10931
|
+
type: array
|
|
10932
|
+
required:
|
|
10933
|
+
- group_widget
|
|
10934
|
+
- name
|
|
10592
10935
|
type: object
|
|
10593
|
-
|
|
10594
|
-
description:
|
|
10936
|
+
PowerpackData:
|
|
10937
|
+
description: Powerpack data object.
|
|
10595
10938
|
properties:
|
|
10596
10939
|
attributes:
|
|
10597
|
-
$ref: '#/components/schemas/
|
|
10940
|
+
$ref: '#/components/schemas/PowerpackAttributes'
|
|
10598
10941
|
id:
|
|
10599
|
-
description:
|
|
10942
|
+
description: ID of the powerpack.
|
|
10600
10943
|
type: string
|
|
10944
|
+
relationships:
|
|
10945
|
+
$ref: '#/components/schemas/PowerpackRelationships'
|
|
10601
10946
|
type:
|
|
10602
|
-
|
|
10947
|
+
description: Type of widget, must be powerpack.
|
|
10948
|
+
example: powerpack
|
|
10949
|
+
type: string
|
|
10603
10950
|
type: object
|
|
10604
|
-
|
|
10605
|
-
description:
|
|
10951
|
+
PowerpackGroupWidget:
|
|
10952
|
+
description: Powerpack group widget definition object.
|
|
10606
10953
|
properties:
|
|
10607
|
-
|
|
10608
|
-
|
|
10954
|
+
definition:
|
|
10955
|
+
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
|
|
10956
|
+
layout:
|
|
10957
|
+
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
|
|
10958
|
+
required:
|
|
10959
|
+
- definition
|
|
10960
|
+
type: object
|
|
10961
|
+
PowerpackGroupWidgetDefinition:
|
|
10962
|
+
description: Powerpack group widget object.
|
|
10963
|
+
properties:
|
|
10964
|
+
layout_type:
|
|
10965
|
+
description: Layout type of widgets.
|
|
10966
|
+
example: ordered
|
|
10609
10967
|
type: string
|
|
10610
|
-
|
|
10611
|
-
description:
|
|
10968
|
+
show_title:
|
|
10969
|
+
description: Boolean indicating whether powerpack group title should be
|
|
10970
|
+
visible or not.
|
|
10971
|
+
example: true
|
|
10972
|
+
type: boolean
|
|
10973
|
+
title:
|
|
10974
|
+
description: Name for the group widget.
|
|
10975
|
+
example: Sample Powerpack
|
|
10612
10976
|
type: string
|
|
10613
|
-
|
|
10614
|
-
description:
|
|
10615
|
-
|
|
10616
|
-
type:
|
|
10617
|
-
|
|
10618
|
-
description:
|
|
10619
|
-
|
|
10620
|
-
|
|
10621
|
-
|
|
10622
|
-
|
|
10977
|
+
type:
|
|
10978
|
+
description: Type of widget, must be group.
|
|
10979
|
+
example: group
|
|
10980
|
+
type: string
|
|
10981
|
+
widgets:
|
|
10982
|
+
description: Widgets inside the powerpack.
|
|
10983
|
+
example:
|
|
10984
|
+
- definition:
|
|
10985
|
+
content: example
|
|
10986
|
+
type: note
|
|
10987
|
+
layout:
|
|
10988
|
+
height: 5
|
|
10989
|
+
width: 10
|
|
10990
|
+
x: 0
|
|
10991
|
+
y: 0
|
|
10992
|
+
items:
|
|
10993
|
+
$ref: '#/components/schemas/PowerpackInnerWidgets'
|
|
10994
|
+
type: array
|
|
10995
|
+
required:
|
|
10996
|
+
- widgets
|
|
10997
|
+
- layout_type
|
|
10998
|
+
- type
|
|
10999
|
+
type: object
|
|
11000
|
+
PowerpackGroupWidgetLayout:
|
|
11001
|
+
description: Powerpack group widget layout.
|
|
11002
|
+
properties:
|
|
11003
|
+
height:
|
|
11004
|
+
description: The height of the widget. Should be a non-negative integer.
|
|
11005
|
+
example: 0
|
|
11006
|
+
format: int64
|
|
11007
|
+
minimum: 0
|
|
11008
|
+
type: integer
|
|
11009
|
+
width:
|
|
11010
|
+
description: The width of the widget. Should be a non-negative integer.
|
|
11011
|
+
example: 0
|
|
11012
|
+
format: int64
|
|
11013
|
+
minimum: 0
|
|
11014
|
+
type: integer
|
|
11015
|
+
x:
|
|
11016
|
+
description: The position of the widget on the x (horizontal) axis. Should
|
|
11017
|
+
be a non-negative integer.
|
|
11018
|
+
example: 0
|
|
11019
|
+
format: int64
|
|
11020
|
+
minimum: 0
|
|
11021
|
+
type: integer
|
|
11022
|
+
y:
|
|
11023
|
+
description: The position of the widget on the y (vertical) axis. Should
|
|
11024
|
+
be a non-negative integer.
|
|
11025
|
+
example: 0
|
|
11026
|
+
format: int64
|
|
11027
|
+
minimum: 0
|
|
11028
|
+
type: integer
|
|
11029
|
+
required:
|
|
11030
|
+
- x
|
|
11031
|
+
- y
|
|
11032
|
+
- width
|
|
11033
|
+
- height
|
|
11034
|
+
type: object
|
|
11035
|
+
PowerpackInnerWidgetLayout:
|
|
11036
|
+
description: Powerpack inner widget layout.
|
|
11037
|
+
properties:
|
|
11038
|
+
height:
|
|
11039
|
+
description: The height of the widget. Should be a non-negative integer.
|
|
11040
|
+
example: 0
|
|
11041
|
+
format: int64
|
|
11042
|
+
minimum: 0
|
|
11043
|
+
type: integer
|
|
11044
|
+
width:
|
|
11045
|
+
description: The width of the widget. Should be a non-negative integer.
|
|
11046
|
+
example: 0
|
|
11047
|
+
format: int64
|
|
11048
|
+
minimum: 0
|
|
11049
|
+
type: integer
|
|
11050
|
+
x:
|
|
11051
|
+
description: The position of the widget on the x (horizontal) axis. Should
|
|
11052
|
+
be a non-negative integer.
|
|
11053
|
+
example: 0
|
|
11054
|
+
format: int64
|
|
11055
|
+
minimum: 0
|
|
11056
|
+
type: integer
|
|
11057
|
+
y:
|
|
11058
|
+
description: The position of the widget on the y (vertical) axis. Should
|
|
11059
|
+
be a non-negative integer.
|
|
11060
|
+
example: 0
|
|
11061
|
+
format: int64
|
|
11062
|
+
minimum: 0
|
|
11063
|
+
type: integer
|
|
11064
|
+
required:
|
|
11065
|
+
- x
|
|
11066
|
+
- y
|
|
11067
|
+
- width
|
|
11068
|
+
- height
|
|
11069
|
+
type: object
|
|
11070
|
+
PowerpackInnerWidgets:
|
|
11071
|
+
description: Powerpack group widget definition of individual widgets.
|
|
11072
|
+
properties:
|
|
11073
|
+
definition:
|
|
11074
|
+
additionalProperties: {}
|
|
11075
|
+
description: Information about widget.
|
|
11076
|
+
example:
|
|
11077
|
+
definition:
|
|
11078
|
+
content: example
|
|
11079
|
+
type: note
|
|
11080
|
+
type: object
|
|
11081
|
+
layout:
|
|
11082
|
+
$ref: '#/components/schemas/PowerpackInnerWidgetLayout'
|
|
11083
|
+
required:
|
|
11084
|
+
- definition
|
|
11085
|
+
type: object
|
|
11086
|
+
PowerpackRelationships:
|
|
11087
|
+
description: Powerpack relationship object.
|
|
11088
|
+
properties:
|
|
11089
|
+
author:
|
|
11090
|
+
$ref: '#/components/schemas/Creator'
|
|
11091
|
+
type: object
|
|
11092
|
+
PowerpackResponse:
|
|
11093
|
+
description: Response object which includes a single powerpack configuration.
|
|
11094
|
+
properties:
|
|
11095
|
+
data:
|
|
11096
|
+
$ref: '#/components/schemas/PowerpackData'
|
|
11097
|
+
included:
|
|
11098
|
+
description: Array of objects related to the users.
|
|
11099
|
+
items:
|
|
11100
|
+
$ref: '#/components/schemas/User'
|
|
11101
|
+
type: array
|
|
11102
|
+
readOnly: true
|
|
11103
|
+
type: object
|
|
11104
|
+
PowerpackResponseLinks:
|
|
11105
|
+
description: Links attributes.
|
|
11106
|
+
properties:
|
|
11107
|
+
first:
|
|
11108
|
+
description: Link to last page.
|
|
11109
|
+
type: string
|
|
11110
|
+
last:
|
|
11111
|
+
description: Link to first page.
|
|
11112
|
+
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25
|
|
11113
|
+
nullable: true
|
|
11114
|
+
type: string
|
|
11115
|
+
next:
|
|
11116
|
+
description: Link for the next set of results.
|
|
11117
|
+
example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25
|
|
11118
|
+
type: string
|
|
11119
|
+
prev:
|
|
11120
|
+
description: Link for the previous set of results.
|
|
11121
|
+
nullable: true
|
|
11122
|
+
type: string
|
|
11123
|
+
self:
|
|
11124
|
+
description: Link to current page.
|
|
11125
|
+
example: https://app.datadoghq.com/api/v2/powerpacks
|
|
11126
|
+
type: string
|
|
11127
|
+
type: object
|
|
11128
|
+
PowerpackTemplateVariable:
|
|
11129
|
+
description: Powerpack template variables.
|
|
11130
|
+
properties:
|
|
11131
|
+
defaults:
|
|
11132
|
+
description: One or many template variable default values within the saved
|
|
11133
|
+
view, which are unioned together using `OR` if more than one is specified.
|
|
11134
|
+
items:
|
|
11135
|
+
description: One or many default values of the template variable.
|
|
11136
|
+
minLength: 1
|
|
11137
|
+
type: string
|
|
11138
|
+
type: array
|
|
11139
|
+
name:
|
|
11140
|
+
description: The name of the variable.
|
|
11141
|
+
example: datacenter
|
|
11142
|
+
type: string
|
|
11143
|
+
required:
|
|
11144
|
+
- name
|
|
11145
|
+
type: object
|
|
11146
|
+
PowerpacksResponseMeta:
|
|
11147
|
+
description: Powerpack response metadata.
|
|
11148
|
+
properties:
|
|
11149
|
+
pagination:
|
|
11150
|
+
$ref: '#/components/schemas/PowerpacksResponseMetaPagination'
|
|
11151
|
+
type: object
|
|
11152
|
+
PowerpacksResponseMetaPagination:
|
|
11153
|
+
description: Powerpack response pagination metadata.
|
|
11154
|
+
properties:
|
|
11155
|
+
first_offset:
|
|
11156
|
+
description: The first offset.
|
|
11157
|
+
format: int64
|
|
11158
|
+
type: integer
|
|
11159
|
+
last_offset:
|
|
11160
|
+
description: The last offset.
|
|
11161
|
+
format: int64
|
|
11162
|
+
type: integer
|
|
11163
|
+
limit:
|
|
11164
|
+
description: Pagination limit.
|
|
11165
|
+
format: int64
|
|
11166
|
+
type: integer
|
|
11167
|
+
next_offset:
|
|
11168
|
+
description: The next offset.
|
|
11169
|
+
format: int64
|
|
11170
|
+
type: integer
|
|
11171
|
+
offset:
|
|
11172
|
+
description: The offset.
|
|
11173
|
+
format: int64
|
|
11174
|
+
type: integer
|
|
11175
|
+
prev_offset:
|
|
11176
|
+
description: The previous offset.
|
|
11177
|
+
format: int64
|
|
11178
|
+
type: integer
|
|
11179
|
+
total:
|
|
11180
|
+
description: Total results.
|
|
11181
|
+
format: int64
|
|
11182
|
+
type: integer
|
|
11183
|
+
type:
|
|
11184
|
+
description: Offset type.
|
|
11185
|
+
type: string
|
|
11186
|
+
type: object
|
|
11187
|
+
ProcessSummariesMeta:
|
|
11188
|
+
description: Response metadata object.
|
|
11189
|
+
properties:
|
|
11190
|
+
page:
|
|
11191
|
+
$ref: '#/components/schemas/ProcessSummariesMetaPage'
|
|
11192
|
+
type: object
|
|
11193
|
+
ProcessSummariesMetaPage:
|
|
11194
|
+
description: Paging attributes.
|
|
11195
|
+
properties:
|
|
11196
|
+
after:
|
|
11197
|
+
description: 'The cursor used to get the next results, if any. To make the
|
|
11198
|
+
next request, use the same
|
|
11199
|
+
|
|
11200
|
+
parameters with the addition of the `page[cursor]`.'
|
|
11201
|
+
example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd
|
|
11202
|
+
type: string
|
|
11203
|
+
size:
|
|
11204
|
+
description: Number of results returned.
|
|
11205
|
+
format: int32
|
|
11206
|
+
maximum: 10000
|
|
11207
|
+
minimum: 0
|
|
11208
|
+
type: integer
|
|
11209
|
+
type: object
|
|
11210
|
+
ProcessSummariesResponse:
|
|
11211
|
+
description: List of process summaries.
|
|
11212
|
+
properties:
|
|
11213
|
+
data:
|
|
11214
|
+
description: Array of process summary objects.
|
|
11215
|
+
items:
|
|
11216
|
+
$ref: '#/components/schemas/ProcessSummary'
|
|
11217
|
+
type: array
|
|
11218
|
+
meta:
|
|
11219
|
+
$ref: '#/components/schemas/ProcessSummariesMeta'
|
|
11220
|
+
type: object
|
|
11221
|
+
ProcessSummary:
|
|
11222
|
+
description: Process summary object.
|
|
11223
|
+
properties:
|
|
11224
|
+
attributes:
|
|
11225
|
+
$ref: '#/components/schemas/ProcessSummaryAttributes'
|
|
11226
|
+
id:
|
|
11227
|
+
description: Process ID.
|
|
11228
|
+
type: string
|
|
11229
|
+
type:
|
|
11230
|
+
$ref: '#/components/schemas/ProcessSummaryType'
|
|
11231
|
+
type: object
|
|
11232
|
+
ProcessSummaryAttributes:
|
|
11233
|
+
description: Attributes for a process summary.
|
|
11234
|
+
properties:
|
|
11235
|
+
cmdline:
|
|
11236
|
+
description: Process command line.
|
|
11237
|
+
type: string
|
|
11238
|
+
host:
|
|
11239
|
+
description: Host running the process.
|
|
11240
|
+
type: string
|
|
11241
|
+
pid:
|
|
11242
|
+
description: Process ID.
|
|
11243
|
+
format: int64
|
|
11244
|
+
type: integer
|
|
11245
|
+
ppid:
|
|
11246
|
+
description: Parent process ID.
|
|
11247
|
+
format: int64
|
|
11248
|
+
type: integer
|
|
11249
|
+
start:
|
|
11250
|
+
description: Time the process was started.
|
|
10623
11251
|
type: string
|
|
10624
11252
|
tags:
|
|
10625
11253
|
description: List of tags associated with the process.
|
|
@@ -11723,6 +12351,17 @@ components:
|
|
|
11723
12351
|
required:
|
|
11724
12352
|
- data
|
|
11725
12353
|
type: object
|
|
12354
|
+
ReorderRetentionFiltersRequest:
|
|
12355
|
+
description: A list of retention filters to reorder.
|
|
12356
|
+
properties:
|
|
12357
|
+
data:
|
|
12358
|
+
description: A list of retention filters objects.
|
|
12359
|
+
items:
|
|
12360
|
+
$ref: '#/components/schemas/RetentionFilterWithoutAttributes'
|
|
12361
|
+
type: array
|
|
12362
|
+
required:
|
|
12363
|
+
- data
|
|
12364
|
+
type: object
|
|
11726
12365
|
ResponseMetaAttributes:
|
|
11727
12366
|
description: Object describing meta attributes of response.
|
|
11728
12367
|
properties:
|
|
@@ -11766,8 +12405,8 @@ components:
|
|
|
11766
12405
|
description: 'An array of principals. A principal is a subject or group
|
|
11767
12406
|
of subjects.
|
|
11768
12407
|
|
|
11769
|
-
Each principal is formatted as `type:id`. Supported types: `role`, `team
|
|
11770
|
-
|
|
12408
|
+
Each principal is formatted as `type:id`. Supported types: `role`, `team`,
|
|
12409
|
+
`user`, and `org`.
|
|
11771
12410
|
|
|
11772
12411
|
The org ID can be obtained through the api/v2/current_user API.
|
|
11773
12412
|
|
|
@@ -11778,7 +12417,7 @@ components:
|
|
|
11778
12417
|
description: 'Subject or group of subjects. Each principal is formatted
|
|
11779
12418
|
as `type:id`.
|
|
11780
12419
|
|
|
11781
|
-
Supported types: `role`, `team
|
|
12420
|
+
Supported types: `role`, `team`, `user`, and `org`.
|
|
11782
12421
|
|
|
11783
12422
|
The org ID can be obtained through the api/v2/current_user API.
|
|
11784
12423
|
|
|
@@ -11818,6 +12457,255 @@ components:
|
|
|
11818
12457
|
required:
|
|
11819
12458
|
- data
|
|
11820
12459
|
type: object
|
|
12460
|
+
RetentionFilter:
|
|
12461
|
+
description: The definition of the retention filter.
|
|
12462
|
+
properties:
|
|
12463
|
+
attributes:
|
|
12464
|
+
$ref: '#/components/schemas/RetentionFilterAttributes'
|
|
12465
|
+
id:
|
|
12466
|
+
description: The ID of the retention filter.
|
|
12467
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
12468
|
+
type: string
|
|
12469
|
+
type:
|
|
12470
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12471
|
+
required:
|
|
12472
|
+
- id
|
|
12473
|
+
- type
|
|
12474
|
+
- attributes
|
|
12475
|
+
type: object
|
|
12476
|
+
RetentionFilterAll:
|
|
12477
|
+
description: The definition of the retention filter.
|
|
12478
|
+
properties:
|
|
12479
|
+
attributes:
|
|
12480
|
+
$ref: '#/components/schemas/RetentionFilterAllAttributes'
|
|
12481
|
+
id:
|
|
12482
|
+
description: The ID of the retention filter.
|
|
12483
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
12484
|
+
type: string
|
|
12485
|
+
type:
|
|
12486
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12487
|
+
required:
|
|
12488
|
+
- id
|
|
12489
|
+
- type
|
|
12490
|
+
- attributes
|
|
12491
|
+
type: object
|
|
12492
|
+
RetentionFilterAllAttributes:
|
|
12493
|
+
description: The attributes of the retention filter.
|
|
12494
|
+
properties:
|
|
12495
|
+
created_at:
|
|
12496
|
+
description: The creation timestamp of the retention filter.
|
|
12497
|
+
format: int64
|
|
12498
|
+
type: integer
|
|
12499
|
+
created_by:
|
|
12500
|
+
description: The creator of the retention filter.
|
|
12501
|
+
type: string
|
|
12502
|
+
editable:
|
|
12503
|
+
description: Shows whether the filter can be edited.
|
|
12504
|
+
example: true
|
|
12505
|
+
type: boolean
|
|
12506
|
+
enabled:
|
|
12507
|
+
description: The status of the retention filter (Enabled/Disabled).
|
|
12508
|
+
example: true
|
|
12509
|
+
type: boolean
|
|
12510
|
+
execution_order:
|
|
12511
|
+
description: The execution order of the retention filter.
|
|
12512
|
+
format: int64
|
|
12513
|
+
type: integer
|
|
12514
|
+
filter:
|
|
12515
|
+
$ref: '#/components/schemas/SpansFilter'
|
|
12516
|
+
filter_type:
|
|
12517
|
+
$ref: '#/components/schemas/RetentionFilterAllType'
|
|
12518
|
+
modified_at:
|
|
12519
|
+
description: The modification timestamp of the retention filter.
|
|
12520
|
+
format: int64
|
|
12521
|
+
type: integer
|
|
12522
|
+
modified_by:
|
|
12523
|
+
description: The modifier of the retention filter.
|
|
12524
|
+
type: string
|
|
12525
|
+
name:
|
|
12526
|
+
description: The name of the retention filter.
|
|
12527
|
+
example: my retention filter
|
|
12528
|
+
type: string
|
|
12529
|
+
rate:
|
|
12530
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
12531
|
+
filter,
|
|
12532
|
+
|
|
12533
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
12534
|
+
example: 1.0
|
|
12535
|
+
format: double
|
|
12536
|
+
type: number
|
|
12537
|
+
type: object
|
|
12538
|
+
RetentionFilterAllType:
|
|
12539
|
+
default: spans-sampling-processor
|
|
12540
|
+
description: The type of retention filter.
|
|
12541
|
+
enum:
|
|
12542
|
+
- spans-sampling-processor
|
|
12543
|
+
- spans-errors-sampling-processor
|
|
12544
|
+
- spans-appsec-sampling-processor
|
|
12545
|
+
type: string
|
|
12546
|
+
x-enum-varnames:
|
|
12547
|
+
- SPANS_SAMPLING_PROCESSOR
|
|
12548
|
+
- SPANS_ERRORS_SAMPLING_PROCESSOR
|
|
12549
|
+
- SPANS_APPSEC_SAMPLING_PROCESSOR
|
|
12550
|
+
RetentionFilterAttributes:
|
|
12551
|
+
description: The attributes of the retention filter.
|
|
12552
|
+
properties:
|
|
12553
|
+
created_at:
|
|
12554
|
+
description: The creation timestamp of the retention filter.
|
|
12555
|
+
format: int64
|
|
12556
|
+
type: integer
|
|
12557
|
+
created_by:
|
|
12558
|
+
description: The creator of the retention filter.
|
|
12559
|
+
type: string
|
|
12560
|
+
editable:
|
|
12561
|
+
description: Shows whether the filter can be edited.
|
|
12562
|
+
example: true
|
|
12563
|
+
type: boolean
|
|
12564
|
+
enabled:
|
|
12565
|
+
description: The status of the retention filter (Enabled/Disabled).
|
|
12566
|
+
example: true
|
|
12567
|
+
type: boolean
|
|
12568
|
+
execution_order:
|
|
12569
|
+
description: The execution order of the retention filter.
|
|
12570
|
+
format: int64
|
|
12571
|
+
type: integer
|
|
12572
|
+
filter:
|
|
12573
|
+
$ref: '#/components/schemas/SpansFilter'
|
|
12574
|
+
filter_type:
|
|
12575
|
+
$ref: '#/components/schemas/RetentionFilterType'
|
|
12576
|
+
modified_at:
|
|
12577
|
+
description: The modification timestamp of the retention filter.
|
|
12578
|
+
format: int64
|
|
12579
|
+
type: integer
|
|
12580
|
+
modified_by:
|
|
12581
|
+
description: The modifier of the retention filter.
|
|
12582
|
+
type: string
|
|
12583
|
+
name:
|
|
12584
|
+
description: The name of the retention filter.
|
|
12585
|
+
example: my retention filter
|
|
12586
|
+
type: string
|
|
12587
|
+
rate:
|
|
12588
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
12589
|
+
filter,
|
|
12590
|
+
|
|
12591
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
12592
|
+
example: 1.0
|
|
12593
|
+
format: double
|
|
12594
|
+
type: number
|
|
12595
|
+
type: object
|
|
12596
|
+
RetentionFilterCreateAttributes:
|
|
12597
|
+
description: The object describing the configuration of the retention filter
|
|
12598
|
+
to create/update.
|
|
12599
|
+
properties:
|
|
12600
|
+
enabled:
|
|
12601
|
+
description: Enable/Disable the retention filter.
|
|
12602
|
+
example: true
|
|
12603
|
+
type: boolean
|
|
12604
|
+
filter:
|
|
12605
|
+
$ref: '#/components/schemas/SpansFilterCreate'
|
|
12606
|
+
filter_type:
|
|
12607
|
+
$ref: '#/components/schemas/RetentionFilterType'
|
|
12608
|
+
name:
|
|
12609
|
+
description: The name of the retention filter.
|
|
12610
|
+
example: my retention filter
|
|
12611
|
+
type: string
|
|
12612
|
+
rate:
|
|
12613
|
+
description: 'Sample rate to apply to spans going through this retention
|
|
12614
|
+
filter,
|
|
12615
|
+
|
|
12616
|
+
a value of 1.0 keeps all spans matching the query.'
|
|
12617
|
+
example: 1.0
|
|
12618
|
+
format: double
|
|
12619
|
+
type: number
|
|
12620
|
+
required:
|
|
12621
|
+
- name
|
|
12622
|
+
- filter
|
|
12623
|
+
- enabled
|
|
12624
|
+
- filter_type
|
|
12625
|
+
- rate
|
|
12626
|
+
type: object
|
|
12627
|
+
RetentionFilterCreateData:
|
|
12628
|
+
description: The body of the retention filter to be created.
|
|
12629
|
+
properties:
|
|
12630
|
+
attributes:
|
|
12631
|
+
$ref: '#/components/schemas/RetentionFilterCreateAttributes'
|
|
12632
|
+
type:
|
|
12633
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12634
|
+
required:
|
|
12635
|
+
- attributes
|
|
12636
|
+
- type
|
|
12637
|
+
type: object
|
|
12638
|
+
RetentionFilterCreateRequest:
|
|
12639
|
+
description: The body of the retention filter to be created.
|
|
12640
|
+
properties:
|
|
12641
|
+
data:
|
|
12642
|
+
$ref: '#/components/schemas/RetentionFilterCreateData'
|
|
12643
|
+
required:
|
|
12644
|
+
- data
|
|
12645
|
+
type: object
|
|
12646
|
+
RetentionFilterResponse:
|
|
12647
|
+
description: The retention filters definition.
|
|
12648
|
+
properties:
|
|
12649
|
+
data:
|
|
12650
|
+
$ref: '#/components/schemas/RetentionFilter'
|
|
12651
|
+
type: object
|
|
12652
|
+
RetentionFilterType:
|
|
12653
|
+
default: spans-sampling-processor
|
|
12654
|
+
description: The type of retention filter. The value should always be spans-sampling-processor.
|
|
12655
|
+
enum:
|
|
12656
|
+
- spans-sampling-processor
|
|
12657
|
+
example: spans-sampling-processor
|
|
12658
|
+
type: string
|
|
12659
|
+
x-enum-varnames:
|
|
12660
|
+
- SPANS_SAMPLING_PROCESSOR
|
|
12661
|
+
RetentionFilterUpdateData:
|
|
12662
|
+
description: The body of the retention filter to be updated.
|
|
12663
|
+
properties:
|
|
12664
|
+
attributes:
|
|
12665
|
+
$ref: '#/components/schemas/RetentionFilterCreateAttributes'
|
|
12666
|
+
id:
|
|
12667
|
+
description: The ID of the retention filter.
|
|
12668
|
+
example: retention-filter-id
|
|
12669
|
+
type: string
|
|
12670
|
+
type:
|
|
12671
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12672
|
+
required:
|
|
12673
|
+
- id
|
|
12674
|
+
- attributes
|
|
12675
|
+
- type
|
|
12676
|
+
type: object
|
|
12677
|
+
RetentionFilterUpdateRequest:
|
|
12678
|
+
description: The body of the retention filter to be updated.
|
|
12679
|
+
properties:
|
|
12680
|
+
data:
|
|
12681
|
+
$ref: '#/components/schemas/RetentionFilterUpdateData'
|
|
12682
|
+
required:
|
|
12683
|
+
- data
|
|
12684
|
+
type: object
|
|
12685
|
+
RetentionFilterWithoutAttributes:
|
|
12686
|
+
description: The retention filter object .
|
|
12687
|
+
properties:
|
|
12688
|
+
id:
|
|
12689
|
+
description: The ID of the retention filter.
|
|
12690
|
+
example: 7RBOb7dLSYWI01yc3pIH8w
|
|
12691
|
+
type: string
|
|
12692
|
+
type:
|
|
12693
|
+
$ref: '#/components/schemas/ApmRetentionFilterType'
|
|
12694
|
+
required:
|
|
12695
|
+
- id
|
|
12696
|
+
- type
|
|
12697
|
+
type: object
|
|
12698
|
+
RetentionFiltersResponse:
|
|
12699
|
+
description: An ordered list of retention filters.
|
|
12700
|
+
properties:
|
|
12701
|
+
data:
|
|
12702
|
+
description: A list of retention filters objects.
|
|
12703
|
+
items:
|
|
12704
|
+
$ref: '#/components/schemas/RetentionFilterAll'
|
|
12705
|
+
type: array
|
|
12706
|
+
required:
|
|
12707
|
+
- data
|
|
12708
|
+
type: object
|
|
11821
12709
|
Role:
|
|
11822
12710
|
description: Role object returned by the API.
|
|
11823
12711
|
properties:
|
|
@@ -12112,6 +13000,24 @@ components:
|
|
|
12112
13000
|
oneOf:
|
|
12113
13001
|
- $ref: '#/components/schemas/GroupScalarColumn'
|
|
12114
13002
|
- $ref: '#/components/schemas/DataScalarColumn'
|
|
13003
|
+
ScalarColumnTypeGroup:
|
|
13004
|
+
default: group
|
|
13005
|
+
description: The type of column present for groups.
|
|
13006
|
+
enum:
|
|
13007
|
+
- group
|
|
13008
|
+
example: group
|
|
13009
|
+
type: string
|
|
13010
|
+
x-enum-varnames:
|
|
13011
|
+
- GROUP
|
|
13012
|
+
ScalarColumnTypeNumber:
|
|
13013
|
+
default: number
|
|
13014
|
+
description: The type of column present for numbers.
|
|
13015
|
+
enum:
|
|
13016
|
+
- number
|
|
13017
|
+
example: number
|
|
13018
|
+
type: string
|
|
13019
|
+
x-enum-varnames:
|
|
13020
|
+
- NUMBER
|
|
12115
13021
|
ScalarFormulaQueryRequest:
|
|
12116
13022
|
description: A wrapper request around one scalar query to be executed.
|
|
12117
13023
|
properties:
|
|
@@ -12216,6 +13122,7 @@ components:
|
|
|
12216
13122
|
If the second element is not present, the API returns null.'
|
|
12217
13123
|
items:
|
|
12218
13124
|
$ref: '#/components/schemas/Unit'
|
|
13125
|
+
nullable: true
|
|
12219
13126
|
type: array
|
|
12220
13127
|
type: object
|
|
12221
13128
|
ScalarQuery:
|
|
@@ -14397,6 +15304,7 @@ components:
|
|
|
14397
15304
|
- $ref: '#/components/schemas/ServiceDefinitionV1'
|
|
14398
15305
|
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
14399
15306
|
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
15307
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
|
|
14400
15308
|
type: object
|
|
14401
15309
|
ServiceDefinitionSchemaVersions:
|
|
14402
15310
|
description: Schema versions
|
|
@@ -14404,11 +15312,13 @@ components:
|
|
|
14404
15312
|
- v1
|
|
14405
15313
|
- v2
|
|
14406
15314
|
- v2.1
|
|
15315
|
+
- v2.2
|
|
14407
15316
|
type: string
|
|
14408
15317
|
x-enum-varnames:
|
|
14409
15318
|
- V1
|
|
14410
15319
|
- V2
|
|
14411
15320
|
- V2_1
|
|
15321
|
+
- V2_2
|
|
14412
15322
|
ServiceDefinitionV1:
|
|
14413
15323
|
deprecated: true
|
|
14414
15324
|
description: Deprecated - Service definition V1 for providing additional service
|
|
@@ -14783,33 +15693,230 @@ components:
|
|
|
14783
15693
|
ServiceDefinitionV2Dot1MSTeams:
|
|
14784
15694
|
description: Service owner's Microsoft Teams.
|
|
14785
15695
|
properties:
|
|
14786
|
-
contact:
|
|
14787
|
-
description: Contact value.
|
|
14788
|
-
example: https://teams.microsoft.com/myteam
|
|
14789
|
-
type: string
|
|
15696
|
+
contact:
|
|
15697
|
+
description: Contact value.
|
|
15698
|
+
example: https://teams.microsoft.com/myteam
|
|
15699
|
+
type: string
|
|
15700
|
+
name:
|
|
15701
|
+
description: Contact Microsoft Teams.
|
|
15702
|
+
example: My team channel
|
|
15703
|
+
type: string
|
|
15704
|
+
type:
|
|
15705
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
|
|
15706
|
+
required:
|
|
15707
|
+
- type
|
|
15708
|
+
- contact
|
|
15709
|
+
type: object
|
|
15710
|
+
ServiceDefinitionV2Dot1MSTeamsType:
|
|
15711
|
+
description: Contact type.
|
|
15712
|
+
enum:
|
|
15713
|
+
- microsoft-teams
|
|
15714
|
+
example: microsoft-teams
|
|
15715
|
+
type: string
|
|
15716
|
+
x-enum-varnames:
|
|
15717
|
+
- MICROSOFT_TEAMS
|
|
15718
|
+
ServiceDefinitionV2Dot1Opsgenie:
|
|
15719
|
+
description: Opsgenie integration for the service.
|
|
15720
|
+
properties:
|
|
15721
|
+
region:
|
|
15722
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
|
|
15723
|
+
service-url:
|
|
15724
|
+
description: Opsgenie service url.
|
|
15725
|
+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
15726
|
+
type: string
|
|
15727
|
+
required:
|
|
15728
|
+
- service-url
|
|
15729
|
+
type: object
|
|
15730
|
+
ServiceDefinitionV2Dot1OpsgenieRegion:
|
|
15731
|
+
description: Opsgenie instance region.
|
|
15732
|
+
enum:
|
|
15733
|
+
- US
|
|
15734
|
+
- EU
|
|
15735
|
+
example: US
|
|
15736
|
+
type: string
|
|
15737
|
+
x-enum-varnames:
|
|
15738
|
+
- US
|
|
15739
|
+
- EU
|
|
15740
|
+
ServiceDefinitionV2Dot1Pagerduty:
|
|
15741
|
+
description: PagerDuty integration for the service.
|
|
15742
|
+
properties:
|
|
15743
|
+
service-url:
|
|
15744
|
+
description: PagerDuty service url.
|
|
15745
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
15746
|
+
type: string
|
|
15747
|
+
type: object
|
|
15748
|
+
ServiceDefinitionV2Dot1Slack:
|
|
15749
|
+
description: Service owner's Slack channel.
|
|
15750
|
+
properties:
|
|
15751
|
+
contact:
|
|
15752
|
+
description: Slack Channel.
|
|
15753
|
+
example: https://yourcompany.slack.com/archives/channel123
|
|
15754
|
+
type: string
|
|
15755
|
+
name:
|
|
15756
|
+
description: Contact Slack.
|
|
15757
|
+
example: Team Slack
|
|
15758
|
+
type: string
|
|
15759
|
+
type:
|
|
15760
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
|
15761
|
+
required:
|
|
15762
|
+
- type
|
|
15763
|
+
- contact
|
|
15764
|
+
type: object
|
|
15765
|
+
ServiceDefinitionV2Dot1SlackType:
|
|
15766
|
+
description: Contact type.
|
|
15767
|
+
enum:
|
|
15768
|
+
- slack
|
|
15769
|
+
example: slack
|
|
15770
|
+
type: string
|
|
15771
|
+
x-enum-varnames:
|
|
15772
|
+
- SLACK
|
|
15773
|
+
ServiceDefinitionV2Dot1Version:
|
|
15774
|
+
default: v2.1
|
|
15775
|
+
description: Schema version being used.
|
|
15776
|
+
enum:
|
|
15777
|
+
- v2.1
|
|
15778
|
+
example: v2.1
|
|
15779
|
+
type: string
|
|
15780
|
+
x-enum-varnames:
|
|
15781
|
+
- V2_1
|
|
15782
|
+
ServiceDefinitionV2Dot2:
|
|
15783
|
+
description: Service definition v2.2 for providing service metadata and integrations.
|
|
15784
|
+
properties:
|
|
15785
|
+
application:
|
|
15786
|
+
description: Identifier for a group of related services serving a product
|
|
15787
|
+
feature, which the service is a part of.
|
|
15788
|
+
example: my-app
|
|
15789
|
+
type: string
|
|
15790
|
+
contacts:
|
|
15791
|
+
description: A list of contacts related to the services.
|
|
15792
|
+
items:
|
|
15793
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
|
|
15794
|
+
type: array
|
|
15795
|
+
dd-service:
|
|
15796
|
+
description: Unique identifier of the service. Must be unique across all
|
|
15797
|
+
services and is used to match with a service in Datadog.
|
|
15798
|
+
example: my-service
|
|
15799
|
+
type: string
|
|
15800
|
+
description:
|
|
15801
|
+
description: A short description of the service.
|
|
15802
|
+
example: My service description
|
|
15803
|
+
type: string
|
|
15804
|
+
extensions:
|
|
15805
|
+
additionalProperties: {}
|
|
15806
|
+
description: Extensions to v2.2 schema.
|
|
15807
|
+
example:
|
|
15808
|
+
myorg/extension: extensionValue
|
|
15809
|
+
type: object
|
|
15810
|
+
integrations:
|
|
15811
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
|
|
15812
|
+
langauges:
|
|
15813
|
+
description: 'The service''s programming language. Datadog recognizes the
|
|
15814
|
+
following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
|
|
15815
|
+
and `c++`.'
|
|
15816
|
+
example:
|
|
15817
|
+
- dotnet
|
|
15818
|
+
- go
|
|
15819
|
+
- java
|
|
15820
|
+
- js
|
|
15821
|
+
- php
|
|
15822
|
+
- python
|
|
15823
|
+
- ruby
|
|
15824
|
+
- c++
|
|
15825
|
+
items:
|
|
15826
|
+
type: string
|
|
15827
|
+
type: array
|
|
15828
|
+
lifecycle:
|
|
15829
|
+
description: The current life cycle phase of the service.
|
|
15830
|
+
example: sandbox
|
|
15831
|
+
type: string
|
|
15832
|
+
links:
|
|
15833
|
+
description: A list of links related to the services.
|
|
15834
|
+
items:
|
|
15835
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Link'
|
|
15836
|
+
type: array
|
|
15837
|
+
schema-version:
|
|
15838
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
|
|
15839
|
+
tags:
|
|
15840
|
+
description: A set of custom tags.
|
|
15841
|
+
example:
|
|
15842
|
+
- my:tag
|
|
15843
|
+
- service:tag
|
|
15844
|
+
items:
|
|
15845
|
+
type: string
|
|
15846
|
+
type: array
|
|
15847
|
+
team:
|
|
15848
|
+
description: Team that owns the service. It is used to locate a team defined
|
|
15849
|
+
in Datadog Teams if it exists.
|
|
15850
|
+
example: my-team
|
|
15851
|
+
type: string
|
|
15852
|
+
tier:
|
|
15853
|
+
description: Importance of the service.
|
|
15854
|
+
example: High
|
|
15855
|
+
type: string
|
|
15856
|
+
type:
|
|
15857
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
|
|
15858
|
+
required:
|
|
15859
|
+
- schema-version
|
|
15860
|
+
- dd-service
|
|
15861
|
+
type: object
|
|
15862
|
+
ServiceDefinitionV2Dot2Contact:
|
|
15863
|
+
description: Service owner's contacts information.
|
|
15864
|
+
properties:
|
|
15865
|
+
contact:
|
|
15866
|
+
description: Contact value.
|
|
15867
|
+
example: https://teams.microsoft.com/myteam
|
|
15868
|
+
type: string
|
|
15869
|
+
name:
|
|
15870
|
+
description: Contact Name.
|
|
15871
|
+
example: My team channel
|
|
15872
|
+
type: string
|
|
15873
|
+
type:
|
|
15874
|
+
description: 'Contact type. Datadog recognizes the following types: `email`,
|
|
15875
|
+
`slack`, and `microsoft-teams`.'
|
|
15876
|
+
example: slack
|
|
15877
|
+
type: string
|
|
15878
|
+
required:
|
|
15879
|
+
- type
|
|
15880
|
+
- contact
|
|
15881
|
+
type: object
|
|
15882
|
+
ServiceDefinitionV2Dot2Integrations:
|
|
15883
|
+
description: Third party integrations that Datadog supports.
|
|
15884
|
+
properties:
|
|
15885
|
+
opsgenie:
|
|
15886
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie'
|
|
15887
|
+
pagerduty:
|
|
15888
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty'
|
|
15889
|
+
type: object
|
|
15890
|
+
ServiceDefinitionV2Dot2Link:
|
|
15891
|
+
description: Service's external links.
|
|
15892
|
+
properties:
|
|
14790
15893
|
name:
|
|
14791
|
-
description:
|
|
14792
|
-
example:
|
|
15894
|
+
description: Link name.
|
|
15895
|
+
example: Runbook
|
|
15896
|
+
type: string
|
|
15897
|
+
provider:
|
|
15898
|
+
description: Link provider.
|
|
15899
|
+
example: Github
|
|
14793
15900
|
type: string
|
|
14794
15901
|
type:
|
|
14795
|
-
|
|
15902
|
+
description: 'Link type. Datadog recognizes the following types: `runbook`,
|
|
15903
|
+
`doc`, `repo`, `dashboard`, and `other`.'
|
|
15904
|
+
example: runbook
|
|
15905
|
+
type: string
|
|
15906
|
+
url:
|
|
15907
|
+
description: Link URL.
|
|
15908
|
+
example: https://my-runbook
|
|
15909
|
+
type: string
|
|
14796
15910
|
required:
|
|
15911
|
+
- name
|
|
14797
15912
|
- type
|
|
14798
|
-
-
|
|
15913
|
+
- url
|
|
14799
15914
|
type: object
|
|
14800
|
-
|
|
14801
|
-
description: Contact type.
|
|
14802
|
-
enum:
|
|
14803
|
-
- microsoft-teams
|
|
14804
|
-
example: microsoft-teams
|
|
14805
|
-
type: string
|
|
14806
|
-
x-enum-varnames:
|
|
14807
|
-
- MICROSOFT_TEAMS
|
|
14808
|
-
ServiceDefinitionV2Dot1Opsgenie:
|
|
15915
|
+
ServiceDefinitionV2Dot2Opsgenie:
|
|
14809
15916
|
description: Opsgenie integration for the service.
|
|
14810
15917
|
properties:
|
|
14811
15918
|
region:
|
|
14812
|
-
$ref: '#/components/schemas/
|
|
15919
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion'
|
|
14813
15920
|
service-url:
|
|
14814
15921
|
description: Opsgenie service url.
|
|
14815
15922
|
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
@@ -14817,7 +15924,7 @@ components:
|
|
|
14817
15924
|
required:
|
|
14818
15925
|
- service-url
|
|
14819
15926
|
type: object
|
|
14820
|
-
|
|
15927
|
+
ServiceDefinitionV2Dot2OpsgenieRegion:
|
|
14821
15928
|
description: Opsgenie instance region.
|
|
14822
15929
|
enum:
|
|
14823
15930
|
- US
|
|
@@ -14827,7 +15934,7 @@ components:
|
|
|
14827
15934
|
x-enum-varnames:
|
|
14828
15935
|
- US
|
|
14829
15936
|
- EU
|
|
14830
|
-
|
|
15937
|
+
ServiceDefinitionV2Dot2Pagerduty:
|
|
14831
15938
|
description: PagerDuty integration for the service.
|
|
14832
15939
|
properties:
|
|
14833
15940
|
service-url:
|
|
@@ -14835,40 +15942,35 @@ components:
|
|
|
14835
15942
|
example: https://my-org.pagerduty.com/service-directory/PMyService
|
|
14836
15943
|
type: string
|
|
14837
15944
|
type: object
|
|
14838
|
-
|
|
14839
|
-
description:
|
|
14840
|
-
properties:
|
|
14841
|
-
contact:
|
|
14842
|
-
description: Slack Channel.
|
|
14843
|
-
example: https://yourcompany.slack.com/archives/channel123
|
|
14844
|
-
type: string
|
|
14845
|
-
name:
|
|
14846
|
-
description: Contact Slack.
|
|
14847
|
-
example: Team Slack
|
|
14848
|
-
type: string
|
|
14849
|
-
type:
|
|
14850
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
|
14851
|
-
required:
|
|
14852
|
-
- type
|
|
14853
|
-
- contact
|
|
14854
|
-
type: object
|
|
14855
|
-
ServiceDefinitionV2Dot1SlackType:
|
|
14856
|
-
description: Contact type.
|
|
15945
|
+
ServiceDefinitionV2Dot2Type:
|
|
15946
|
+
description: The type of service.
|
|
14857
15947
|
enum:
|
|
14858
|
-
-
|
|
14859
|
-
|
|
15948
|
+
- web
|
|
15949
|
+
- db
|
|
15950
|
+
- cache
|
|
15951
|
+
- function
|
|
15952
|
+
- browser
|
|
15953
|
+
- mobile
|
|
15954
|
+
- custom
|
|
15955
|
+
example: web
|
|
14860
15956
|
type: string
|
|
14861
15957
|
x-enum-varnames:
|
|
14862
|
-
-
|
|
14863
|
-
|
|
14864
|
-
|
|
15958
|
+
- WEB
|
|
15959
|
+
- DB
|
|
15960
|
+
- CACHE
|
|
15961
|
+
- FUNCTION
|
|
15962
|
+
- BROSWER
|
|
15963
|
+
- MOBILE
|
|
15964
|
+
- CUSTOM
|
|
15965
|
+
ServiceDefinitionV2Dot2Version:
|
|
15966
|
+
default: v2.2
|
|
14865
15967
|
description: Schema version being used.
|
|
14866
15968
|
enum:
|
|
14867
|
-
- v2.
|
|
14868
|
-
example: v2.
|
|
15969
|
+
- v2.2
|
|
15970
|
+
example: v2.2
|
|
14869
15971
|
type: string
|
|
14870
15972
|
x-enum-varnames:
|
|
14871
|
-
-
|
|
15973
|
+
- V2_2
|
|
14872
15974
|
ServiceDefinitionV2Email:
|
|
14873
15975
|
description: Service owner's email.
|
|
14874
15976
|
properties:
|
|
@@ -15052,6 +16154,7 @@ components:
|
|
|
15052
16154
|
ServiceDefinitionsCreateRequest:
|
|
15053
16155
|
description: Create service definitions request.
|
|
15054
16156
|
oneOf:
|
|
16157
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
|
|
15055
16158
|
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
|
15056
16159
|
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
|
15057
16160
|
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
|
@@ -15447,6 +16550,25 @@ components:
|
|
|
15447
16550
|
x-enum-varnames:
|
|
15448
16551
|
- TIMESERIES
|
|
15449
16552
|
- TOTAL
|
|
16553
|
+
SpansFilter:
|
|
16554
|
+
description: The spans filter used to index spans.
|
|
16555
|
+
properties:
|
|
16556
|
+
query:
|
|
16557
|
+
description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
|
|
16558
|
+
example: '@http.status_code:200 service:my-service'
|
|
16559
|
+
type: string
|
|
16560
|
+
type: object
|
|
16561
|
+
SpansFilterCreate:
|
|
16562
|
+
description: The spans filter. Spans matching this filter will be indexed and
|
|
16563
|
+
stored.
|
|
16564
|
+
properties:
|
|
16565
|
+
query:
|
|
16566
|
+
description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
|
|
16567
|
+
example: '@http.status_code:200 service:my-service'
|
|
16568
|
+
type: string
|
|
16569
|
+
required:
|
|
16570
|
+
- query
|
|
16571
|
+
type: object
|
|
15450
16572
|
SpansGroupBy:
|
|
15451
16573
|
description: A group by rule.
|
|
15452
16574
|
properties:
|
|
@@ -17219,6 +18341,12 @@ components:
|
|
|
17219
18341
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
17220
18342
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
17221
18343
|
when those definitions are maintained by Datadog.
|
|
18344
|
+
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
|
|
18345
|
+
the API.
|
|
18346
|
+
ci_visibility_read: View CI Visibility.
|
|
18347
|
+
create_webhooks: Create webhooks integrations.
|
|
18348
|
+
dashboards_public_share: Generate public and authenticated links to share
|
|
18349
|
+
dashboards or embeddable graphs externally.
|
|
17222
18350
|
dashboards_read: View dashboards.
|
|
17223
18351
|
dashboards_write: Create and change dashboards.
|
|
17224
18352
|
events_read: Read Events data.
|
|
@@ -17232,12 +18360,28 @@ components:
|
|
|
17232
18360
|
an organization. Mute and unmute hosts. The ability to write monitors
|
|
17233
18361
|
is not required to set downtimes.
|
|
17234
18362
|
monitors_read: View monitors.
|
|
18363
|
+
monitors_write: Edit, mute, and delete individual monitors.
|
|
17235
18364
|
security_monitoring_filters_read: Read Security Filters.
|
|
17236
18365
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
17237
18366
|
security_monitoring_findings_read: View CSPM Findings.
|
|
17238
18367
|
security_monitoring_rules_read: Read Detection Rules.
|
|
17239
18368
|
security_monitoring_rules_write: Create and edit Detection Rules.
|
|
17240
18369
|
security_monitoring_signals_read: View Security Signals.
|
|
18370
|
+
security_monitoring_suppressions_read: Read Rule Suppressions.
|
|
18371
|
+
security_monitoring_suppressions_write: Write Rule Suppressions.
|
|
18372
|
+
slos_corrections: Apply, edit, and delete SLO status corrections. A user
|
|
18373
|
+
with this permission can make status corrections, even if they do not
|
|
18374
|
+
have permission to edit those SLOs.
|
|
18375
|
+
slos_read: View SLOs and status corrections.
|
|
18376
|
+
slos_write: Create, edit, and delete SLOs.
|
|
18377
|
+
synthetics_global_variable_read: View, search, and use Synthetics global
|
|
18378
|
+
variables.
|
|
18379
|
+
synthetics_global_variable_write: Create, edit, and delete global variables
|
|
18380
|
+
for Synthetics.
|
|
18381
|
+
synthetics_private_location_read: View, search, and use Synthetics private
|
|
18382
|
+
locations.
|
|
18383
|
+
synthetics_private_location_write: Create and delete private locations
|
|
18384
|
+
in addition to having access to the associated installation guidelines.
|
|
17241
18385
|
synthetics_read: List and view configured Synthetic tests and test results.
|
|
17242
18386
|
synthetics_write: Create, edit, and delete Synthetic tests.
|
|
17243
18387
|
teams_manage: Manage Teams. Create, delete, rename, and edit metadata
|
|
@@ -17568,6 +18712,149 @@ paths:
|
|
|
17568
18712
|
tags:
|
|
17569
18713
|
- Spans Metrics
|
|
17570
18714
|
x-codegen-request-body-name: body
|
|
18715
|
+
/api/v2/apm/config/retention-filters:
|
|
18716
|
+
get:
|
|
18717
|
+
description: Get the list of APM retention filters.
|
|
18718
|
+
operationId: ListApmRetentionFilters
|
|
18719
|
+
responses:
|
|
18720
|
+
'200':
|
|
18721
|
+
content:
|
|
18722
|
+
application/json:
|
|
18723
|
+
schema:
|
|
18724
|
+
$ref: '#/components/schemas/RetentionFiltersResponse'
|
|
18725
|
+
description: OK
|
|
18726
|
+
'403':
|
|
18727
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18728
|
+
'429':
|
|
18729
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18730
|
+
summary: List all APM retention filters
|
|
18731
|
+
tags:
|
|
18732
|
+
- APM Retention Filters
|
|
18733
|
+
post:
|
|
18734
|
+
description: 'Create a retention filter to index spans in your organization.
|
|
18735
|
+
|
|
18736
|
+
Returns the retention filter definition when the request is successful.'
|
|
18737
|
+
operationId: CreateApmRetentionFilter
|
|
18738
|
+
requestBody:
|
|
18739
|
+
content:
|
|
18740
|
+
application/json:
|
|
18741
|
+
schema:
|
|
18742
|
+
$ref: '#/components/schemas/RetentionFilterCreateRequest'
|
|
18743
|
+
description: The definition of the new retention filter.
|
|
18744
|
+
required: true
|
|
18745
|
+
responses:
|
|
18746
|
+
'200':
|
|
18747
|
+
content:
|
|
18748
|
+
application/json:
|
|
18749
|
+
schema:
|
|
18750
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
18751
|
+
description: OK
|
|
18752
|
+
'400':
|
|
18753
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
18754
|
+
'403':
|
|
18755
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18756
|
+
'409':
|
|
18757
|
+
$ref: '#/components/responses/ConflictResponse'
|
|
18758
|
+
'429':
|
|
18759
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18760
|
+
summary: Create a retention filter
|
|
18761
|
+
tags:
|
|
18762
|
+
- APM Retention Filters
|
|
18763
|
+
x-codegen-request-body-name: body
|
|
18764
|
+
/api/v2/apm/config/retention-filters-execution-order:
|
|
18765
|
+
put:
|
|
18766
|
+
description: Re-order the execution order of retention filters.
|
|
18767
|
+
operationId: ReorderApmRetentionFilters
|
|
18768
|
+
requestBody:
|
|
18769
|
+
content:
|
|
18770
|
+
application/json:
|
|
18771
|
+
schema:
|
|
18772
|
+
$ref: '#/components/schemas/ReorderRetentionFiltersRequest'
|
|
18773
|
+
description: The list of retention filters in the new order.
|
|
18774
|
+
required: true
|
|
18775
|
+
responses:
|
|
18776
|
+
'200':
|
|
18777
|
+
description: OK
|
|
18778
|
+
'400':
|
|
18779
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
18780
|
+
'403':
|
|
18781
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18782
|
+
'429':
|
|
18783
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18784
|
+
summary: Re-order retention filters
|
|
18785
|
+
tags:
|
|
18786
|
+
- APM Retention Filters
|
|
18787
|
+
x-codegen-request-body-name: body
|
|
18788
|
+
/api/v2/apm/config/retention-filters/{filter_id}:
|
|
18789
|
+
delete:
|
|
18790
|
+
description: Delete a specific retention filter from your organization.
|
|
18791
|
+
operationId: DeleteApmRetentionFilter
|
|
18792
|
+
parameters:
|
|
18793
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
18794
|
+
responses:
|
|
18795
|
+
'200':
|
|
18796
|
+
description: OK
|
|
18797
|
+
'403':
|
|
18798
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18799
|
+
'404':
|
|
18800
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
18801
|
+
'429':
|
|
18802
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18803
|
+
summary: Delete a retention filter
|
|
18804
|
+
tags:
|
|
18805
|
+
- APM Retention Filters
|
|
18806
|
+
get:
|
|
18807
|
+
description: Get an APM retention filter.
|
|
18808
|
+
operationId: GetApmRetentionFilter
|
|
18809
|
+
parameters:
|
|
18810
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
18811
|
+
responses:
|
|
18812
|
+
'200':
|
|
18813
|
+
content:
|
|
18814
|
+
application/json:
|
|
18815
|
+
schema:
|
|
18816
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
18817
|
+
description: OK
|
|
18818
|
+
'403':
|
|
18819
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18820
|
+
'404':
|
|
18821
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
18822
|
+
'429':
|
|
18823
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18824
|
+
summary: Get a given APM retention filter
|
|
18825
|
+
tags:
|
|
18826
|
+
- APM Retention Filters
|
|
18827
|
+
put:
|
|
18828
|
+
description: Update a retention filter from your organization.
|
|
18829
|
+
operationId: UpdateApmRetentionFilter
|
|
18830
|
+
parameters:
|
|
18831
|
+
- $ref: '#/components/parameters/RetentionFilterIdParam'
|
|
18832
|
+
requestBody:
|
|
18833
|
+
content:
|
|
18834
|
+
application/json:
|
|
18835
|
+
schema:
|
|
18836
|
+
$ref: '#/components/schemas/RetentionFilterUpdateRequest'
|
|
18837
|
+
description: The updated definition of the retention filter.
|
|
18838
|
+
required: true
|
|
18839
|
+
responses:
|
|
18840
|
+
'200':
|
|
18841
|
+
content:
|
|
18842
|
+
application/json:
|
|
18843
|
+
schema:
|
|
18844
|
+
$ref: '#/components/schemas/RetentionFilterResponse'
|
|
18845
|
+
description: OK
|
|
18846
|
+
'400':
|
|
18847
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
18848
|
+
'403':
|
|
18849
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18850
|
+
'404':
|
|
18851
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
18852
|
+
'429':
|
|
18853
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18854
|
+
summary: Update a retention filter
|
|
18855
|
+
tags:
|
|
18856
|
+
- APM Retention Filters
|
|
18857
|
+
x-codegen-request-body-name: body
|
|
17571
18858
|
/api/v2/application_keys:
|
|
17572
18859
|
get:
|
|
17573
18860
|
description: List all application keys available for your org
|
|
@@ -18121,12 +19408,12 @@ paths:
|
|
|
18121
19408
|
schema:
|
|
18122
19409
|
$ref: '#/components/schemas/HTTPCIAppErrors'
|
|
18123
19410
|
description: Service Unavailable
|
|
19411
|
+
security:
|
|
19412
|
+
- apiKeyAuth: []
|
|
18124
19413
|
summary: Send pipeline event
|
|
18125
19414
|
tags:
|
|
18126
19415
|
- CI Visibility Pipelines
|
|
18127
19416
|
x-codegen-request-body-name: body
|
|
18128
|
-
x-unstable: '**Note**: This API endpoint is in private beta. Request access
|
|
18129
|
-
[here](https://docs.google.com/forms/d/e/1FAIpQLSdNejCvhMbdBW5nnGly1yvmYMn2Wpj4JOI0zKIiEx6O6I2dbQ/viewform).'
|
|
18130
19417
|
/api/v2/ci/pipelines/analytics/aggregate:
|
|
18131
19418
|
post:
|
|
18132
19419
|
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
|
@@ -18151,6 +19438,11 @@ paths:
|
|
|
18151
19438
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18152
19439
|
'429':
|
|
18153
19440
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19441
|
+
security:
|
|
19442
|
+
- apiKeyAuth: []
|
|
19443
|
+
appKeyAuth: []
|
|
19444
|
+
- AuthZ:
|
|
19445
|
+
- ci_visibility_read
|
|
18154
19446
|
summary: Aggregate pipelines events
|
|
18155
19447
|
tags:
|
|
18156
19448
|
- CI Visibility Pipelines
|
|
@@ -18226,6 +19518,11 @@ paths:
|
|
|
18226
19518
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18227
19519
|
'429':
|
|
18228
19520
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19521
|
+
security:
|
|
19522
|
+
- apiKeyAuth: []
|
|
19523
|
+
appKeyAuth: []
|
|
19524
|
+
- AuthZ:
|
|
19525
|
+
- ci_visibility_read
|
|
18229
19526
|
summary: Get a list of pipelines events
|
|
18230
19527
|
tags:
|
|
18231
19528
|
- CI Visibility Pipelines
|
|
@@ -18263,6 +19560,11 @@ paths:
|
|
|
18263
19560
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18264
19561
|
'429':
|
|
18265
19562
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19563
|
+
security:
|
|
19564
|
+
- apiKeyAuth: []
|
|
19565
|
+
appKeyAuth: []
|
|
19566
|
+
- AuthZ:
|
|
19567
|
+
- ci_visibility_read
|
|
18266
19568
|
summary: Search pipelines events
|
|
18267
19569
|
tags:
|
|
18268
19570
|
- CI Visibility Pipelines
|
|
@@ -18296,6 +19598,11 @@ paths:
|
|
|
18296
19598
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18297
19599
|
'429':
|
|
18298
19600
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19601
|
+
security:
|
|
19602
|
+
- apiKeyAuth: []
|
|
19603
|
+
appKeyAuth: []
|
|
19604
|
+
- AuthZ:
|
|
19605
|
+
- ci_visibility_read
|
|
18299
19606
|
summary: Aggregate tests events
|
|
18300
19607
|
tags:
|
|
18301
19608
|
- CI Visibility Tests
|
|
@@ -18371,6 +19678,11 @@ paths:
|
|
|
18371
19678
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
18372
19679
|
'429':
|
|
18373
19680
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19681
|
+
security:
|
|
19682
|
+
- apiKeyAuth: []
|
|
19683
|
+
appKeyAuth: []
|
|
19684
|
+
- AuthZ:
|
|
19685
|
+
- ci_visibility_read
|
|
18374
19686
|
summary: Get a list of tests events
|
|
18375
19687
|
tags:
|
|
18376
19688
|
- CI Visibility Tests
|
|
@@ -18387,36 +19699,121 @@ paths:
|
|
|
18387
19699
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
18388
19700
|
|
|
18389
19701
|
|
|
18390
|
-
Use this endpoint to build complex events filtering and search.'
|
|
18391
|
-
operationId: SearchCIAppTestEvents
|
|
18392
|
-
requestBody:
|
|
18393
|
-
content:
|
|
18394
|
-
application/json:
|
|
18395
|
-
schema:
|
|
18396
|
-
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
|
19702
|
+
Use this endpoint to build complex events filtering and search.'
|
|
19703
|
+
operationId: SearchCIAppTestEvents
|
|
19704
|
+
requestBody:
|
|
19705
|
+
content:
|
|
19706
|
+
application/json:
|
|
19707
|
+
schema:
|
|
19708
|
+
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
|
19709
|
+
required: false
|
|
19710
|
+
responses:
|
|
19711
|
+
'200':
|
|
19712
|
+
content:
|
|
19713
|
+
application/json:
|
|
19714
|
+
schema:
|
|
19715
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
|
19716
|
+
description: OK
|
|
19717
|
+
'400':
|
|
19718
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
19719
|
+
'403':
|
|
19720
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
19721
|
+
'429':
|
|
19722
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
19723
|
+
security:
|
|
19724
|
+
- apiKeyAuth: []
|
|
19725
|
+
appKeyAuth: []
|
|
19726
|
+
- AuthZ:
|
|
19727
|
+
- ci_visibility_read
|
|
19728
|
+
summary: Search tests events
|
|
19729
|
+
tags:
|
|
19730
|
+
- CI Visibility Tests
|
|
19731
|
+
x-codegen-request-body-name: body
|
|
19732
|
+
x-pagination:
|
|
19733
|
+
cursorParam: body.page.cursor
|
|
19734
|
+
cursorPath: meta.page.after
|
|
19735
|
+
limitParam: body.page.limit
|
|
19736
|
+
resultsPath: data
|
|
19737
|
+
/api/v2/container_images:
|
|
19738
|
+
get:
|
|
19739
|
+
description: Get all Container Images for your organization.
|
|
19740
|
+
operationId: ListContainerImages
|
|
19741
|
+
parameters:
|
|
19742
|
+
- description: Comma-separated list of tags to filter Container Images by.
|
|
19743
|
+
example: short_image:redis,status:running
|
|
19744
|
+
in: query
|
|
19745
|
+
name: filter[tags]
|
|
19746
|
+
required: false
|
|
19747
|
+
schema:
|
|
19748
|
+
type: string
|
|
19749
|
+
- description: Comma-separated list of tags to group Container Images by.
|
|
19750
|
+
example: registry,image_tags
|
|
19751
|
+
in: query
|
|
19752
|
+
name: group_by
|
|
19753
|
+
required: false
|
|
19754
|
+
schema:
|
|
19755
|
+
type: string
|
|
19756
|
+
- description: Attribute to sort Container Images by.
|
|
19757
|
+
example: container_count
|
|
19758
|
+
in: query
|
|
19759
|
+
name: sort
|
|
19760
|
+
required: false
|
|
19761
|
+
schema:
|
|
19762
|
+
type: string
|
|
19763
|
+
- description: Maximum number of results returned.
|
|
19764
|
+
in: query
|
|
19765
|
+
name: page[size]
|
|
19766
|
+
required: false
|
|
19767
|
+
schema:
|
|
19768
|
+
default: 1000
|
|
19769
|
+
format: int32
|
|
19770
|
+
maximum: 10000
|
|
19771
|
+
minimum: 1
|
|
19772
|
+
type: integer
|
|
19773
|
+
- description: 'String to query the next page of results.
|
|
19774
|
+
|
|
19775
|
+
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
|
|
19776
|
+
in: query
|
|
19777
|
+
name: page[cursor]
|
|
18397
19778
|
required: false
|
|
19779
|
+
schema:
|
|
19780
|
+
type: string
|
|
18398
19781
|
responses:
|
|
18399
19782
|
'200':
|
|
18400
19783
|
content:
|
|
18401
19784
|
application/json:
|
|
18402
19785
|
schema:
|
|
18403
|
-
$ref: '#/components/schemas/
|
|
19786
|
+
$ref: '#/components/schemas/ContainerImagesResponse'
|
|
18404
19787
|
description: OK
|
|
18405
19788
|
'400':
|
|
18406
|
-
|
|
19789
|
+
content:
|
|
19790
|
+
application/json:
|
|
19791
|
+
schema:
|
|
19792
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
19793
|
+
description: Bad Request
|
|
18407
19794
|
'403':
|
|
18408
|
-
|
|
19795
|
+
content:
|
|
19796
|
+
application/json:
|
|
19797
|
+
schema:
|
|
19798
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
19799
|
+
description: Authentication Error
|
|
18409
19800
|
'429':
|
|
18410
19801
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
18411
|
-
|
|
19802
|
+
security:
|
|
19803
|
+
- apiKeyAuth: []
|
|
19804
|
+
appKeyAuth: []
|
|
19805
|
+
- AuthZ: []
|
|
19806
|
+
summary: Get all Container Images
|
|
18412
19807
|
tags:
|
|
18413
|
-
-
|
|
18414
|
-
x-codegen-request-body-name: body
|
|
19808
|
+
- Container Images
|
|
18415
19809
|
x-pagination:
|
|
18416
|
-
cursorParam:
|
|
18417
|
-
cursorPath: meta.
|
|
18418
|
-
limitParam:
|
|
19810
|
+
cursorParam: page[cursor]
|
|
19811
|
+
cursorPath: meta.pagination.next_cursor
|
|
19812
|
+
limitParam: page[size]
|
|
18419
19813
|
resultsPath: data
|
|
19814
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
19815
|
+
|
|
19816
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18420
19817
|
/api/v2/current_user/application_keys:
|
|
18421
19818
|
get:
|
|
18422
19819
|
description: List all application keys available for current user
|
|
@@ -18798,6 +20195,16 @@ paths:
|
|
|
18798
20195
|
schema:
|
|
18799
20196
|
example: created_by,monitor
|
|
18800
20197
|
type: string
|
|
20198
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
20199
|
+
- description: Maximum number of downtimes in the response.
|
|
20200
|
+
example: 100
|
|
20201
|
+
in: query
|
|
20202
|
+
name: page[limit]
|
|
20203
|
+
required: false
|
|
20204
|
+
schema:
|
|
20205
|
+
default: 30
|
|
20206
|
+
format: int64
|
|
20207
|
+
type: integer
|
|
18801
20208
|
responses:
|
|
18802
20209
|
'200':
|
|
18803
20210
|
content:
|
|
@@ -18821,9 +20228,10 @@ paths:
|
|
|
18821
20228
|
summary: Get all downtimes
|
|
18822
20229
|
tags:
|
|
18823
20230
|
- Downtimes
|
|
18824
|
-
x-
|
|
18825
|
-
|
|
18826
|
-
|
|
20231
|
+
x-pagination:
|
|
20232
|
+
limitParam: page[limit]
|
|
20233
|
+
pageOffsetParam: page[offset]
|
|
20234
|
+
resultsPath: data
|
|
18827
20235
|
post:
|
|
18828
20236
|
description: Schedule a downtime.
|
|
18829
20237
|
operationId: CreateDowntime
|
|
@@ -18864,9 +20272,6 @@ paths:
|
|
|
18864
20272
|
tags:
|
|
18865
20273
|
- Downtimes
|
|
18866
20274
|
x-codegen-request-body-name: body
|
|
18867
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18868
|
-
|
|
18869
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18870
20275
|
/api/v2/downtime/{downtime_id}:
|
|
18871
20276
|
delete:
|
|
18872
20277
|
description: Cancel a downtime.
|
|
@@ -18904,9 +20309,6 @@ paths:
|
|
|
18904
20309
|
summary: Cancel a downtime
|
|
18905
20310
|
tags:
|
|
18906
20311
|
- Downtimes
|
|
18907
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18908
|
-
|
|
18909
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18910
20312
|
get:
|
|
18911
20313
|
description: Get downtime detail by `downtime_id`.
|
|
18912
20314
|
operationId: GetDowntime
|
|
@@ -18963,9 +20365,6 @@ paths:
|
|
|
18963
20365
|
summary: Get a downtime
|
|
18964
20366
|
tags:
|
|
18965
20367
|
- Downtimes
|
|
18966
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18967
|
-
|
|
18968
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18969
20368
|
patch:
|
|
18970
20369
|
description: Update a downtime by `downtime_id`.
|
|
18971
20370
|
operationId: UpdateDowntime
|
|
@@ -19020,9 +20419,6 @@ paths:
|
|
|
19020
20419
|
tags:
|
|
19021
20420
|
- Downtimes
|
|
19022
20421
|
x-codegen-request-body-name: body
|
|
19023
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
19024
|
-
|
|
19025
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
19026
20422
|
/api/v2/events:
|
|
19027
20423
|
get:
|
|
19028
20424
|
description: 'List endpoint returns events that match an events search query.
|
|
@@ -22587,9 +23983,6 @@ paths:
|
|
|
22587
23983
|
tags:
|
|
22588
23984
|
- Downtimes
|
|
22589
23985
|
x-codegen-request-body-name: body
|
|
22590
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
22591
|
-
|
|
22592
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22593
23986
|
/api/v2/permissions:
|
|
22594
23987
|
get:
|
|
22595
23988
|
description: Returns a list of all permissions, including name, description,
|
|
@@ -22882,6 +24275,187 @@ paths:
|
|
|
22882
24275
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
22883
24276
|
|
|
22884
24277
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
24278
|
+
/api/v2/powerpacks:
|
|
24279
|
+
get:
|
|
24280
|
+
description: Get a list of all powerpacks.
|
|
24281
|
+
operationId: ListPowerpacks
|
|
24282
|
+
parameters:
|
|
24283
|
+
- description: Maximum number of powerpacks in the response.
|
|
24284
|
+
example: 25
|
|
24285
|
+
in: query
|
|
24286
|
+
name: page[limit]
|
|
24287
|
+
required: false
|
|
24288
|
+
schema:
|
|
24289
|
+
default: 25
|
|
24290
|
+
format: int64
|
|
24291
|
+
maximum: 1000
|
|
24292
|
+
type: integer
|
|
24293
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
24294
|
+
responses:
|
|
24295
|
+
'200':
|
|
24296
|
+
content:
|
|
24297
|
+
application/json:
|
|
24298
|
+
schema:
|
|
24299
|
+
$ref: '#/components/schemas/ListPowerpacksResponse'
|
|
24300
|
+
description: OK
|
|
24301
|
+
'429':
|
|
24302
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24303
|
+
security:
|
|
24304
|
+
- apiKeyAuth: []
|
|
24305
|
+
appKeyAuth: []
|
|
24306
|
+
- AuthZ:
|
|
24307
|
+
- dashboards_read
|
|
24308
|
+
summary: Get all powerpacks
|
|
24309
|
+
tags:
|
|
24310
|
+
- Powerpack
|
|
24311
|
+
x-pagination:
|
|
24312
|
+
limitParam: page[limit]
|
|
24313
|
+
pageOffsetParam: page[offset]
|
|
24314
|
+
resultsPath: data
|
|
24315
|
+
post:
|
|
24316
|
+
description: Create a powerpack.
|
|
24317
|
+
operationId: CreatePowerpack
|
|
24318
|
+
requestBody:
|
|
24319
|
+
content:
|
|
24320
|
+
application/json:
|
|
24321
|
+
schema:
|
|
24322
|
+
$ref: '#/components/schemas/Powerpack'
|
|
24323
|
+
description: Create a powerpack request body.
|
|
24324
|
+
required: true
|
|
24325
|
+
responses:
|
|
24326
|
+
'200':
|
|
24327
|
+
content:
|
|
24328
|
+
application/json:
|
|
24329
|
+
schema:
|
|
24330
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
24331
|
+
description: OK
|
|
24332
|
+
'400':
|
|
24333
|
+
content:
|
|
24334
|
+
application/json:
|
|
24335
|
+
schema:
|
|
24336
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24337
|
+
description: Bad Request
|
|
24338
|
+
'429':
|
|
24339
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24340
|
+
security:
|
|
24341
|
+
- apiKeyAuth: []
|
|
24342
|
+
appKeyAuth: []
|
|
24343
|
+
- AuthZ:
|
|
24344
|
+
- dashboards_write
|
|
24345
|
+
summary: Create a new powerpack
|
|
24346
|
+
tags:
|
|
24347
|
+
- Powerpack
|
|
24348
|
+
x-codegen-request-body-name: body
|
|
24349
|
+
/api/v2/powerpacks/{powerpack_id}:
|
|
24350
|
+
delete:
|
|
24351
|
+
description: Delete a powerpack.
|
|
24352
|
+
operationId: DeletePowerpack
|
|
24353
|
+
parameters:
|
|
24354
|
+
- description: Powerpack id
|
|
24355
|
+
in: path
|
|
24356
|
+
name: powerpack_id
|
|
24357
|
+
required: true
|
|
24358
|
+
schema:
|
|
24359
|
+
type: string
|
|
24360
|
+
responses:
|
|
24361
|
+
'204':
|
|
24362
|
+
description: OK
|
|
24363
|
+
'404':
|
|
24364
|
+
content:
|
|
24365
|
+
application/json:
|
|
24366
|
+
schema:
|
|
24367
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24368
|
+
description: Powerpack Not Found
|
|
24369
|
+
'429':
|
|
24370
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24371
|
+
security:
|
|
24372
|
+
- apiKeyAuth: []
|
|
24373
|
+
appKeyAuth: []
|
|
24374
|
+
- AuthZ:
|
|
24375
|
+
- dashboards_write
|
|
24376
|
+
summary: Delete a powerpack
|
|
24377
|
+
tags:
|
|
24378
|
+
- Powerpack
|
|
24379
|
+
get:
|
|
24380
|
+
description: Get a powerpack.
|
|
24381
|
+
operationId: GetPowerpack
|
|
24382
|
+
parameters:
|
|
24383
|
+
- description: ID of the powerpack.
|
|
24384
|
+
in: path
|
|
24385
|
+
name: powerpack_id
|
|
24386
|
+
required: true
|
|
24387
|
+
schema:
|
|
24388
|
+
type: string
|
|
24389
|
+
responses:
|
|
24390
|
+
'200':
|
|
24391
|
+
content:
|
|
24392
|
+
application/json:
|
|
24393
|
+
schema:
|
|
24394
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
24395
|
+
description: OK
|
|
24396
|
+
'404':
|
|
24397
|
+
content:
|
|
24398
|
+
application/json:
|
|
24399
|
+
schema:
|
|
24400
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24401
|
+
description: Powerpack Not Found.
|
|
24402
|
+
'429':
|
|
24403
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24404
|
+
security:
|
|
24405
|
+
- apiKeyAuth: []
|
|
24406
|
+
appKeyAuth: []
|
|
24407
|
+
- AuthZ:
|
|
24408
|
+
- dashboards_read
|
|
24409
|
+
summary: Get a Powerpack
|
|
24410
|
+
tags:
|
|
24411
|
+
- Powerpack
|
|
24412
|
+
patch:
|
|
24413
|
+
description: Update a powerpack.
|
|
24414
|
+
operationId: UpdatePowerpack
|
|
24415
|
+
parameters:
|
|
24416
|
+
- description: ID of the powerpack.
|
|
24417
|
+
in: path
|
|
24418
|
+
name: powerpack_id
|
|
24419
|
+
required: true
|
|
24420
|
+
schema:
|
|
24421
|
+
type: string
|
|
24422
|
+
requestBody:
|
|
24423
|
+
content:
|
|
24424
|
+
application/json:
|
|
24425
|
+
schema:
|
|
24426
|
+
$ref: '#/components/schemas/Powerpack'
|
|
24427
|
+
description: Update a powerpack request body.
|
|
24428
|
+
required: true
|
|
24429
|
+
responses:
|
|
24430
|
+
'200':
|
|
24431
|
+
content:
|
|
24432
|
+
application/json:
|
|
24433
|
+
schema:
|
|
24434
|
+
$ref: '#/components/schemas/PowerpackResponse'
|
|
24435
|
+
description: OK
|
|
24436
|
+
'400':
|
|
24437
|
+
content:
|
|
24438
|
+
application/json:
|
|
24439
|
+
schema:
|
|
24440
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24441
|
+
description: Bad Request
|
|
24442
|
+
'404':
|
|
24443
|
+
content:
|
|
24444
|
+
application/json:
|
|
24445
|
+
schema:
|
|
24446
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24447
|
+
description: Powerpack Not Found
|
|
24448
|
+
'429':
|
|
24449
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24450
|
+
security:
|
|
24451
|
+
- apiKeyAuth: []
|
|
24452
|
+
appKeyAuth: []
|
|
24453
|
+
- AuthZ:
|
|
24454
|
+
- dashboards_write
|
|
24455
|
+
summary: Update a powerpack
|
|
24456
|
+
tags:
|
|
24457
|
+
- Powerpack
|
|
24458
|
+
x-codegen-request-body-name: body
|
|
22885
24459
|
/api/v2/processes:
|
|
22886
24460
|
get:
|
|
22887
24461
|
description: Get all processes for your organization.
|
|
@@ -25948,6 +27522,8 @@ paths:
|
|
|
25948
27522
|
schema:
|
|
25949
27523
|
$ref: '#/components/schemas/TeamsResponse'
|
|
25950
27524
|
description: OK
|
|
27525
|
+
'403':
|
|
27526
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
25951
27527
|
'429':
|
|
25952
27528
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
25953
27529
|
security:
|
|
@@ -25958,6 +27534,10 @@ paths:
|
|
|
25958
27534
|
summary: Get all teams
|
|
25959
27535
|
tags:
|
|
25960
27536
|
- Teams
|
|
27537
|
+
x-pagination:
|
|
27538
|
+
limitParam: page[size]
|
|
27539
|
+
pageParam: page[number]
|
|
27540
|
+
resultsPath: data
|
|
25961
27541
|
post:
|
|
25962
27542
|
description: 'Create a new team.
|
|
25963
27543
|
|
|
@@ -25976,6 +27556,8 @@ paths:
|
|
|
25976
27556
|
schema:
|
|
25977
27557
|
$ref: '#/components/schemas/TeamResponse'
|
|
25978
27558
|
description: CREATED
|
|
27559
|
+
'403':
|
|
27560
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
25979
27561
|
'409':
|
|
25980
27562
|
content:
|
|
25981
27563
|
application/json:
|
|
@@ -26008,6 +27590,8 @@ paths:
|
|
|
26008
27590
|
responses:
|
|
26009
27591
|
'204':
|
|
26010
27592
|
description: No Content
|
|
27593
|
+
'403':
|
|
27594
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26011
27595
|
'404':
|
|
26012
27596
|
content:
|
|
26013
27597
|
application/json:
|
|
@@ -26042,6 +27626,8 @@ paths:
|
|
|
26042
27626
|
schema:
|
|
26043
27627
|
$ref: '#/components/schemas/TeamResponse'
|
|
26044
27628
|
description: OK
|
|
27629
|
+
'403':
|
|
27630
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26045
27631
|
'404':
|
|
26046
27632
|
content:
|
|
26047
27633
|
application/json:
|
|
@@ -26091,6 +27677,8 @@ paths:
|
|
|
26091
27677
|
schema:
|
|
26092
27678
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
26093
27679
|
description: API error response.
|
|
27680
|
+
'403':
|
|
27681
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26094
27682
|
'404':
|
|
26095
27683
|
content:
|
|
26096
27684
|
application/json:
|
|
@@ -26132,6 +27720,8 @@ paths:
|
|
|
26132
27720
|
schema:
|
|
26133
27721
|
$ref: '#/components/schemas/TeamLinksResponse'
|
|
26134
27722
|
description: OK
|
|
27723
|
+
'403':
|
|
27724
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26135
27725
|
'404':
|
|
26136
27726
|
content:
|
|
26137
27727
|
application/json:
|
|
@@ -26171,6 +27761,8 @@ paths:
|
|
|
26171
27761
|
schema:
|
|
26172
27762
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26173
27763
|
description: OK
|
|
27764
|
+
'403':
|
|
27765
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26174
27766
|
'404':
|
|
26175
27767
|
content:
|
|
26176
27768
|
application/json:
|
|
@@ -26214,6 +27806,8 @@ paths:
|
|
|
26214
27806
|
responses:
|
|
26215
27807
|
'204':
|
|
26216
27808
|
description: No Content
|
|
27809
|
+
'403':
|
|
27810
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26217
27811
|
'404':
|
|
26218
27812
|
content:
|
|
26219
27813
|
application/json:
|
|
@@ -26253,6 +27847,8 @@ paths:
|
|
|
26253
27847
|
schema:
|
|
26254
27848
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26255
27849
|
description: OK
|
|
27850
|
+
'403':
|
|
27851
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26256
27852
|
'404':
|
|
26257
27853
|
content:
|
|
26258
27854
|
application/json:
|
|
@@ -26298,6 +27894,8 @@ paths:
|
|
|
26298
27894
|
schema:
|
|
26299
27895
|
$ref: '#/components/schemas/TeamLinkResponse'
|
|
26300
27896
|
description: OK
|
|
27897
|
+
'403':
|
|
27898
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26301
27899
|
'404':
|
|
26302
27900
|
content:
|
|
26303
27901
|
application/json:
|
|
@@ -26345,6 +27943,8 @@ paths:
|
|
|
26345
27943
|
schema:
|
|
26346
27944
|
$ref: '#/components/schemas/UserTeamsResponse'
|
|
26347
27945
|
description: Represents a user's association to a team
|
|
27946
|
+
'403':
|
|
27947
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26348
27948
|
'404':
|
|
26349
27949
|
content:
|
|
26350
27950
|
application/json:
|
|
@@ -26384,6 +27984,8 @@ paths:
|
|
|
26384
27984
|
schema:
|
|
26385
27985
|
$ref: '#/components/schemas/UserTeamResponse'
|
|
26386
27986
|
description: Represents a user's association to a team
|
|
27987
|
+
'403':
|
|
27988
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26387
27989
|
'404':
|
|
26388
27990
|
content:
|
|
26389
27991
|
application/json:
|
|
@@ -26427,6 +28029,8 @@ paths:
|
|
|
26427
28029
|
responses:
|
|
26428
28030
|
'204':
|
|
26429
28031
|
description: No Content
|
|
28032
|
+
'403':
|
|
28033
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26430
28034
|
'404':
|
|
26431
28035
|
content:
|
|
26432
28036
|
application/json:
|
|
@@ -26472,6 +28076,8 @@ paths:
|
|
|
26472
28076
|
schema:
|
|
26473
28077
|
$ref: '#/components/schemas/UserTeamResponse'
|
|
26474
28078
|
description: Represents a user's association to a team
|
|
28079
|
+
'403':
|
|
28080
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26475
28081
|
'404':
|
|
26476
28082
|
content:
|
|
26477
28083
|
application/json:
|
|
@@ -26507,6 +28113,8 @@ paths:
|
|
|
26507
28113
|
schema:
|
|
26508
28114
|
$ref: '#/components/schemas/TeamPermissionSettingsResponse'
|
|
26509
28115
|
description: OK
|
|
28116
|
+
'403':
|
|
28117
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26510
28118
|
'404':
|
|
26511
28119
|
content:
|
|
26512
28120
|
application/json:
|
|
@@ -26553,6 +28161,8 @@ paths:
|
|
|
26553
28161
|
schema:
|
|
26554
28162
|
$ref: '#/components/schemas/TeamPermissionSettingResponse'
|
|
26555
28163
|
description: OK
|
|
28164
|
+
'403':
|
|
28165
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
26556
28166
|
'404':
|
|
26557
28167
|
content:
|
|
26558
28168
|
application/json:
|
|
@@ -27054,18 +28664,20 @@ paths:
|
|
|
27054
28664
|
|
|
27055
28665
|
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
|
|
27056
28666
|
|
|
27057
|
-
`
|
|
28667
|
+
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
|
|
28668
|
+
`cws`, `dbm`, `fargate`,
|
|
27058
28669
|
|
|
27059
28670
|
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
|
|
27060
28671
|
`iot`,
|
|
27061
28672
|
|
|
27062
|
-
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `
|
|
28673
|
+
`lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
|
|
28674
|
+
`observability_pipelines`,
|
|
27063
28675
|
|
|
27064
28676
|
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
|
|
27065
28677
|
`sds`, `snmp`,
|
|
27066
28678
|
|
|
27067
|
-
`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`,
|
|
27068
|
-
`timeseries`.
|
|
28679
|
+
`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`,
|
|
28680
|
+
and `timeseries`.
|
|
27069
28681
|
|
|
27070
28682
|
The following product family has been **deprecated**: `audit_logs`.'
|
|
27071
28683
|
in: query
|
|
@@ -27428,6 +29040,10 @@ paths:
|
|
|
27428
29040
|
tags:
|
|
27429
29041
|
- Users
|
|
27430
29042
|
x-codegen-request-body-name: body
|
|
29043
|
+
x-pagination:
|
|
29044
|
+
limitParam: page[size]
|
|
29045
|
+
pageParam: page[number]
|
|
29046
|
+
resultsPath: data
|
|
27431
29047
|
post:
|
|
27432
29048
|
description: Create a user for your organization.
|
|
27433
29049
|
operationId: CreateUser
|
|
@@ -27736,6 +29352,13 @@ servers:
|
|
|
27736
29352
|
default: api
|
|
27737
29353
|
description: The subdomain where the API is deployed.
|
|
27738
29354
|
tags:
|
|
29355
|
+
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
|
|
29356
|
+
for your organization. You need an API and application key with Admin rights to
|
|
29357
|
+
interact with this endpoint.
|
|
29358
|
+
externalDocs:
|
|
29359
|
+
description: Find out more at
|
|
29360
|
+
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
|
|
29361
|
+
name: APM Retention Filters
|
|
27739
29362
|
- description: Search your Audit Logs events over HTTP.
|
|
27740
29363
|
name: Audit
|
|
27741
29364
|
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
|
|
@@ -27758,6 +29381,9 @@ tags:
|
|
|
27758
29381
|
- description: Configure your Datadog Confluent Cloud integration directly through
|
|
27759
29382
|
the Datadog API.
|
|
27760
29383
|
name: Confluent Cloud
|
|
29384
|
+
- description: The Container Images API allows you to query Container Image data for
|
|
29385
|
+
your organization.
|
|
29386
|
+
name: Container Images
|
|
27761
29387
|
- description: 'Interact with your dashboard lists through the API to
|
|
27762
29388
|
|
|
27763
29389
|
organize, find, and share all of your dashboards with your team and
|
|
@@ -27879,6 +29505,22 @@ tags:
|
|
|
27879
29505
|
description: Find out more at
|
|
27880
29506
|
url: https://docs.datadoghq.com/account_management/multi_organization
|
|
27881
29507
|
name: Organizations
|
|
29508
|
+
- description: 'The powerpack endpoints allow you to:
|
|
29509
|
+
|
|
29510
|
+
|
|
29511
|
+
- Get a powerpack
|
|
29512
|
+
|
|
29513
|
+
- Create a powerpack
|
|
29514
|
+
|
|
29515
|
+
- Delete a powerpack
|
|
29516
|
+
|
|
29517
|
+
- Get a list of all powerpacks
|
|
29518
|
+
|
|
29519
|
+
|
|
29520
|
+
The Patch and Delete API methods can only be performed on a powerpack by
|
|
29521
|
+
|
|
29522
|
+
a user who has the powerpack create permission for that specific powerpack.'
|
|
29523
|
+
name: Powerpack
|
|
27882
29524
|
- description: The processes API allows you to query processes data for your organization.
|
|
27883
29525
|
name: Processes
|
|
27884
29526
|
- description: Search or aggregate your RUM events over HTTP.
|
|
@@ -27886,8 +29528,8 @@ tags:
|
|
|
27886
29528
|
- description: 'A restriction policy defines the access control rules for a resource,
|
|
27887
29529
|
mapping a set of relations
|
|
27888
29530
|
|
|
27889
|
-
(such as editor and viewer) to a set of allowed principals (such as roles, teams
|
|
27890
|
-
|
|
29531
|
+
(such as editor and viewer) to a set of allowed principals (such as roles, teams,
|
|
29532
|
+
or users).
|
|
27891
29533
|
|
|
27892
29534
|
The restriction policy determines who is authorized to perform what actions on
|
|
27893
29535
|
the resource.'
|