datadog_api_client 2.3.0 → 2.4.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 +4 -4
- data/.generator/schemas/v1/openapi.yaml +229 -6
- data/.generator/schemas/v2/openapi.yaml +1295 -335
- data/.github/workflows/docs.yml +2 -0
- data/.github/workflows/test.yml +2 -0
- data/CHANGELOG.md +19 -0
- data/examples/v1/logs-indexes/UpdateLogsIndex.rb +3 -0
- data/examples/v1/monitors/CreateMonitor_2012680290.rb +23 -0
- data/examples/v1/service-level-objectives/GetSLOHistory.rb +0 -3
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +9 -0
- data/examples/v1/synthetics/UpdateBrowserTest.rb +1 -0
- data/examples/v2/ci-visibility-pipelines/AggregateCIAppPipelineEvents.rb +33 -0
- data/examples/v2/ci-visibility-pipelines/ListCIAppPipelineEvents.rb +11 -0
- data/examples/v2/ci-visibility-pipelines/ListCIAppPipelineEvents_1270618359.rb +10 -0
- data/examples/v2/ci-visibility-pipelines/SearchCIAppPipelineEvents.rb +23 -0
- data/examples/v2/ci-visibility-pipelines/SearchCIAppPipelineEvents_3246135003.rb +22 -0
- data/examples/v2/ci-visibility-tests/AggregateCIAppTestEvents.rb +36 -0
- data/examples/v2/ci-visibility-tests/ListCIAppTestEvents.rb +11 -0
- data/examples/v2/ci-visibility-tests/ListCIAppTestEvents_3852605281.rb +10 -0
- data/examples/v2/ci-visibility-tests/SearchCIAppTestEvents.rb +23 -0
- data/examples/v2/ci-visibility-tests/SearchCIAppTestEvents_1675695429.rb +20 -0
- data/examples/v2/security-monitoring/GetSecurityMonitoringRule.rb +4 -1
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +23 -33
- data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +1 -1
- data/examples/v2/service-definition/DeleteServiceDefinition.rb +1 -1
- data/examples/v2/service-definition/GetServiceDefinition.rb +1 -1
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.rb +1 -1
- data/lib/datadog_api_client/configuration.rb +0 -1
- data/lib/datadog_api_client/inflector.rb +49 -0
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +0 -6
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +5 -5
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb +4 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +11 -1
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options.rb +98 -0
- data/lib/datadog_api_client/v1/models/monitor_options_scheduling_options_evaluation_window.rb +148 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +2 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +21 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion.rb +2 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_x_path_operator.rb +26 -0
- data/lib/datadog_api_client/v1/models/synthetics_assertion_x_path_target.rb +150 -0
- data/lib/datadog_api_client/v1/models/synthetics_assertion_x_path_target_target.rb +118 -0
- data/lib/datadog_api_client/v1/models/synthetics_step.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +2 -2
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request_body_type.rb +31 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_sort.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +2 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_fargate_hour.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_sds_hour.rb +31 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +41 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +41 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +41 -1
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +283 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +283 -0
- data/lib/datadog_api_client/v2/api/cloud_workload_security_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/logs_api.rb +6 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +3 -2
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_bucket_value.rb +64 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_bucket_value_timeseries_point.rb +108 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_sort.rb +128 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregate_sort_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_aggregation_function.rb +37 -0
- data/lib/datadog_api_client/v2/models/ci_app_compute.rb +140 -0
- data/lib/datadog_api_client/v2/models/ci_app_compute_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_event_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/ci_app_group_by_histogram.rb +154 -0
- data/lib/datadog_api_client/v2/models/ci_app_group_by_missing.rb +63 -0
- data/lib/datadog_api_client/v2/models/ci_app_group_by_total.rb +64 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_type_name.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_events_request.rb +129 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_events_response.rb +120 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregate_request.rb +143 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_aggregation_buckets_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_analytics_aggregate_response.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_bucket_response.rb +108 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_group_by.rb +160 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_query_filter.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_query_options.rb +109 -0
- data/lib/datadog_api_client/v2/models/ci_app_query_page_options.rb +119 -0
- data/lib/datadog_api_client/v2/models/ci_app_response_links.rb +99 -0
- data/lib/datadog_api_client/v2/models/ci_app_response_metadata.rb +141 -0
- data/lib/datadog_api_client/v2/models/ci_app_response_page.rb +98 -0
- data/lib/datadog_api_client/v2/models/ci_app_response_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_sort.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_sort_order.rb +27 -0
- data/lib/datadog_api_client/v2/models/ci_app_test_event.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_test_event_type_name.rb +26 -0
- data/lib/datadog_api_client/v2/models/ci_app_test_events_request.rb +129 -0
- data/lib/datadog_api_client/v2/models/ci_app_test_events_response.rb +120 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_aggregate_request.rb +143 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_aggregation_buckets_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_analytics_aggregate_response.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_bucket_response.rb +108 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_group_by.rb +160 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_query_filter.rb +118 -0
- data/lib/datadog_api_client/v2/models/ci_app_warning.rb +118 -0
- data/lib/datadog_api_client/v2/models/logs_query_filter.rb +11 -1
- data/lib/datadog_api_client/v2/models/logs_storage_tier.rb +27 -0
- data/lib/datadog_api_client/v2/models/rum_query_filter.rb +2 -2
- data/lib/datadog_api_client/v2/models/service_definition_v2_opsgenie.rb +14 -14
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +62 -3
- data/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.rb +0 -9
|
@@ -1107,6 +1107,635 @@ components:
|
|
|
1107
1107
|
type: string
|
|
1108
1108
|
x-enum-varnames:
|
|
1109
1109
|
- AUTHN_MAPPINGS
|
|
1110
|
+
CIAppAggregateBucketValue:
|
|
1111
|
+
description: A bucket value, can either be a timeseries or a single value.
|
|
1112
|
+
oneOf:
|
|
1113
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString'
|
|
1114
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber'
|
|
1115
|
+
- $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries'
|
|
1116
|
+
CIAppAggregateBucketValueSingleNumber:
|
|
1117
|
+
description: A single number value.
|
|
1118
|
+
format: double
|
|
1119
|
+
type: number
|
|
1120
|
+
CIAppAggregateBucketValueSingleString:
|
|
1121
|
+
description: A single string value.
|
|
1122
|
+
type: string
|
|
1123
|
+
CIAppAggregateBucketValueTimeseries:
|
|
1124
|
+
description: A timeseries array.
|
|
1125
|
+
items:
|
|
1126
|
+
$ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint'
|
|
1127
|
+
type: array
|
|
1128
|
+
x-generate-alias-as-model: true
|
|
1129
|
+
CIAppAggregateBucketValueTimeseriesPoint:
|
|
1130
|
+
description: A timeseries point.
|
|
1131
|
+
properties:
|
|
1132
|
+
time:
|
|
1133
|
+
description: The time value for this point.
|
|
1134
|
+
example: '2020-06-08T11:55:00.123Z'
|
|
1135
|
+
format: date-time
|
|
1136
|
+
type: string
|
|
1137
|
+
value:
|
|
1138
|
+
description: The value for this point.
|
|
1139
|
+
example: 19
|
|
1140
|
+
format: double
|
|
1141
|
+
type: number
|
|
1142
|
+
type: object
|
|
1143
|
+
CIAppAggregateSort:
|
|
1144
|
+
description: A sort rule.
|
|
1145
|
+
example:
|
|
1146
|
+
aggregation: count
|
|
1147
|
+
order: asc
|
|
1148
|
+
properties:
|
|
1149
|
+
aggregation:
|
|
1150
|
+
$ref: '#/components/schemas/CIAppAggregationFunction'
|
|
1151
|
+
metric:
|
|
1152
|
+
description: The metric to sort by (only used for `type=measure`).
|
|
1153
|
+
example: '@duration'
|
|
1154
|
+
type: string
|
|
1155
|
+
order:
|
|
1156
|
+
$ref: '#/components/schemas/CIAppSortOrder'
|
|
1157
|
+
type:
|
|
1158
|
+
$ref: '#/components/schemas/CIAppAggregateSortType'
|
|
1159
|
+
type: object
|
|
1160
|
+
CIAppAggregateSortType:
|
|
1161
|
+
default: alphabetical
|
|
1162
|
+
description: The type of sorting algorithm.
|
|
1163
|
+
enum:
|
|
1164
|
+
- alphabetical
|
|
1165
|
+
- measure
|
|
1166
|
+
type: string
|
|
1167
|
+
x-enum-varnames:
|
|
1168
|
+
- ALPHABETICAL
|
|
1169
|
+
- MEASURE
|
|
1170
|
+
CIAppAggregationFunction:
|
|
1171
|
+
description: An aggregation function.
|
|
1172
|
+
enum:
|
|
1173
|
+
- count
|
|
1174
|
+
- cardinality
|
|
1175
|
+
- pc75
|
|
1176
|
+
- pc90
|
|
1177
|
+
- pc95
|
|
1178
|
+
- pc98
|
|
1179
|
+
- pc99
|
|
1180
|
+
- sum
|
|
1181
|
+
- min
|
|
1182
|
+
- max
|
|
1183
|
+
- avg
|
|
1184
|
+
- median
|
|
1185
|
+
example: pc90
|
|
1186
|
+
type: string
|
|
1187
|
+
x-enum-varnames:
|
|
1188
|
+
- COUNT
|
|
1189
|
+
- CARDINALITY
|
|
1190
|
+
- PERCENTILE_75
|
|
1191
|
+
- PERCENTILE_90
|
|
1192
|
+
- PERCENTILE_95
|
|
1193
|
+
- PERCENTILE_98
|
|
1194
|
+
- PERCENTILE_99
|
|
1195
|
+
- SUM
|
|
1196
|
+
- MIN
|
|
1197
|
+
- MAX
|
|
1198
|
+
- AVG
|
|
1199
|
+
- MEDIAN
|
|
1200
|
+
CIAppCompute:
|
|
1201
|
+
description: A compute rule to compute metrics or timeseries.
|
|
1202
|
+
properties:
|
|
1203
|
+
aggregation:
|
|
1204
|
+
$ref: '#/components/schemas/CIAppAggregationFunction'
|
|
1205
|
+
interval:
|
|
1206
|
+
description: 'The time buckets'' size (only used for type=timeseries)
|
|
1207
|
+
|
|
1208
|
+
Defaults to a resolution of 150 points.'
|
|
1209
|
+
example: 5m
|
|
1210
|
+
type: string
|
|
1211
|
+
metric:
|
|
1212
|
+
description: The metric to use.
|
|
1213
|
+
example: '@duration'
|
|
1214
|
+
type: string
|
|
1215
|
+
type:
|
|
1216
|
+
$ref: '#/components/schemas/CIAppComputeType'
|
|
1217
|
+
required:
|
|
1218
|
+
- aggregation
|
|
1219
|
+
type: object
|
|
1220
|
+
CIAppComputeType:
|
|
1221
|
+
default: total
|
|
1222
|
+
description: The type of compute.
|
|
1223
|
+
enum:
|
|
1224
|
+
- timeseries
|
|
1225
|
+
- total
|
|
1226
|
+
type: string
|
|
1227
|
+
x-enum-varnames:
|
|
1228
|
+
- TIMESERIES
|
|
1229
|
+
- TOTAL
|
|
1230
|
+
CIAppComputes:
|
|
1231
|
+
additionalProperties:
|
|
1232
|
+
$ref: '#/components/schemas/CIAppAggregateBucketValue'
|
|
1233
|
+
description: A map of the metric name to value for regular compute, or a list
|
|
1234
|
+
of values for a timeseries.
|
|
1235
|
+
type: object
|
|
1236
|
+
CIAppEventAttributes:
|
|
1237
|
+
description: JSON object containing all event attributes and their associated
|
|
1238
|
+
values.
|
|
1239
|
+
properties:
|
|
1240
|
+
attributes:
|
|
1241
|
+
additionalProperties: {}
|
|
1242
|
+
description: JSON object of attributes from CI Visibility events.
|
|
1243
|
+
example:
|
|
1244
|
+
customAttribute: 123
|
|
1245
|
+
duration: 2345
|
|
1246
|
+
type: object
|
|
1247
|
+
service:
|
|
1248
|
+
description: 'The name of the application or service generating CI Visibility
|
|
1249
|
+
events.
|
|
1250
|
+
|
|
1251
|
+
It is used to switch from CI Visibility to APM, so make sure you define
|
|
1252
|
+
the same
|
|
1253
|
+
|
|
1254
|
+
value when you use both products.'
|
|
1255
|
+
example: web-ui-tests
|
|
1256
|
+
type: string
|
|
1257
|
+
tags:
|
|
1258
|
+
$ref: '#/components/schemas/TagsEventAttribute'
|
|
1259
|
+
timestamp:
|
|
1260
|
+
$ref: '#/components/schemas/TimestampEventAttribute'
|
|
1261
|
+
type: object
|
|
1262
|
+
CIAppGroupByHistogram:
|
|
1263
|
+
description: 'Used to perform a histogram computation (only for measure facets).
|
|
1264
|
+
|
|
1265
|
+
At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.'
|
|
1266
|
+
properties:
|
|
1267
|
+
interval:
|
|
1268
|
+
description: The bin size of the histogram buckets.
|
|
1269
|
+
example: 10
|
|
1270
|
+
format: double
|
|
1271
|
+
type: number
|
|
1272
|
+
max:
|
|
1273
|
+
description: 'The maximum value for the measure used in the histogram
|
|
1274
|
+
|
|
1275
|
+
(values greater than this one are filtered out).'
|
|
1276
|
+
example: 100
|
|
1277
|
+
format: double
|
|
1278
|
+
type: number
|
|
1279
|
+
min:
|
|
1280
|
+
description: 'The minimum value for the measure used in the histogram
|
|
1281
|
+
|
|
1282
|
+
(values smaller than this one are filtered out).'
|
|
1283
|
+
example: 50
|
|
1284
|
+
format: double
|
|
1285
|
+
type: number
|
|
1286
|
+
required:
|
|
1287
|
+
- interval
|
|
1288
|
+
- min
|
|
1289
|
+
- max
|
|
1290
|
+
type: object
|
|
1291
|
+
CIAppGroupByMissing:
|
|
1292
|
+
description: The value to use for logs that don't have the facet used to group-by.
|
|
1293
|
+
oneOf:
|
|
1294
|
+
- $ref: '#/components/schemas/CIAppGroupByMissingString'
|
|
1295
|
+
- $ref: '#/components/schemas/CIAppGroupByMissingNumber'
|
|
1296
|
+
CIAppGroupByMissingNumber:
|
|
1297
|
+
description: The missing value to use if there is a number valued facet.
|
|
1298
|
+
format: double
|
|
1299
|
+
type: number
|
|
1300
|
+
CIAppGroupByMissingString:
|
|
1301
|
+
description: The missing value to use if there is a string valued facet.
|
|
1302
|
+
type: string
|
|
1303
|
+
CIAppGroupByTotal:
|
|
1304
|
+
default: false
|
|
1305
|
+
description: A resulting object to put the given computes in over all the matching
|
|
1306
|
+
records.
|
|
1307
|
+
oneOf:
|
|
1308
|
+
- $ref: '#/components/schemas/CIAppGroupByTotalBoolean'
|
|
1309
|
+
- $ref: '#/components/schemas/CIAppGroupByTotalString'
|
|
1310
|
+
- $ref: '#/components/schemas/CIAppGroupByTotalNumber'
|
|
1311
|
+
CIAppGroupByTotalBoolean:
|
|
1312
|
+
description: If set to true, creates an additional bucket labeled "$facet_total".
|
|
1313
|
+
type: boolean
|
|
1314
|
+
CIAppGroupByTotalNumber:
|
|
1315
|
+
description: A number to use as the key value for the total bucket.
|
|
1316
|
+
format: double
|
|
1317
|
+
type: number
|
|
1318
|
+
CIAppGroupByTotalString:
|
|
1319
|
+
description: A string to use as the key value for the total bucket.
|
|
1320
|
+
type: string
|
|
1321
|
+
CIAppPipelineEvent:
|
|
1322
|
+
description: Object description of a pipeline event after being processed and
|
|
1323
|
+
stored by Datadog.
|
|
1324
|
+
properties:
|
|
1325
|
+
attributes:
|
|
1326
|
+
$ref: '#/components/schemas/CIAppEventAttributes'
|
|
1327
|
+
id:
|
|
1328
|
+
description: Unique ID of the event.
|
|
1329
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
|
1330
|
+
type: string
|
|
1331
|
+
type:
|
|
1332
|
+
$ref: '#/components/schemas/CIAppPipelineEventTypeName'
|
|
1333
|
+
type: object
|
|
1334
|
+
CIAppPipelineEventTypeName:
|
|
1335
|
+
description: Type of the event.
|
|
1336
|
+
enum:
|
|
1337
|
+
- cipipeline
|
|
1338
|
+
example: cipipeline
|
|
1339
|
+
type: string
|
|
1340
|
+
x-enum-varnames:
|
|
1341
|
+
- cipipeline
|
|
1342
|
+
CIAppPipelineEventsRequest:
|
|
1343
|
+
description: The request for a pipelines search.
|
|
1344
|
+
properties:
|
|
1345
|
+
filter:
|
|
1346
|
+
$ref: '#/components/schemas/CIAppPipelinesQueryFilter'
|
|
1347
|
+
options:
|
|
1348
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
1349
|
+
page:
|
|
1350
|
+
$ref: '#/components/schemas/CIAppQueryPageOptions'
|
|
1351
|
+
sort:
|
|
1352
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
1353
|
+
type: object
|
|
1354
|
+
CIAppPipelineEventsResponse:
|
|
1355
|
+
description: Response object with all pipeline events matching the request and
|
|
1356
|
+
pagination information.
|
|
1357
|
+
properties:
|
|
1358
|
+
data:
|
|
1359
|
+
description: Array of events matching the request.
|
|
1360
|
+
items:
|
|
1361
|
+
$ref: '#/components/schemas/CIAppPipelineEvent'
|
|
1362
|
+
type: array
|
|
1363
|
+
links:
|
|
1364
|
+
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
1365
|
+
meta:
|
|
1366
|
+
$ref: '#/components/schemas/CIAppResponseMetadata'
|
|
1367
|
+
type: object
|
|
1368
|
+
CIAppPipelinesAggregateRequest:
|
|
1369
|
+
description: The object sent with the request to retrieve aggregation buckets
|
|
1370
|
+
of pipeline events from your organization.
|
|
1371
|
+
properties:
|
|
1372
|
+
compute:
|
|
1373
|
+
description: The list of metrics or timeseries to compute for the retrieved
|
|
1374
|
+
buckets.
|
|
1375
|
+
items:
|
|
1376
|
+
$ref: '#/components/schemas/CIAppCompute'
|
|
1377
|
+
type: array
|
|
1378
|
+
filter:
|
|
1379
|
+
$ref: '#/components/schemas/CIAppPipelinesQueryFilter'
|
|
1380
|
+
group_by:
|
|
1381
|
+
description: The rules for the group-by.
|
|
1382
|
+
items:
|
|
1383
|
+
$ref: '#/components/schemas/CIAppPipelinesGroupBy'
|
|
1384
|
+
type: array
|
|
1385
|
+
options:
|
|
1386
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
1387
|
+
page:
|
|
1388
|
+
$ref: '#/components/schemas/CIAppQueryPageOptions'
|
|
1389
|
+
type: object
|
|
1390
|
+
CIAppPipelinesAggregationBucketsResponse:
|
|
1391
|
+
description: The query results.
|
|
1392
|
+
properties:
|
|
1393
|
+
buckets:
|
|
1394
|
+
description: The list of matching buckets, one item per bucket.
|
|
1395
|
+
items:
|
|
1396
|
+
$ref: '#/components/schemas/CIAppPipelinesBucketResponse'
|
|
1397
|
+
type: array
|
|
1398
|
+
type: object
|
|
1399
|
+
CIAppPipelinesAnalyticsAggregateResponse:
|
|
1400
|
+
description: The response object for the pipeline events aggregate API endpoint.
|
|
1401
|
+
properties:
|
|
1402
|
+
data:
|
|
1403
|
+
$ref: '#/components/schemas/CIAppPipelinesAggregationBucketsResponse'
|
|
1404
|
+
links:
|
|
1405
|
+
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
1406
|
+
meta:
|
|
1407
|
+
$ref: '#/components/schemas/CIAppResponseMetadata'
|
|
1408
|
+
type: object
|
|
1409
|
+
CIAppPipelinesBucketResponse:
|
|
1410
|
+
description: Bucket values.
|
|
1411
|
+
properties:
|
|
1412
|
+
by:
|
|
1413
|
+
additionalProperties:
|
|
1414
|
+
description: The values for each group-by.
|
|
1415
|
+
type: string
|
|
1416
|
+
description: The key-value pairs for each group-by.
|
|
1417
|
+
example:
|
|
1418
|
+
'@ci.provider.name': gitlab
|
|
1419
|
+
'@ci.status': success
|
|
1420
|
+
type: object
|
|
1421
|
+
computes:
|
|
1422
|
+
$ref: '#/components/schemas/CIAppComputes'
|
|
1423
|
+
type: object
|
|
1424
|
+
CIAppPipelinesGroupBy:
|
|
1425
|
+
description: A group-by rule.
|
|
1426
|
+
properties:
|
|
1427
|
+
facet:
|
|
1428
|
+
description: The name of the facet to use (required).
|
|
1429
|
+
example: '@ci.status'
|
|
1430
|
+
type: string
|
|
1431
|
+
histogram:
|
|
1432
|
+
$ref: '#/components/schemas/CIAppGroupByHistogram'
|
|
1433
|
+
limit:
|
|
1434
|
+
default: 10
|
|
1435
|
+
description: The maximum buckets to return for this group-by.
|
|
1436
|
+
format: int64
|
|
1437
|
+
type: integer
|
|
1438
|
+
missing:
|
|
1439
|
+
$ref: '#/components/schemas/CIAppGroupByMissing'
|
|
1440
|
+
sort:
|
|
1441
|
+
$ref: '#/components/schemas/CIAppAggregateSort'
|
|
1442
|
+
total:
|
|
1443
|
+
$ref: '#/components/schemas/CIAppGroupByTotal'
|
|
1444
|
+
required:
|
|
1445
|
+
- facet
|
|
1446
|
+
type: object
|
|
1447
|
+
CIAppPipelinesQueryFilter:
|
|
1448
|
+
description: The search and filter query settings.
|
|
1449
|
+
properties:
|
|
1450
|
+
from:
|
|
1451
|
+
default: now-15m
|
|
1452
|
+
description: The minimum time for the requested events; supports date, math,
|
|
1453
|
+
and regular timestamps (in milliseconds).
|
|
1454
|
+
example: now-15m
|
|
1455
|
+
type: string
|
|
1456
|
+
query:
|
|
1457
|
+
default: '*'
|
|
1458
|
+
description: The search query following the Log search syntax.
|
|
1459
|
+
example: '@ci.provider.name:github AND @ci.status:error'
|
|
1460
|
+
type: string
|
|
1461
|
+
to:
|
|
1462
|
+
default: now
|
|
1463
|
+
description: The maximum time for the requested events, supports date, math,
|
|
1464
|
+
and regular timestamps (in milliseconds).
|
|
1465
|
+
example: now
|
|
1466
|
+
type: string
|
|
1467
|
+
type: object
|
|
1468
|
+
CIAppQueryOptions:
|
|
1469
|
+
description: 'Global query options that are used during the query.
|
|
1470
|
+
|
|
1471
|
+
Only supply timezone or time offset, not both. Otherwise, the query fails.'
|
|
1472
|
+
properties:
|
|
1473
|
+
time_offset:
|
|
1474
|
+
description: The time offset (in seconds) to apply to the query.
|
|
1475
|
+
format: int64
|
|
1476
|
+
type: integer
|
|
1477
|
+
timezone:
|
|
1478
|
+
default: UTC
|
|
1479
|
+
description: 'The timezone can be specified both as an offset, for example:
|
|
1480
|
+
"UTC+03:00".'
|
|
1481
|
+
example: GMT
|
|
1482
|
+
type: string
|
|
1483
|
+
type: object
|
|
1484
|
+
CIAppQueryPageOptions:
|
|
1485
|
+
description: Paging attributes for listing events.
|
|
1486
|
+
properties:
|
|
1487
|
+
cursor:
|
|
1488
|
+
description: List following results with a cursor provided in the previous
|
|
1489
|
+
query.
|
|
1490
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
1491
|
+
type: string
|
|
1492
|
+
limit:
|
|
1493
|
+
default: 10
|
|
1494
|
+
description: Maximum number of events in the response.
|
|
1495
|
+
example: 25
|
|
1496
|
+
format: int32
|
|
1497
|
+
maximum: 1000
|
|
1498
|
+
type: integer
|
|
1499
|
+
type: object
|
|
1500
|
+
CIAppResponseLinks:
|
|
1501
|
+
description: Links attributes.
|
|
1502
|
+
properties:
|
|
1503
|
+
next:
|
|
1504
|
+
description: 'Link for the next set of results. The request can also be
|
|
1505
|
+
made using the
|
|
1506
|
+
|
|
1507
|
+
POST endpoint.'
|
|
1508
|
+
example: https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
1509
|
+
type: string
|
|
1510
|
+
type: object
|
|
1511
|
+
CIAppResponseMetadata:
|
|
1512
|
+
description: The metadata associated with a request.
|
|
1513
|
+
properties:
|
|
1514
|
+
elapsed:
|
|
1515
|
+
description: The time elapsed in milliseconds.
|
|
1516
|
+
example: 132
|
|
1517
|
+
format: int64
|
|
1518
|
+
type: integer
|
|
1519
|
+
page:
|
|
1520
|
+
$ref: '#/components/schemas/CIAppResponsePage'
|
|
1521
|
+
request_id:
|
|
1522
|
+
description: The identifier of the request.
|
|
1523
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
|
1524
|
+
type: string
|
|
1525
|
+
status:
|
|
1526
|
+
$ref: '#/components/schemas/CIAppResponseStatus'
|
|
1527
|
+
warnings:
|
|
1528
|
+
description: 'A list of warnings (non-fatal errors) encountered. Partial
|
|
1529
|
+
results may return if
|
|
1530
|
+
|
|
1531
|
+
warnings are present in the response.'
|
|
1532
|
+
items:
|
|
1533
|
+
$ref: '#/components/schemas/CIAppWarning'
|
|
1534
|
+
type: array
|
|
1535
|
+
type: object
|
|
1536
|
+
CIAppResponsePage:
|
|
1537
|
+
description: Paging attributes.
|
|
1538
|
+
properties:
|
|
1539
|
+
after:
|
|
1540
|
+
description: The cursor to use to get the next results, if any. To make
|
|
1541
|
+
the next request, use the same parameters with the addition of `page[cursor]`.
|
|
1542
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
1543
|
+
type: string
|
|
1544
|
+
type: object
|
|
1545
|
+
CIAppResponseStatus:
|
|
1546
|
+
description: The status of the response.
|
|
1547
|
+
enum:
|
|
1548
|
+
- done
|
|
1549
|
+
- timeout
|
|
1550
|
+
example: done
|
|
1551
|
+
type: string
|
|
1552
|
+
x-enum-varnames:
|
|
1553
|
+
- DONE
|
|
1554
|
+
- TIMEOUT
|
|
1555
|
+
CIAppSort:
|
|
1556
|
+
description: Sort parameters when querying events.
|
|
1557
|
+
enum:
|
|
1558
|
+
- timestamp
|
|
1559
|
+
- -timestamp
|
|
1560
|
+
type: string
|
|
1561
|
+
x-enum-varnames:
|
|
1562
|
+
- TIMESTAMP_ASCENDING
|
|
1563
|
+
- TIMESTAMP_DESCENDING
|
|
1564
|
+
CIAppSortOrder:
|
|
1565
|
+
description: The order to use, ascending or descending.
|
|
1566
|
+
enum:
|
|
1567
|
+
- asc
|
|
1568
|
+
- desc
|
|
1569
|
+
example: asc
|
|
1570
|
+
type: string
|
|
1571
|
+
x-enum-varnames:
|
|
1572
|
+
- ASCENDING
|
|
1573
|
+
- DESCENDING
|
|
1574
|
+
CIAppTestEvent:
|
|
1575
|
+
description: Object description of test event after being processed and stored
|
|
1576
|
+
by Datadog.
|
|
1577
|
+
properties:
|
|
1578
|
+
attributes:
|
|
1579
|
+
$ref: '#/components/schemas/CIAppEventAttributes'
|
|
1580
|
+
id:
|
|
1581
|
+
description: Unique ID of the event.
|
|
1582
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
|
1583
|
+
type: string
|
|
1584
|
+
type:
|
|
1585
|
+
$ref: '#/components/schemas/CIAppTestEventTypeName'
|
|
1586
|
+
type: object
|
|
1587
|
+
CIAppTestEventTypeName:
|
|
1588
|
+
description: Type of the event.
|
|
1589
|
+
enum:
|
|
1590
|
+
- citest
|
|
1591
|
+
example: citest
|
|
1592
|
+
type: string
|
|
1593
|
+
x-enum-varnames:
|
|
1594
|
+
- citest
|
|
1595
|
+
CIAppTestEventsRequest:
|
|
1596
|
+
description: The request for a tests search.
|
|
1597
|
+
properties:
|
|
1598
|
+
filter:
|
|
1599
|
+
$ref: '#/components/schemas/CIAppTestsQueryFilter'
|
|
1600
|
+
options:
|
|
1601
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
1602
|
+
page:
|
|
1603
|
+
$ref: '#/components/schemas/CIAppQueryPageOptions'
|
|
1604
|
+
sort:
|
|
1605
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
1606
|
+
type: object
|
|
1607
|
+
CIAppTestEventsResponse:
|
|
1608
|
+
description: Response object with all test events matching the request and pagination
|
|
1609
|
+
information.
|
|
1610
|
+
properties:
|
|
1611
|
+
data:
|
|
1612
|
+
description: Array of events matching the request.
|
|
1613
|
+
items:
|
|
1614
|
+
$ref: '#/components/schemas/CIAppTestEvent'
|
|
1615
|
+
type: array
|
|
1616
|
+
links:
|
|
1617
|
+
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
1618
|
+
meta:
|
|
1619
|
+
$ref: '#/components/schemas/CIAppResponseMetadata'
|
|
1620
|
+
type: object
|
|
1621
|
+
CIAppTestsAggregateRequest:
|
|
1622
|
+
description: The object sent with the request to retrieve aggregation buckets
|
|
1623
|
+
of test events from your organization.
|
|
1624
|
+
properties:
|
|
1625
|
+
compute:
|
|
1626
|
+
description: The list of metrics or timeseries to compute for the retrieved
|
|
1627
|
+
buckets.
|
|
1628
|
+
items:
|
|
1629
|
+
$ref: '#/components/schemas/CIAppCompute'
|
|
1630
|
+
type: array
|
|
1631
|
+
filter:
|
|
1632
|
+
$ref: '#/components/schemas/CIAppTestsQueryFilter'
|
|
1633
|
+
group_by:
|
|
1634
|
+
description: The rules for the group-by.
|
|
1635
|
+
items:
|
|
1636
|
+
$ref: '#/components/schemas/CIAppTestsGroupBy'
|
|
1637
|
+
type: array
|
|
1638
|
+
options:
|
|
1639
|
+
$ref: '#/components/schemas/CIAppQueryOptions'
|
|
1640
|
+
page:
|
|
1641
|
+
$ref: '#/components/schemas/CIAppQueryPageOptions'
|
|
1642
|
+
type: object
|
|
1643
|
+
CIAppTestsAggregationBucketsResponse:
|
|
1644
|
+
description: The query results.
|
|
1645
|
+
properties:
|
|
1646
|
+
buckets:
|
|
1647
|
+
description: The list of matching buckets, one item per bucket.
|
|
1648
|
+
items:
|
|
1649
|
+
$ref: '#/components/schemas/CIAppTestsBucketResponse'
|
|
1650
|
+
type: array
|
|
1651
|
+
type: object
|
|
1652
|
+
CIAppTestsAnalyticsAggregateResponse:
|
|
1653
|
+
description: The response object for the test events aggregate API endpoint.
|
|
1654
|
+
properties:
|
|
1655
|
+
data:
|
|
1656
|
+
$ref: '#/components/schemas/CIAppTestsAggregationBucketsResponse'
|
|
1657
|
+
links:
|
|
1658
|
+
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
1659
|
+
meta:
|
|
1660
|
+
$ref: '#/components/schemas/CIAppResponseMetadata'
|
|
1661
|
+
type: object
|
|
1662
|
+
CIAppTestsBucketResponse:
|
|
1663
|
+
description: Bucket values.
|
|
1664
|
+
properties:
|
|
1665
|
+
by:
|
|
1666
|
+
additionalProperties:
|
|
1667
|
+
description: The values for each group-by.
|
|
1668
|
+
type: string
|
|
1669
|
+
description: The key-value pairs for each group-by.
|
|
1670
|
+
example:
|
|
1671
|
+
'@test.service': web-ui-tests
|
|
1672
|
+
'@test.status': skip
|
|
1673
|
+
type: object
|
|
1674
|
+
computes:
|
|
1675
|
+
$ref: '#/components/schemas/CIAppComputes'
|
|
1676
|
+
type: object
|
|
1677
|
+
CIAppTestsGroupBy:
|
|
1678
|
+
description: A group-by rule.
|
|
1679
|
+
properties:
|
|
1680
|
+
facet:
|
|
1681
|
+
description: The name of the facet to use (required).
|
|
1682
|
+
example: '@test.service'
|
|
1683
|
+
type: string
|
|
1684
|
+
histogram:
|
|
1685
|
+
$ref: '#/components/schemas/CIAppGroupByHistogram'
|
|
1686
|
+
limit:
|
|
1687
|
+
default: 10
|
|
1688
|
+
description: The maximum buckets to return for this group-by.
|
|
1689
|
+
format: int64
|
|
1690
|
+
type: integer
|
|
1691
|
+
missing:
|
|
1692
|
+
$ref: '#/components/schemas/CIAppGroupByMissing'
|
|
1693
|
+
sort:
|
|
1694
|
+
$ref: '#/components/schemas/CIAppAggregateSort'
|
|
1695
|
+
total:
|
|
1696
|
+
$ref: '#/components/schemas/CIAppGroupByTotal'
|
|
1697
|
+
required:
|
|
1698
|
+
- facet
|
|
1699
|
+
type: object
|
|
1700
|
+
CIAppTestsQueryFilter:
|
|
1701
|
+
description: The search and filter query settings.
|
|
1702
|
+
properties:
|
|
1703
|
+
from:
|
|
1704
|
+
default: now-15m
|
|
1705
|
+
description: The minimum time for the requested events; supports date, math,
|
|
1706
|
+
and regular timestamps (in milliseconds).
|
|
1707
|
+
example: now-15m
|
|
1708
|
+
type: string
|
|
1709
|
+
query:
|
|
1710
|
+
default: '*'
|
|
1711
|
+
description: The search query following the Log search syntax.
|
|
1712
|
+
example: '@test.service:web-ui-tests AND @test.status:fail'
|
|
1713
|
+
type: string
|
|
1714
|
+
to:
|
|
1715
|
+
default: now
|
|
1716
|
+
description: The maximum time for the requested events, supports date, math,
|
|
1717
|
+
and regular timestamps (in milliseconds).
|
|
1718
|
+
example: now
|
|
1719
|
+
type: string
|
|
1720
|
+
type: object
|
|
1721
|
+
CIAppWarning:
|
|
1722
|
+
description: A warning message indicating something that went wrong with the
|
|
1723
|
+
query.
|
|
1724
|
+
properties:
|
|
1725
|
+
code:
|
|
1726
|
+
description: A unique code for this type of warning.
|
|
1727
|
+
example: unknown_index
|
|
1728
|
+
type: string
|
|
1729
|
+
detail:
|
|
1730
|
+
description: A detailed explanation of this specific warning.
|
|
1731
|
+
example: 'indexes: foo, bar'
|
|
1732
|
+
type: string
|
|
1733
|
+
title:
|
|
1734
|
+
description: A short human-readable summary of the warning.
|
|
1735
|
+
example: One or several indexes are missing or invalid, results hold data
|
|
1736
|
+
from the other indexes
|
|
1737
|
+
type: string
|
|
1738
|
+
type: object
|
|
1110
1739
|
ChargebackBreakdown:
|
|
1111
1740
|
description: Charges breakdown.
|
|
1112
1741
|
properties:
|
|
@@ -4606,6 +5235,8 @@ components:
|
|
|
4606
5235
|
description: The search query - following the log search syntax.
|
|
4607
5236
|
example: service:web* AND @http.status_code:[200 TO 299]
|
|
4608
5237
|
type: string
|
|
5238
|
+
storage_tier:
|
|
5239
|
+
$ref: '#/components/schemas/LogsStorageTier'
|
|
4609
5240
|
to:
|
|
4610
5241
|
default: now
|
|
4611
5242
|
description: The maximum time for the requested logs, supports date math
|
|
@@ -4685,6 +5316,17 @@ components:
|
|
|
4685
5316
|
x-enum-varnames:
|
|
4686
5317
|
- ASCENDING
|
|
4687
5318
|
- DESCENDING
|
|
5319
|
+
LogsStorageTier:
|
|
5320
|
+
default: indexes
|
|
5321
|
+
description: Specifies storage type as indexes or online-archives
|
|
5322
|
+
enum:
|
|
5323
|
+
- indexes
|
|
5324
|
+
- online-archives
|
|
5325
|
+
example: indexes
|
|
5326
|
+
type: string
|
|
5327
|
+
x-enum-varnames:
|
|
5328
|
+
- INDEXES
|
|
5329
|
+
- ONLINE_ARCHIVES
|
|
4688
5330
|
LogsWarning:
|
|
4689
5331
|
description: A warning message indicating something that went wrong with the
|
|
4690
5332
|
query
|
|
@@ -6608,8 +7250,10 @@ components:
|
|
|
6608
7250
|
properties:
|
|
6609
7251
|
from:
|
|
6610
7252
|
default: now-15m
|
|
6611
|
-
description: The minimum time for the requested events; supports date
|
|
6612
|
-
|
|
7253
|
+
description: The minimum time for the requested events; supports date (in
|
|
7254
|
+
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date,
|
|
7255
|
+
hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds
|
|
7256
|
+
are optional), math, and regular timestamps (in milliseconds).
|
|
6613
7257
|
example: now-15m
|
|
6614
7258
|
type: string
|
|
6615
7259
|
query:
|
|
@@ -6619,8 +7263,10 @@ components:
|
|
|
6619
7263
|
type: string
|
|
6620
7264
|
to:
|
|
6621
7265
|
default: now
|
|
6622
|
-
description: The maximum time for the requested events; supports date
|
|
6623
|
-
|
|
7266
|
+
description: The maximum time for the requested events; supports date (in
|
|
7267
|
+
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date,
|
|
7268
|
+
hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds
|
|
7269
|
+
are optional), math, and regular timestamps (in milliseconds).
|
|
6624
7270
|
example: now
|
|
6625
7271
|
type: string
|
|
6626
7272
|
type: object
|
|
@@ -9059,12 +9705,12 @@ components:
|
|
|
9059
9705
|
properties:
|
|
9060
9706
|
region:
|
|
9061
9707
|
$ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
|
|
9062
|
-
service-
|
|
9063
|
-
description: Opsgenie service
|
|
9064
|
-
example: 123e4567-e89b-12d3-a456-426614174000
|
|
9708
|
+
service-url:
|
|
9709
|
+
description: Opsgenie service url.
|
|
9710
|
+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
|
9065
9711
|
type: string
|
|
9066
9712
|
required:
|
|
9067
|
-
- service-
|
|
9713
|
+
- service-url
|
|
9068
9714
|
type: object
|
|
9069
9715
|
ServiceDefinitionV2OpsgenieRegion:
|
|
9070
9716
|
description: Opsgenie instance region.
|
|
@@ -9147,6 +9793,19 @@ components:
|
|
|
9147
9793
|
$ref: '#/components/schemas/ServiceDefinitionData'
|
|
9148
9794
|
type: array
|
|
9149
9795
|
type: object
|
|
9796
|
+
TagsEventAttribute:
|
|
9797
|
+
description: Array of tags associated with your event.
|
|
9798
|
+
example:
|
|
9799
|
+
- team:A
|
|
9800
|
+
items:
|
|
9801
|
+
description: Tag associated with your event.
|
|
9802
|
+
type: string
|
|
9803
|
+
type: array
|
|
9804
|
+
TimestampEventAttribute:
|
|
9805
|
+
description: Timestamp of your event.
|
|
9806
|
+
example: '2019-01-02T09:42:36.320Z'
|
|
9807
|
+
format: date-time
|
|
9808
|
+
type: string
|
|
9150
9809
|
UsageApplicationSecurityMonitoringResponse:
|
|
9151
9810
|
description: Application Security Monitoring usage response.
|
|
9152
9811
|
properties:
|
|
@@ -9526,6 +10185,7 @@ components:
|
|
|
9526
10185
|
user_access_invite: Invite other users to your organization.
|
|
9527
10186
|
user_access_manage: Disable users, manage user roles, manage SAML-to-role
|
|
9528
10187
|
mappings, and configure logs restriction queries.
|
|
10188
|
+
user_access_read: View users and their roles and settings.
|
|
9529
10189
|
tokenUrl: /oauth2/v1/token
|
|
9530
10190
|
type: oauth2
|
|
9531
10191
|
apiKeyAuth:
|
|
@@ -9569,7 +10229,132 @@ paths:
|
|
|
9569
10229
|
content:
|
|
9570
10230
|
application/json:
|
|
9571
10231
|
schema:
|
|
9572
|
-
$ref: '#/components/schemas/APIKeysResponse'
|
|
10232
|
+
$ref: '#/components/schemas/APIKeysResponse'
|
|
10233
|
+
description: OK
|
|
10234
|
+
'400':
|
|
10235
|
+
content:
|
|
10236
|
+
application/json:
|
|
10237
|
+
schema:
|
|
10238
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10239
|
+
description: Bad Request
|
|
10240
|
+
'403':
|
|
10241
|
+
content:
|
|
10242
|
+
application/json:
|
|
10243
|
+
schema:
|
|
10244
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10245
|
+
description: Forbidden
|
|
10246
|
+
'429':
|
|
10247
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10248
|
+
summary: Get all API keys
|
|
10249
|
+
tags:
|
|
10250
|
+
- Key Management
|
|
10251
|
+
post:
|
|
10252
|
+
description: Create an API key.
|
|
10253
|
+
operationId: CreateAPIKey
|
|
10254
|
+
requestBody:
|
|
10255
|
+
content:
|
|
10256
|
+
application/json:
|
|
10257
|
+
schema:
|
|
10258
|
+
$ref: '#/components/schemas/APIKeyCreateRequest'
|
|
10259
|
+
required: true
|
|
10260
|
+
responses:
|
|
10261
|
+
'201':
|
|
10262
|
+
content:
|
|
10263
|
+
application/json:
|
|
10264
|
+
schema:
|
|
10265
|
+
$ref: '#/components/schemas/APIKeyResponse'
|
|
10266
|
+
description: Created
|
|
10267
|
+
'400':
|
|
10268
|
+
content:
|
|
10269
|
+
application/json:
|
|
10270
|
+
schema:
|
|
10271
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10272
|
+
description: Bad Request
|
|
10273
|
+
'403':
|
|
10274
|
+
content:
|
|
10275
|
+
application/json:
|
|
10276
|
+
schema:
|
|
10277
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10278
|
+
description: Forbidden
|
|
10279
|
+
'429':
|
|
10280
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10281
|
+
summary: Create an API key
|
|
10282
|
+
tags:
|
|
10283
|
+
- Key Management
|
|
10284
|
+
x-codegen-request-body-name: body
|
|
10285
|
+
/api/v2/api_keys/{api_key_id}:
|
|
10286
|
+
delete:
|
|
10287
|
+
description: Delete an API key.
|
|
10288
|
+
operationId: DeleteAPIKey
|
|
10289
|
+
parameters:
|
|
10290
|
+
- $ref: '#/components/parameters/APIKeyId'
|
|
10291
|
+
responses:
|
|
10292
|
+
'204':
|
|
10293
|
+
description: No Content
|
|
10294
|
+
'403':
|
|
10295
|
+
content:
|
|
10296
|
+
application/json:
|
|
10297
|
+
schema:
|
|
10298
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10299
|
+
description: Forbidden
|
|
10300
|
+
'404':
|
|
10301
|
+
content:
|
|
10302
|
+
application/json:
|
|
10303
|
+
schema:
|
|
10304
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10305
|
+
description: Not Found
|
|
10306
|
+
'429':
|
|
10307
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10308
|
+
summary: Delete an API key
|
|
10309
|
+
tags:
|
|
10310
|
+
- Key Management
|
|
10311
|
+
get:
|
|
10312
|
+
description: Get an API key.
|
|
10313
|
+
operationId: GetAPIKey
|
|
10314
|
+
parameters:
|
|
10315
|
+
- $ref: '#/components/parameters/APIKeyId'
|
|
10316
|
+
- $ref: '#/components/parameters/APIKeyIncludeParameter'
|
|
10317
|
+
responses:
|
|
10318
|
+
'200':
|
|
10319
|
+
content:
|
|
10320
|
+
application/json:
|
|
10321
|
+
schema:
|
|
10322
|
+
$ref: '#/components/schemas/APIKeyResponse'
|
|
10323
|
+
description: OK
|
|
10324
|
+
'403':
|
|
10325
|
+
content:
|
|
10326
|
+
application/json:
|
|
10327
|
+
schema:
|
|
10328
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10329
|
+
description: Forbidden
|
|
10330
|
+
'404':
|
|
10331
|
+
content:
|
|
10332
|
+
application/json:
|
|
10333
|
+
schema:
|
|
10334
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10335
|
+
description: Not Found
|
|
10336
|
+
'429':
|
|
10337
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10338
|
+
summary: Get API key
|
|
10339
|
+
tags:
|
|
10340
|
+
- Key Management
|
|
10341
|
+
patch:
|
|
10342
|
+
description: Update an API key.
|
|
10343
|
+
operationId: UpdateAPIKey
|
|
10344
|
+
parameters:
|
|
10345
|
+
- $ref: '#/components/parameters/APIKeyId'
|
|
10346
|
+
requestBody:
|
|
10347
|
+
content:
|
|
10348
|
+
application/json:
|
|
10349
|
+
schema:
|
|
10350
|
+
$ref: '#/components/schemas/APIKeyUpdateRequest'
|
|
10351
|
+
required: true
|
|
10352
|
+
responses:
|
|
10353
|
+
'200':
|
|
10354
|
+
content:
|
|
10355
|
+
application/json:
|
|
10356
|
+
schema:
|
|
10357
|
+
$ref: '#/components/schemas/APIKeyResponse'
|
|
9573
10358
|
description: OK
|
|
9574
10359
|
'400':
|
|
9575
10360
|
content:
|
|
@@ -9583,27 +10368,36 @@ paths:
|
|
|
9583
10368
|
schema:
|
|
9584
10369
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9585
10370
|
description: Forbidden
|
|
10371
|
+
'404':
|
|
10372
|
+
content:
|
|
10373
|
+
application/json:
|
|
10374
|
+
schema:
|
|
10375
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10376
|
+
description: Not Found
|
|
9586
10377
|
'429':
|
|
9587
10378
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9588
|
-
summary:
|
|
10379
|
+
summary: Edit an API key
|
|
9589
10380
|
tags:
|
|
9590
10381
|
- Key Management
|
|
9591
|
-
|
|
9592
|
-
|
|
9593
|
-
|
|
9594
|
-
|
|
9595
|
-
|
|
9596
|
-
|
|
9597
|
-
|
|
9598
|
-
|
|
9599
|
-
|
|
10382
|
+
x-codegen-request-body-name: body
|
|
10383
|
+
/api/v2/application_keys:
|
|
10384
|
+
get:
|
|
10385
|
+
description: List all application keys available for your org
|
|
10386
|
+
operationId: ListApplicationKeys
|
|
10387
|
+
parameters:
|
|
10388
|
+
- $ref: '#/components/parameters/PageSize'
|
|
10389
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
10390
|
+
- $ref: '#/components/parameters/ApplicationKeysSortParameter'
|
|
10391
|
+
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
|
|
10392
|
+
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
|
10393
|
+
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
|
9600
10394
|
responses:
|
|
9601
|
-
'
|
|
10395
|
+
'200':
|
|
9602
10396
|
content:
|
|
9603
10397
|
application/json:
|
|
9604
10398
|
schema:
|
|
9605
|
-
$ref: '#/components/schemas/
|
|
9606
|
-
description:
|
|
10399
|
+
$ref: '#/components/schemas/ListApplicationKeysResponse'
|
|
10400
|
+
description: OK
|
|
9607
10401
|
'400':
|
|
9608
10402
|
content:
|
|
9609
10403
|
application/json:
|
|
@@ -9616,18 +10410,23 @@ paths:
|
|
|
9616
10410
|
schema:
|
|
9617
10411
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9618
10412
|
description: Forbidden
|
|
10413
|
+
'404':
|
|
10414
|
+
content:
|
|
10415
|
+
application/json:
|
|
10416
|
+
schema:
|
|
10417
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10418
|
+
description: Not Found
|
|
9619
10419
|
'429':
|
|
9620
10420
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9621
|
-
summary:
|
|
10421
|
+
summary: Get all application keys
|
|
9622
10422
|
tags:
|
|
9623
10423
|
- Key Management
|
|
9624
|
-
|
|
9625
|
-
/api/v2/api_keys/{api_key_id}:
|
|
10424
|
+
/api/v2/application_keys/{app_key_id}:
|
|
9626
10425
|
delete:
|
|
9627
|
-
description: Delete an
|
|
9628
|
-
operationId:
|
|
10426
|
+
description: Delete an application key
|
|
10427
|
+
operationId: DeleteApplicationKey
|
|
9629
10428
|
parameters:
|
|
9630
|
-
- $ref: '#/components/parameters/
|
|
10429
|
+
- $ref: '#/components/parameters/ApplicationKeyID'
|
|
9631
10430
|
responses:
|
|
9632
10431
|
'204':
|
|
9633
10432
|
description: No Content
|
|
@@ -9645,22 +10444,29 @@ paths:
|
|
|
9645
10444
|
description: Not Found
|
|
9646
10445
|
'429':
|
|
9647
10446
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9648
|
-
summary: Delete an
|
|
10447
|
+
summary: Delete an application key
|
|
9649
10448
|
tags:
|
|
9650
10449
|
- Key Management
|
|
10450
|
+
x-codegen-request-body-name: body
|
|
9651
10451
|
get:
|
|
9652
|
-
description: Get an
|
|
9653
|
-
operationId:
|
|
10452
|
+
description: Get an application key for your org.
|
|
10453
|
+
operationId: GetApplicationKey
|
|
9654
10454
|
parameters:
|
|
9655
|
-
- $ref: '#/components/parameters/
|
|
9656
|
-
- $ref: '#/components/parameters/
|
|
10455
|
+
- $ref: '#/components/parameters/ApplicationKeyID'
|
|
10456
|
+
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
|
9657
10457
|
responses:
|
|
9658
10458
|
'200':
|
|
9659
10459
|
content:
|
|
9660
10460
|
application/json:
|
|
9661
10461
|
schema:
|
|
9662
|
-
$ref: '#/components/schemas/
|
|
10462
|
+
$ref: '#/components/schemas/ApplicationKeyResponse'
|
|
9663
10463
|
description: OK
|
|
10464
|
+
'400':
|
|
10465
|
+
content:
|
|
10466
|
+
application/json:
|
|
10467
|
+
schema:
|
|
10468
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10469
|
+
description: Bad Request
|
|
9664
10470
|
'403':
|
|
9665
10471
|
content:
|
|
9666
10472
|
application/json:
|
|
@@ -9675,26 +10481,26 @@ paths:
|
|
|
9675
10481
|
description: Not Found
|
|
9676
10482
|
'429':
|
|
9677
10483
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9678
|
-
summary: Get
|
|
10484
|
+
summary: Get an application key
|
|
9679
10485
|
tags:
|
|
9680
10486
|
- Key Management
|
|
9681
10487
|
patch:
|
|
9682
|
-
description:
|
|
9683
|
-
operationId:
|
|
10488
|
+
description: Edit an application key
|
|
10489
|
+
operationId: UpdateApplicationKey
|
|
9684
10490
|
parameters:
|
|
9685
|
-
- $ref: '#/components/parameters/
|
|
10491
|
+
- $ref: '#/components/parameters/ApplicationKeyID'
|
|
9686
10492
|
requestBody:
|
|
9687
10493
|
content:
|
|
9688
10494
|
application/json:
|
|
9689
10495
|
schema:
|
|
9690
|
-
$ref: '#/components/schemas/
|
|
10496
|
+
$ref: '#/components/schemas/ApplicationKeyUpdateRequest'
|
|
9691
10497
|
required: true
|
|
9692
10498
|
responses:
|
|
9693
10499
|
'200':
|
|
9694
10500
|
content:
|
|
9695
10501
|
application/json:
|
|
9696
10502
|
schema:
|
|
9697
|
-
$ref: '#/components/schemas/
|
|
10503
|
+
$ref: '#/components/schemas/ApplicationKeyResponse'
|
|
9698
10504
|
description: OK
|
|
9699
10505
|
'400':
|
|
9700
10506
|
content:
|
|
@@ -9706,37 +10512,199 @@ paths:
|
|
|
9706
10512
|
content:
|
|
9707
10513
|
application/json:
|
|
9708
10514
|
schema:
|
|
9709
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
9710
|
-
description: Forbidden
|
|
9711
|
-
'404':
|
|
10515
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10516
|
+
description: Forbidden
|
|
10517
|
+
'404':
|
|
10518
|
+
content:
|
|
10519
|
+
application/json:
|
|
10520
|
+
schema:
|
|
10521
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10522
|
+
description: Not Found
|
|
10523
|
+
'429':
|
|
10524
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10525
|
+
summary: Edit an application key
|
|
10526
|
+
tags:
|
|
10527
|
+
- Key Management
|
|
10528
|
+
x-codegen-request-body-name: body
|
|
10529
|
+
/api/v2/audit/events:
|
|
10530
|
+
get:
|
|
10531
|
+
description: 'List endpoint returns events that match a Audit Logs search query.
|
|
10532
|
+
|
|
10533
|
+
[Results are paginated][1].
|
|
10534
|
+
|
|
10535
|
+
|
|
10536
|
+
Use this endpoint to see your latest Audit Logs events.
|
|
10537
|
+
|
|
10538
|
+
|
|
10539
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
|
10540
|
+
operationId: ListAuditLogs
|
|
10541
|
+
parameters:
|
|
10542
|
+
- description: Search query following Audit Logs syntax.
|
|
10543
|
+
example: '@type:session @application_id:xxxx'
|
|
10544
|
+
in: query
|
|
10545
|
+
name: filter[query]
|
|
10546
|
+
required: false
|
|
10547
|
+
schema:
|
|
10548
|
+
type: string
|
|
10549
|
+
- description: Minimum timestamp for requested events.
|
|
10550
|
+
example: '2019-01-02T09:42:36.320Z'
|
|
10551
|
+
in: query
|
|
10552
|
+
name: filter[from]
|
|
10553
|
+
required: false
|
|
10554
|
+
schema:
|
|
10555
|
+
format: date-time
|
|
10556
|
+
type: string
|
|
10557
|
+
- description: Maximum timestamp for requested events.
|
|
10558
|
+
example: '2019-01-03T09:42:36.320Z'
|
|
10559
|
+
in: query
|
|
10560
|
+
name: filter[to]
|
|
10561
|
+
required: false
|
|
10562
|
+
schema:
|
|
10563
|
+
format: date-time
|
|
10564
|
+
type: string
|
|
10565
|
+
- description: Order of events in results.
|
|
10566
|
+
in: query
|
|
10567
|
+
name: sort
|
|
10568
|
+
required: false
|
|
10569
|
+
schema:
|
|
10570
|
+
$ref: '#/components/schemas/AuditLogsSort'
|
|
10571
|
+
- description: List following results with a cursor provided in the previous
|
|
10572
|
+
query.
|
|
10573
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
10574
|
+
in: query
|
|
10575
|
+
name: page[cursor]
|
|
10576
|
+
required: false
|
|
10577
|
+
schema:
|
|
10578
|
+
type: string
|
|
10579
|
+
- description: Maximum number of events in the response.
|
|
10580
|
+
example: 25
|
|
10581
|
+
in: query
|
|
10582
|
+
name: page[limit]
|
|
10583
|
+
required: false
|
|
10584
|
+
schema:
|
|
10585
|
+
default: 10
|
|
10586
|
+
format: int32
|
|
10587
|
+
maximum: 1000
|
|
10588
|
+
type: integer
|
|
10589
|
+
responses:
|
|
10590
|
+
'200':
|
|
10591
|
+
content:
|
|
10592
|
+
application/json:
|
|
10593
|
+
schema:
|
|
10594
|
+
$ref: '#/components/schemas/AuditLogsEventsResponse'
|
|
10595
|
+
description: OK
|
|
10596
|
+
'400':
|
|
10597
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10598
|
+
'403':
|
|
10599
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10600
|
+
'429':
|
|
10601
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10602
|
+
summary: Get a list of Audit Logs events
|
|
10603
|
+
tags:
|
|
10604
|
+
- Audit
|
|
10605
|
+
x-pagination:
|
|
10606
|
+
cursorParam: page[cursor]
|
|
10607
|
+
cursorPath: meta.page.after
|
|
10608
|
+
limitParam: page[limit]
|
|
10609
|
+
resultsPath: data
|
|
10610
|
+
/api/v2/audit/events/search:
|
|
10611
|
+
post:
|
|
10612
|
+
description: 'List endpoint returns Audit Logs events that match an Audit search
|
|
10613
|
+
query.
|
|
10614
|
+
|
|
10615
|
+
[Results are paginated][1].
|
|
10616
|
+
|
|
10617
|
+
|
|
10618
|
+
Use this endpoint to build complex Audit Logs events filtering and search.
|
|
10619
|
+
|
|
10620
|
+
|
|
10621
|
+
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
|
10622
|
+
operationId: SearchAuditLogs
|
|
10623
|
+
requestBody:
|
|
10624
|
+
content:
|
|
10625
|
+
application/json:
|
|
10626
|
+
schema:
|
|
10627
|
+
$ref: '#/components/schemas/AuditLogsSearchEventsRequest'
|
|
10628
|
+
required: false
|
|
10629
|
+
responses:
|
|
10630
|
+
'200':
|
|
10631
|
+
content:
|
|
10632
|
+
application/json:
|
|
10633
|
+
schema:
|
|
10634
|
+
$ref: '#/components/schemas/AuditLogsEventsResponse'
|
|
10635
|
+
description: OK
|
|
10636
|
+
'400':
|
|
10637
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10638
|
+
'403':
|
|
10639
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10640
|
+
'429':
|
|
10641
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10642
|
+
summary: Search Audit Logs events
|
|
10643
|
+
tags:
|
|
10644
|
+
- Audit
|
|
10645
|
+
x-codegen-request-body-name: body
|
|
10646
|
+
x-pagination:
|
|
10647
|
+
cursorParam: body.page.cursor
|
|
10648
|
+
cursorPath: meta.page.after
|
|
10649
|
+
limitParam: body.page.limit
|
|
10650
|
+
resultsPath: data
|
|
10651
|
+
/api/v2/authn_mappings:
|
|
10652
|
+
get:
|
|
10653
|
+
description: List all AuthN Mappings in the org.
|
|
10654
|
+
operationId: ListAuthNMappings
|
|
10655
|
+
parameters:
|
|
10656
|
+
- $ref: '#/components/parameters/PageSize'
|
|
10657
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
10658
|
+
- description: Sort AuthN Mappings depending on the given field.
|
|
10659
|
+
in: query
|
|
10660
|
+
name: sort
|
|
10661
|
+
required: false
|
|
10662
|
+
schema:
|
|
10663
|
+
$ref: '#/components/schemas/AuthNMappingsSort'
|
|
10664
|
+
- description: Filter all mappings by the given string.
|
|
10665
|
+
in: query
|
|
10666
|
+
name: filter
|
|
10667
|
+
required: false
|
|
10668
|
+
schema:
|
|
10669
|
+
type: string
|
|
10670
|
+
responses:
|
|
10671
|
+
'200':
|
|
10672
|
+
content:
|
|
10673
|
+
application/json:
|
|
10674
|
+
schema:
|
|
10675
|
+
$ref: '#/components/schemas/AuthNMappingsResponse'
|
|
10676
|
+
description: OK
|
|
10677
|
+
'403':
|
|
9712
10678
|
content:
|
|
9713
10679
|
application/json:
|
|
9714
10680
|
schema:
|
|
9715
10681
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9716
|
-
description:
|
|
10682
|
+
description: Authentication Error
|
|
9717
10683
|
'429':
|
|
9718
10684
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9719
|
-
|
|
10685
|
+
security:
|
|
10686
|
+
- apiKeyAuth: []
|
|
10687
|
+
appKeyAuth: []
|
|
10688
|
+
- AuthZ: []
|
|
10689
|
+
summary: List all AuthN Mappings
|
|
9720
10690
|
tags:
|
|
9721
|
-
-
|
|
9722
|
-
x-
|
|
9723
|
-
|
|
9724
|
-
|
|
9725
|
-
|
|
9726
|
-
|
|
9727
|
-
|
|
9728
|
-
|
|
9729
|
-
|
|
9730
|
-
|
|
9731
|
-
|
|
9732
|
-
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
|
|
9733
|
-
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
|
|
10691
|
+
- AuthN Mappings
|
|
10692
|
+
x-permission: OPEN()
|
|
10693
|
+
post:
|
|
10694
|
+
description: Create an AuthN Mapping.
|
|
10695
|
+
operationId: CreateAuthNMapping
|
|
10696
|
+
requestBody:
|
|
10697
|
+
content:
|
|
10698
|
+
application/json:
|
|
10699
|
+
schema:
|
|
10700
|
+
$ref: '#/components/schemas/AuthNMappingCreateRequest'
|
|
10701
|
+
required: true
|
|
9734
10702
|
responses:
|
|
9735
10703
|
'200':
|
|
9736
10704
|
content:
|
|
9737
10705
|
application/json:
|
|
9738
10706
|
schema:
|
|
9739
|
-
$ref: '#/components/schemas/
|
|
10707
|
+
$ref: '#/components/schemas/AuthNMappingResponse'
|
|
9740
10708
|
description: OK
|
|
9741
10709
|
'400':
|
|
9742
10710
|
content:
|
|
@@ -9749,7 +10717,7 @@ paths:
|
|
|
9749
10717
|
application/json:
|
|
9750
10718
|
schema:
|
|
9751
10719
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9752
|
-
description:
|
|
10720
|
+
description: Authentication Error
|
|
9753
10721
|
'404':
|
|
9754
10722
|
content:
|
|
9755
10723
|
application/json:
|
|
@@ -9758,24 +10726,31 @@ paths:
|
|
|
9758
10726
|
description: Not Found
|
|
9759
10727
|
'429':
|
|
9760
10728
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9761
|
-
|
|
10729
|
+
security:
|
|
10730
|
+
- apiKeyAuth: []
|
|
10731
|
+
appKeyAuth: []
|
|
10732
|
+
- AuthZ:
|
|
10733
|
+
- user_access_manage
|
|
10734
|
+
summary: Create an AuthN Mapping
|
|
9762
10735
|
tags:
|
|
9763
|
-
-
|
|
9764
|
-
|
|
10736
|
+
- AuthN Mappings
|
|
10737
|
+
x-codegen-request-body-name: body
|
|
10738
|
+
x-permission: OR(USER_ACCESS_MANAGE)
|
|
10739
|
+
/api/v2/authn_mappings/{authn_mapping_id}:
|
|
9765
10740
|
delete:
|
|
9766
|
-
description: Delete an
|
|
9767
|
-
operationId:
|
|
10741
|
+
description: Delete an AuthN Mapping specified by AuthN Mapping UUID.
|
|
10742
|
+
operationId: DeleteAuthNMapping
|
|
9768
10743
|
parameters:
|
|
9769
|
-
- $ref: '#/components/parameters/
|
|
10744
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
9770
10745
|
responses:
|
|
9771
10746
|
'204':
|
|
9772
|
-
description:
|
|
10747
|
+
description: OK
|
|
9773
10748
|
'403':
|
|
9774
10749
|
content:
|
|
9775
10750
|
application/json:
|
|
9776
10751
|
schema:
|
|
9777
10752
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9778
|
-
description:
|
|
10753
|
+
description: Authentication Error
|
|
9779
10754
|
'404':
|
|
9780
10755
|
content:
|
|
9781
10756
|
application/json:
|
|
@@ -9784,35 +10759,33 @@ paths:
|
|
|
9784
10759
|
description: Not Found
|
|
9785
10760
|
'429':
|
|
9786
10761
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9787
|
-
|
|
10762
|
+
security:
|
|
10763
|
+
- apiKeyAuth: []
|
|
10764
|
+
appKeyAuth: []
|
|
10765
|
+
- AuthZ:
|
|
10766
|
+
- user_access_manage
|
|
10767
|
+
summary: Delete an AuthN Mapping
|
|
9788
10768
|
tags:
|
|
9789
|
-
-
|
|
9790
|
-
x-
|
|
10769
|
+
- AuthN Mappings
|
|
10770
|
+
x-permission: OR(USER_ACCESS_MANAGE)
|
|
9791
10771
|
get:
|
|
9792
|
-
description: Get an
|
|
9793
|
-
operationId:
|
|
10772
|
+
description: Get an AuthN Mapping specified by the AuthN Mapping UUID.
|
|
10773
|
+
operationId: GetAuthNMapping
|
|
9794
10774
|
parameters:
|
|
9795
|
-
- $ref: '#/components/parameters/
|
|
9796
|
-
- $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
|
|
10775
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
9797
10776
|
responses:
|
|
9798
10777
|
'200':
|
|
9799
10778
|
content:
|
|
9800
10779
|
application/json:
|
|
9801
10780
|
schema:
|
|
9802
|
-
$ref: '#/components/schemas/
|
|
10781
|
+
$ref: '#/components/schemas/AuthNMappingResponse'
|
|
9803
10782
|
description: OK
|
|
9804
|
-
'400':
|
|
9805
|
-
content:
|
|
9806
|
-
application/json:
|
|
9807
|
-
schema:
|
|
9808
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
9809
|
-
description: Bad Request
|
|
9810
10783
|
'403':
|
|
9811
10784
|
content:
|
|
9812
10785
|
application/json:
|
|
9813
10786
|
schema:
|
|
9814
10787
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9815
|
-
description:
|
|
10788
|
+
description: Authentication Error
|
|
9816
10789
|
'404':
|
|
9817
10790
|
content:
|
|
9818
10791
|
application/json:
|
|
@@ -9821,26 +10794,31 @@ paths:
|
|
|
9821
10794
|
description: Not Found
|
|
9822
10795
|
'429':
|
|
9823
10796
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9824
|
-
|
|
10797
|
+
security:
|
|
10798
|
+
- apiKeyAuth: []
|
|
10799
|
+
appKeyAuth: []
|
|
10800
|
+
- AuthZ: []
|
|
10801
|
+
summary: Get an AuthN Mapping by UUID
|
|
9825
10802
|
tags:
|
|
9826
|
-
-
|
|
10803
|
+
- AuthN Mappings
|
|
10804
|
+
x-permission: OPEN()
|
|
9827
10805
|
patch:
|
|
9828
|
-
description: Edit an
|
|
9829
|
-
operationId:
|
|
10806
|
+
description: Edit an AuthN Mapping.
|
|
10807
|
+
operationId: UpdateAuthNMapping
|
|
9830
10808
|
parameters:
|
|
9831
|
-
- $ref: '#/components/parameters/
|
|
10809
|
+
- $ref: '#/components/parameters/AuthNMappingID'
|
|
9832
10810
|
requestBody:
|
|
9833
10811
|
content:
|
|
9834
10812
|
application/json:
|
|
9835
10813
|
schema:
|
|
9836
|
-
$ref: '#/components/schemas/
|
|
10814
|
+
$ref: '#/components/schemas/AuthNMappingUpdateRequest'
|
|
9837
10815
|
required: true
|
|
9838
10816
|
responses:
|
|
9839
10817
|
'200':
|
|
9840
10818
|
content:
|
|
9841
10819
|
application/json:
|
|
9842
10820
|
schema:
|
|
9843
|
-
$ref: '#/components/schemas/
|
|
10821
|
+
$ref: '#/components/schemas/AuthNMappingResponse'
|
|
9844
10822
|
description: OK
|
|
9845
10823
|
'400':
|
|
9846
10824
|
content:
|
|
@@ -9853,34 +10831,82 @@ paths:
|
|
|
9853
10831
|
application/json:
|
|
9854
10832
|
schema:
|
|
9855
10833
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9856
|
-
description:
|
|
10834
|
+
description: Authentication Error
|
|
9857
10835
|
'404':
|
|
9858
10836
|
content:
|
|
9859
10837
|
application/json:
|
|
9860
10838
|
schema:
|
|
9861
10839
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
9862
10840
|
description: Not Found
|
|
10841
|
+
'409':
|
|
10842
|
+
content:
|
|
10843
|
+
application/json:
|
|
10844
|
+
schema:
|
|
10845
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10846
|
+
description: Conflict
|
|
10847
|
+
'422':
|
|
10848
|
+
content:
|
|
10849
|
+
application/json:
|
|
10850
|
+
schema:
|
|
10851
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
10852
|
+
description: Unprocessable Entity
|
|
9863
10853
|
'429':
|
|
9864
10854
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9865
|
-
|
|
10855
|
+
security:
|
|
10856
|
+
- apiKeyAuth: []
|
|
10857
|
+
appKeyAuth: []
|
|
10858
|
+
- AuthZ:
|
|
10859
|
+
- user_access_manage
|
|
10860
|
+
summary: Edit an AuthN Mapping
|
|
9866
10861
|
tags:
|
|
9867
|
-
-
|
|
10862
|
+
- AuthN Mappings
|
|
9868
10863
|
x-codegen-request-body-name: body
|
|
9869
|
-
|
|
10864
|
+
x-permission: OR(USER_ACCESS_MANAGE)
|
|
10865
|
+
/api/v2/ci/pipelines/analytics/aggregate:
|
|
10866
|
+
post:
|
|
10867
|
+
description: The API endpoint to aggregate CI Visibility pipeline events into
|
|
10868
|
+
buckets of computed metrics and timeseries.
|
|
10869
|
+
operationId: AggregateCIAppPipelineEvents
|
|
10870
|
+
requestBody:
|
|
10871
|
+
content:
|
|
10872
|
+
application/json:
|
|
10873
|
+
schema:
|
|
10874
|
+
$ref: '#/components/schemas/CIAppPipelinesAggregateRequest'
|
|
10875
|
+
required: true
|
|
10876
|
+
responses:
|
|
10877
|
+
'200':
|
|
10878
|
+
content:
|
|
10879
|
+
application/json:
|
|
10880
|
+
schema:
|
|
10881
|
+
$ref: '#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse'
|
|
10882
|
+
description: OK
|
|
10883
|
+
'400':
|
|
10884
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10885
|
+
'403':
|
|
10886
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10887
|
+
'429':
|
|
10888
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10889
|
+
security:
|
|
10890
|
+
- apiKeyAuth: []
|
|
10891
|
+
appKeyAuth: []
|
|
10892
|
+
- AuthZ: []
|
|
10893
|
+
summary: Aggregate pipelines events
|
|
10894
|
+
tags:
|
|
10895
|
+
- CI Visibility Pipelines
|
|
10896
|
+
x-codegen-request-body-name: body
|
|
10897
|
+
/api/v2/ci/pipelines/events:
|
|
9870
10898
|
get:
|
|
9871
|
-
description: 'List endpoint returns events that match
|
|
9872
|
-
|
|
9873
|
-
[Results are paginated][1].
|
|
10899
|
+
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
10900
|
+
a log search query.
|
|
9874
10901
|
|
|
9875
|
-
|
|
9876
|
-
Use this endpoint to see your latest Audit Logs events.
|
|
10902
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
9877
10903
|
|
|
9878
10904
|
|
|
9879
|
-
|
|
9880
|
-
operationId:
|
|
10905
|
+
Use this endpoint to see your latest pipeline events.'
|
|
10906
|
+
operationId: ListCIAppPipelineEvents
|
|
9881
10907
|
parameters:
|
|
9882
|
-
- description: Search query following
|
|
9883
|
-
example: '@
|
|
10908
|
+
- description: Search query following log syntax.
|
|
10909
|
+
example: '@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler'
|
|
9884
10910
|
in: query
|
|
9885
10911
|
name: filter[query]
|
|
9886
10912
|
required: false
|
|
@@ -9907,7 +10933,7 @@ paths:
|
|
|
9907
10933
|
name: sort
|
|
9908
10934
|
required: false
|
|
9909
10935
|
schema:
|
|
9910
|
-
$ref: '#/components/schemas/
|
|
10936
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
9911
10937
|
- description: List following results with a cursor provided in the previous
|
|
9912
10938
|
query.
|
|
9913
10939
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
@@ -9931,47 +10957,7 @@ paths:
|
|
|
9931
10957
|
content:
|
|
9932
10958
|
application/json:
|
|
9933
10959
|
schema:
|
|
9934
|
-
$ref: '#/components/schemas/
|
|
9935
|
-
description: OK
|
|
9936
|
-
'400':
|
|
9937
|
-
$ref: '#/components/responses/BadRequestResponse'
|
|
9938
|
-
'403':
|
|
9939
|
-
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
9940
|
-
'429':
|
|
9941
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9942
|
-
summary: Get a list of Audit Logs events
|
|
9943
|
-
tags:
|
|
9944
|
-
- Audit
|
|
9945
|
-
x-pagination:
|
|
9946
|
-
cursorParam: page[cursor]
|
|
9947
|
-
cursorPath: meta.page.after
|
|
9948
|
-
limitParam: page[limit]
|
|
9949
|
-
resultsPath: data
|
|
9950
|
-
/api/v2/audit/events/search:
|
|
9951
|
-
post:
|
|
9952
|
-
description: 'List endpoint returns Audit Logs events that match an Audit search
|
|
9953
|
-
query.
|
|
9954
|
-
|
|
9955
|
-
[Results are paginated][1].
|
|
9956
|
-
|
|
9957
|
-
|
|
9958
|
-
Use this endpoint to build complex Audit Logs events filtering and search.
|
|
9959
|
-
|
|
9960
|
-
|
|
9961
|
-
[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination'
|
|
9962
|
-
operationId: SearchAuditLogs
|
|
9963
|
-
requestBody:
|
|
9964
|
-
content:
|
|
9965
|
-
application/json:
|
|
9966
|
-
schema:
|
|
9967
|
-
$ref: '#/components/schemas/AuditLogsSearchEventsRequest'
|
|
9968
|
-
required: false
|
|
9969
|
-
responses:
|
|
9970
|
-
'200':
|
|
9971
|
-
content:
|
|
9972
|
-
application/json:
|
|
9973
|
-
schema:
|
|
9974
|
-
$ref: '#/components/schemas/AuditLogsEventsResponse'
|
|
10960
|
+
$ref: '#/components/schemas/CIAppPipelineEventsResponse'
|
|
9975
10961
|
description: OK
|
|
9976
10962
|
'400':
|
|
9977
10963
|
$ref: '#/components/responses/BadRequestResponse'
|
|
@@ -9979,229 +10965,217 @@ paths:
|
|
|
9979
10965
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
9980
10966
|
'429':
|
|
9981
10967
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
9982
|
-
summary: Search Audit Logs events
|
|
9983
|
-
tags:
|
|
9984
|
-
- Audit
|
|
9985
|
-
x-codegen-request-body-name: body
|
|
9986
|
-
x-pagination:
|
|
9987
|
-
cursorParam: body.page.cursor
|
|
9988
|
-
cursorPath: meta.page.after
|
|
9989
|
-
limitParam: body.page.limit
|
|
9990
|
-
resultsPath: data
|
|
9991
|
-
/api/v2/authn_mappings:
|
|
9992
|
-
get:
|
|
9993
|
-
description: List all AuthN Mappings in the org.
|
|
9994
|
-
operationId: ListAuthNMappings
|
|
9995
|
-
parameters:
|
|
9996
|
-
- $ref: '#/components/parameters/PageSize'
|
|
9997
|
-
- $ref: '#/components/parameters/PageNumber'
|
|
9998
|
-
- description: Sort AuthN Mappings depending on the given field.
|
|
9999
|
-
in: query
|
|
10000
|
-
name: sort
|
|
10001
|
-
required: false
|
|
10002
|
-
schema:
|
|
10003
|
-
$ref: '#/components/schemas/AuthNMappingsSort'
|
|
10004
|
-
- description: Filter all mappings by the given string.
|
|
10005
|
-
in: query
|
|
10006
|
-
name: filter
|
|
10007
|
-
required: false
|
|
10008
|
-
schema:
|
|
10009
|
-
type: string
|
|
10010
|
-
responses:
|
|
10011
|
-
'200':
|
|
10012
|
-
content:
|
|
10013
|
-
application/json:
|
|
10014
|
-
schema:
|
|
10015
|
-
$ref: '#/components/schemas/AuthNMappingsResponse'
|
|
10016
|
-
description: OK
|
|
10017
|
-
'403':
|
|
10018
|
-
content:
|
|
10019
|
-
application/json:
|
|
10020
|
-
schema:
|
|
10021
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10022
|
-
description: Authentication Error
|
|
10023
|
-
'429':
|
|
10024
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10025
10968
|
security:
|
|
10026
10969
|
- apiKeyAuth: []
|
|
10027
10970
|
appKeyAuth: []
|
|
10028
10971
|
- AuthZ: []
|
|
10029
|
-
summary:
|
|
10972
|
+
summary: Get a list of pipelines events
|
|
10030
10973
|
tags:
|
|
10031
|
-
-
|
|
10032
|
-
x-
|
|
10974
|
+
- CI Visibility Pipelines
|
|
10975
|
+
x-pagination:
|
|
10976
|
+
cursorParam: page[cursor]
|
|
10977
|
+
cursorPath: meta.page.after
|
|
10978
|
+
limitParam: page[limit]
|
|
10979
|
+
resultsPath: data
|
|
10980
|
+
/api/v2/ci/pipelines/events/search:
|
|
10033
10981
|
post:
|
|
10034
|
-
description:
|
|
10035
|
-
|
|
10982
|
+
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
10983
|
+
a log search query.
|
|
10984
|
+
|
|
10985
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
10986
|
+
|
|
10987
|
+
|
|
10988
|
+
Use this endpoint to build complex events filtering and search.'
|
|
10989
|
+
operationId: SearchCIAppPipelineEvents
|
|
10036
10990
|
requestBody:
|
|
10037
10991
|
content:
|
|
10038
10992
|
application/json:
|
|
10039
10993
|
schema:
|
|
10040
|
-
$ref: '#/components/schemas/
|
|
10041
|
-
required:
|
|
10994
|
+
$ref: '#/components/schemas/CIAppPipelineEventsRequest'
|
|
10995
|
+
required: false
|
|
10042
10996
|
responses:
|
|
10043
10997
|
'200':
|
|
10044
10998
|
content:
|
|
10045
10999
|
application/json:
|
|
10046
11000
|
schema:
|
|
10047
|
-
$ref: '#/components/schemas/
|
|
11001
|
+
$ref: '#/components/schemas/CIAppPipelineEventsResponse'
|
|
10048
11002
|
description: OK
|
|
10049
11003
|
'400':
|
|
10050
|
-
|
|
10051
|
-
application/json:
|
|
10052
|
-
schema:
|
|
10053
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10054
|
-
description: Bad Request
|
|
11004
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10055
11005
|
'403':
|
|
10056
|
-
|
|
10057
|
-
application/json:
|
|
10058
|
-
schema:
|
|
10059
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10060
|
-
description: Authentication Error
|
|
10061
|
-
'404':
|
|
10062
|
-
content:
|
|
10063
|
-
application/json:
|
|
10064
|
-
schema:
|
|
10065
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10066
|
-
description: Not Found
|
|
11006
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10067
11007
|
'429':
|
|
10068
11008
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10069
11009
|
security:
|
|
10070
11010
|
- apiKeyAuth: []
|
|
10071
11011
|
appKeyAuth: []
|
|
10072
|
-
- AuthZ:
|
|
10073
|
-
|
|
10074
|
-
summary: Create an AuthN Mapping
|
|
11012
|
+
- AuthZ: []
|
|
11013
|
+
summary: Search pipelines events
|
|
10075
11014
|
tags:
|
|
10076
|
-
-
|
|
11015
|
+
- CI Visibility Pipelines
|
|
10077
11016
|
x-codegen-request-body-name: body
|
|
10078
|
-
x-
|
|
10079
|
-
|
|
10080
|
-
|
|
10081
|
-
|
|
10082
|
-
|
|
10083
|
-
|
|
10084
|
-
|
|
11017
|
+
x-pagination:
|
|
11018
|
+
cursorParam: body.page.cursor
|
|
11019
|
+
cursorPath: meta.page.after
|
|
11020
|
+
limitParam: body.page.limit
|
|
11021
|
+
resultsPath: data
|
|
11022
|
+
/api/v2/ci/tests/analytics/aggregate:
|
|
11023
|
+
post:
|
|
11024
|
+
description: The API endpoint to aggregate CI Visibility test events into buckets
|
|
11025
|
+
of computed metrics and timeseries.
|
|
11026
|
+
operationId: AggregateCIAppTestEvents
|
|
11027
|
+
requestBody:
|
|
11028
|
+
content:
|
|
11029
|
+
application/json:
|
|
11030
|
+
schema:
|
|
11031
|
+
$ref: '#/components/schemas/CIAppTestsAggregateRequest'
|
|
11032
|
+
required: true
|
|
10085
11033
|
responses:
|
|
10086
|
-
'
|
|
10087
|
-
description: OK
|
|
10088
|
-
'403':
|
|
10089
|
-
content:
|
|
10090
|
-
application/json:
|
|
10091
|
-
schema:
|
|
10092
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10093
|
-
description: Authentication Error
|
|
10094
|
-
'404':
|
|
11034
|
+
'200':
|
|
10095
11035
|
content:
|
|
10096
11036
|
application/json:
|
|
10097
11037
|
schema:
|
|
10098
|
-
$ref: '#/components/schemas/
|
|
10099
|
-
description:
|
|
11038
|
+
$ref: '#/components/schemas/CIAppTestsAnalyticsAggregateResponse'
|
|
11039
|
+
description: OK
|
|
11040
|
+
'400':
|
|
11041
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
11042
|
+
'403':
|
|
11043
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10100
11044
|
'429':
|
|
10101
11045
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10102
11046
|
security:
|
|
10103
11047
|
- apiKeyAuth: []
|
|
10104
11048
|
appKeyAuth: []
|
|
10105
|
-
- AuthZ:
|
|
10106
|
-
|
|
10107
|
-
summary: Delete an AuthN Mapping
|
|
11049
|
+
- AuthZ: []
|
|
11050
|
+
summary: Aggregate tests events
|
|
10108
11051
|
tags:
|
|
10109
|
-
-
|
|
10110
|
-
x-
|
|
11052
|
+
- CI Visibility Tests
|
|
11053
|
+
x-codegen-request-body-name: body
|
|
11054
|
+
/api/v2/ci/tests/events:
|
|
10111
11055
|
get:
|
|
10112
|
-
description:
|
|
10113
|
-
|
|
11056
|
+
description: 'List endpoint returns CI Visibility test events that match a log
|
|
11057
|
+
search query.
|
|
11058
|
+
|
|
11059
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
11060
|
+
|
|
11061
|
+
|
|
11062
|
+
Use this endpoint to see your latest test events.'
|
|
11063
|
+
operationId: ListCIAppTestEvents
|
|
10114
11064
|
parameters:
|
|
10115
|
-
-
|
|
11065
|
+
- description: Search query following log syntax.
|
|
11066
|
+
example: '@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model'
|
|
11067
|
+
in: query
|
|
11068
|
+
name: filter[query]
|
|
11069
|
+
required: false
|
|
11070
|
+
schema:
|
|
11071
|
+
type: string
|
|
11072
|
+
- description: Minimum timestamp for requested events.
|
|
11073
|
+
example: '2019-01-02T09:42:36.320Z'
|
|
11074
|
+
in: query
|
|
11075
|
+
name: filter[from]
|
|
11076
|
+
required: false
|
|
11077
|
+
schema:
|
|
11078
|
+
format: date-time
|
|
11079
|
+
type: string
|
|
11080
|
+
- description: Maximum timestamp for requested events.
|
|
11081
|
+
example: '2019-01-03T09:42:36.320Z'
|
|
11082
|
+
in: query
|
|
11083
|
+
name: filter[to]
|
|
11084
|
+
required: false
|
|
11085
|
+
schema:
|
|
11086
|
+
format: date-time
|
|
11087
|
+
type: string
|
|
11088
|
+
- description: Order of events in results.
|
|
11089
|
+
in: query
|
|
11090
|
+
name: sort
|
|
11091
|
+
required: false
|
|
11092
|
+
schema:
|
|
11093
|
+
$ref: '#/components/schemas/CIAppSort'
|
|
11094
|
+
- description: List following results with a cursor provided in the previous
|
|
11095
|
+
query.
|
|
11096
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
11097
|
+
in: query
|
|
11098
|
+
name: page[cursor]
|
|
11099
|
+
required: false
|
|
11100
|
+
schema:
|
|
11101
|
+
type: string
|
|
11102
|
+
- description: Maximum number of events in the response.
|
|
11103
|
+
example: 25
|
|
11104
|
+
in: query
|
|
11105
|
+
name: page[limit]
|
|
11106
|
+
required: false
|
|
11107
|
+
schema:
|
|
11108
|
+
default: 10
|
|
11109
|
+
format: int32
|
|
11110
|
+
maximum: 1000
|
|
11111
|
+
type: integer
|
|
10116
11112
|
responses:
|
|
10117
11113
|
'200':
|
|
10118
11114
|
content:
|
|
10119
11115
|
application/json:
|
|
10120
11116
|
schema:
|
|
10121
|
-
$ref: '#/components/schemas/
|
|
11117
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
|
10122
11118
|
description: OK
|
|
11119
|
+
'400':
|
|
11120
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10123
11121
|
'403':
|
|
10124
|
-
|
|
10125
|
-
application/json:
|
|
10126
|
-
schema:
|
|
10127
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10128
|
-
description: Authentication Error
|
|
10129
|
-
'404':
|
|
10130
|
-
content:
|
|
10131
|
-
application/json:
|
|
10132
|
-
schema:
|
|
10133
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10134
|
-
description: Not Found
|
|
11122
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10135
11123
|
'429':
|
|
10136
11124
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10137
11125
|
security:
|
|
10138
11126
|
- apiKeyAuth: []
|
|
10139
11127
|
appKeyAuth: []
|
|
10140
11128
|
- AuthZ: []
|
|
10141
|
-
summary: Get
|
|
11129
|
+
summary: Get a list of tests events
|
|
10142
11130
|
tags:
|
|
10143
|
-
-
|
|
10144
|
-
x-
|
|
10145
|
-
|
|
10146
|
-
|
|
10147
|
-
|
|
10148
|
-
|
|
10149
|
-
|
|
11131
|
+
- CI Visibility Tests
|
|
11132
|
+
x-pagination:
|
|
11133
|
+
cursorParam: page[cursor]
|
|
11134
|
+
cursorPath: meta.page.after
|
|
11135
|
+
limitParam: page[limit]
|
|
11136
|
+
resultsPath: data
|
|
11137
|
+
/api/v2/ci/tests/events/search:
|
|
11138
|
+
post:
|
|
11139
|
+
description: 'List endpoint returns CI Visibility test events that match a log
|
|
11140
|
+
search query.
|
|
11141
|
+
|
|
11142
|
+
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
11143
|
+
|
|
11144
|
+
|
|
11145
|
+
Use this endpoint to build complex events filtering and search.'
|
|
11146
|
+
operationId: SearchCIAppTestEvents
|
|
10150
11147
|
requestBody:
|
|
10151
11148
|
content:
|
|
10152
11149
|
application/json:
|
|
10153
11150
|
schema:
|
|
10154
|
-
$ref: '#/components/schemas/
|
|
10155
|
-
required:
|
|
11151
|
+
$ref: '#/components/schemas/CIAppTestEventsRequest'
|
|
11152
|
+
required: false
|
|
10156
11153
|
responses:
|
|
10157
11154
|
'200':
|
|
10158
11155
|
content:
|
|
10159
11156
|
application/json:
|
|
10160
11157
|
schema:
|
|
10161
|
-
$ref: '#/components/schemas/
|
|
11158
|
+
$ref: '#/components/schemas/CIAppTestEventsResponse'
|
|
10162
11159
|
description: OK
|
|
10163
11160
|
'400':
|
|
10164
|
-
|
|
10165
|
-
application/json:
|
|
10166
|
-
schema:
|
|
10167
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10168
|
-
description: Bad Request
|
|
11161
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
10169
11162
|
'403':
|
|
10170
|
-
|
|
10171
|
-
application/json:
|
|
10172
|
-
schema:
|
|
10173
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10174
|
-
description: Authentication Error
|
|
10175
|
-
'404':
|
|
10176
|
-
content:
|
|
10177
|
-
application/json:
|
|
10178
|
-
schema:
|
|
10179
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10180
|
-
description: Not Found
|
|
10181
|
-
'409':
|
|
10182
|
-
content:
|
|
10183
|
-
application/json:
|
|
10184
|
-
schema:
|
|
10185
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10186
|
-
description: Conflict
|
|
10187
|
-
'422':
|
|
10188
|
-
content:
|
|
10189
|
-
application/json:
|
|
10190
|
-
schema:
|
|
10191
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
10192
|
-
description: Unprocessable Entity
|
|
11163
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
10193
11164
|
'429':
|
|
10194
11165
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
10195
11166
|
security:
|
|
10196
11167
|
- apiKeyAuth: []
|
|
10197
11168
|
appKeyAuth: []
|
|
10198
|
-
- AuthZ:
|
|
10199
|
-
|
|
10200
|
-
summary: Edit an AuthN Mapping
|
|
11169
|
+
- AuthZ: []
|
|
11170
|
+
summary: Search tests events
|
|
10201
11171
|
tags:
|
|
10202
|
-
-
|
|
11172
|
+
- CI Visibility Tests
|
|
10203
11173
|
x-codegen-request-body-name: body
|
|
10204
|
-
x-
|
|
11174
|
+
x-pagination:
|
|
11175
|
+
cursorParam: body.page.cursor
|
|
11176
|
+
cursorPath: meta.page.after
|
|
11177
|
+
limitParam: body.page.limit
|
|
11178
|
+
resultsPath: data
|
|
10205
11179
|
/api/v2/current_user/application_keys:
|
|
10206
11180
|
get:
|
|
10207
11181
|
description: List all application keys available for current user
|
|
@@ -11092,9 +12066,6 @@ paths:
|
|
|
11092
12066
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11093
12067
|
'429':
|
|
11094
12068
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11095
|
-
security:
|
|
11096
|
-
- apiKeyAuth: []
|
|
11097
|
-
appKeyAuth: []
|
|
11098
12069
|
summary: List Confluent accounts
|
|
11099
12070
|
tags:
|
|
11100
12071
|
- Confluent Cloud
|
|
@@ -11123,9 +12094,6 @@ paths:
|
|
|
11123
12094
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11124
12095
|
'429':
|
|
11125
12096
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11126
|
-
security:
|
|
11127
|
-
- apiKeyAuth: []
|
|
11128
|
-
appKeyAuth: []
|
|
11129
12097
|
summary: Add Confluent account
|
|
11130
12098
|
tags:
|
|
11131
12099
|
- Confluent Cloud
|
|
@@ -11147,9 +12115,6 @@ paths:
|
|
|
11147
12115
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11148
12116
|
'429':
|
|
11149
12117
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11150
|
-
security:
|
|
11151
|
-
- apiKeyAuth: []
|
|
11152
|
-
appKeyAuth: []
|
|
11153
12118
|
summary: Delete Confluent account
|
|
11154
12119
|
tags:
|
|
11155
12120
|
- Confluent Cloud
|
|
@@ -11173,9 +12138,6 @@ paths:
|
|
|
11173
12138
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11174
12139
|
'429':
|
|
11175
12140
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11176
|
-
security:
|
|
11177
|
-
- apiKeyAuth: []
|
|
11178
|
-
appKeyAuth: []
|
|
11179
12141
|
summary: Get Confluent account
|
|
11180
12142
|
tags:
|
|
11181
12143
|
- Confluent Cloud
|
|
@@ -11206,9 +12168,6 @@ paths:
|
|
|
11206
12168
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11207
12169
|
'429':
|
|
11208
12170
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11209
|
-
security:
|
|
11210
|
-
- apiKeyAuth: []
|
|
11211
|
-
appKeyAuth: []
|
|
11212
12171
|
summary: Update Confluent account
|
|
11213
12172
|
tags:
|
|
11214
12173
|
- Confluent Cloud
|
|
@@ -11235,9 +12194,6 @@ paths:
|
|
|
11235
12194
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11236
12195
|
'429':
|
|
11237
12196
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11238
|
-
security:
|
|
11239
|
-
- apiKeyAuth: []
|
|
11240
|
-
appKeyAuth: []
|
|
11241
12197
|
summary: List Confluent Account resources
|
|
11242
12198
|
tags:
|
|
11243
12199
|
- Confluent Cloud
|
|
@@ -11269,9 +12225,6 @@ paths:
|
|
|
11269
12225
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11270
12226
|
'429':
|
|
11271
12227
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11272
|
-
security:
|
|
11273
|
-
- apiKeyAuth: []
|
|
11274
|
-
appKeyAuth: []
|
|
11275
12228
|
summary: Add resource to Confluent account
|
|
11276
12229
|
tags:
|
|
11277
12230
|
- Confluent Cloud
|
|
@@ -11295,9 +12248,6 @@ paths:
|
|
|
11295
12248
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11296
12249
|
'429':
|
|
11297
12250
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11298
|
-
security:
|
|
11299
|
-
- apiKeyAuth: []
|
|
11300
|
-
appKeyAuth: []
|
|
11301
12251
|
summary: Delete resource from Confluent account
|
|
11302
12252
|
tags:
|
|
11303
12253
|
- Confluent Cloud
|
|
@@ -11323,9 +12273,6 @@ paths:
|
|
|
11323
12273
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11324
12274
|
'429':
|
|
11325
12275
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11326
|
-
security:
|
|
11327
|
-
- apiKeyAuth: []
|
|
11328
|
-
appKeyAuth: []
|
|
11329
12276
|
summary: Get resource from Confluent account
|
|
11330
12277
|
tags:
|
|
11331
12278
|
- Confluent Cloud
|
|
@@ -11358,9 +12305,6 @@ paths:
|
|
|
11358
12305
|
$ref: '#/components/responses/NotFoundResponse'
|
|
11359
12306
|
'429':
|
|
11360
12307
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
11361
|
-
security:
|
|
11362
|
-
- apiKeyAuth: []
|
|
11363
|
-
appKeyAuth: []
|
|
11364
12308
|
summary: Update resource in Confluent account
|
|
11365
12309
|
tags:
|
|
11366
12310
|
- Confluent Cloud
|
|
@@ -12180,6 +13124,13 @@ paths:
|
|
|
12180
13124
|
schema:
|
|
12181
13125
|
format: date-time
|
|
12182
13126
|
type: string
|
|
13127
|
+
- description: Specifies the storage type to be used
|
|
13128
|
+
example: indexes
|
|
13129
|
+
in: query
|
|
13130
|
+
name: filter[storage_tier]
|
|
13131
|
+
required: false
|
|
13132
|
+
schema:
|
|
13133
|
+
$ref: '#/components/schemas/LogsStorageTier'
|
|
12183
13134
|
- description: Order of logs in results.
|
|
12184
13135
|
in: query
|
|
12185
13136
|
name: sort
|
|
@@ -13914,7 +14865,7 @@ paths:
|
|
|
13914
14865
|
Cloud Workload Security rules, and downloads them as a .policy file. This
|
|
13915
14866
|
file can then be deployed to
|
|
13916
14867
|
|
|
13917
|
-
your
|
|
14868
|
+
your Agents to update the policy running in your environment.'
|
|
13918
14869
|
operationId: DownloadCloudWorkloadPolicyFile
|
|
13919
14870
|
responses:
|
|
13920
14871
|
'200':
|
|
@@ -14500,7 +15451,7 @@ paths:
|
|
|
14500
15451
|
- apiKeyAuth: []
|
|
14501
15452
|
appKeyAuth: []
|
|
14502
15453
|
- AuthZ:
|
|
14503
|
-
-
|
|
15454
|
+
- security_monitoring_signals_read
|
|
14504
15455
|
summary: Get a signal's details
|
|
14505
15456
|
tags:
|
|
14506
15457
|
- Security Monitoring
|
|
@@ -15514,7 +16465,9 @@ paths:
|
|
|
15514
16465
|
get:
|
|
15515
16466
|
description: 'Get estimated cost across multi-org and single root-org accounts.
|
|
15516
16467
|
|
|
15517
|
-
Estimated cost data is only available for the current month and previous month
|
|
16468
|
+
Estimated cost data is only available for the current month and previous month
|
|
16469
|
+
|
|
16470
|
+
and is delayed by up to 72 hours from when it was incurred.
|
|
15518
16471
|
|
|
15519
16472
|
To access historical costs prior to this, use the `/historical_cost` endpoint.'
|
|
15520
16473
|
operationId: GetEstimatedCostByOrg
|
|
@@ -15663,7 +16616,7 @@ paths:
|
|
|
15663
16616
|
- Usage Metering
|
|
15664
16617
|
/api/v2/usage/hourly_usage:
|
|
15665
16618
|
get:
|
|
15666
|
-
description: Get hourly usage by product family
|
|
16619
|
+
description: Get hourly usage by product family.
|
|
15667
16620
|
operationId: GetHourlyUsage
|
|
15668
16621
|
parameters:
|
|
15669
16622
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
|
|
@@ -16043,7 +16996,8 @@ paths:
|
|
|
16043
16996
|
security:
|
|
16044
16997
|
- apiKeyAuth: []
|
|
16045
16998
|
appKeyAuth: []
|
|
16046
|
-
- AuthZ:
|
|
16999
|
+
- AuthZ:
|
|
17000
|
+
- user_access_read
|
|
16047
17001
|
summary: List all users
|
|
16048
17002
|
tags:
|
|
16049
17003
|
- Users
|
|
@@ -16150,7 +17104,8 @@ paths:
|
|
|
16150
17104
|
security:
|
|
16151
17105
|
- apiKeyAuth: []
|
|
16152
17106
|
appKeyAuth: []
|
|
16153
|
-
- AuthZ:
|
|
17107
|
+
- AuthZ:
|
|
17108
|
+
- user_access_read
|
|
16154
17109
|
summary: Get user details
|
|
16155
17110
|
tags:
|
|
16156
17111
|
- Users
|
|
@@ -16279,7 +17234,8 @@ paths:
|
|
|
16279
17234
|
security:
|
|
16280
17235
|
- apiKeyAuth: []
|
|
16281
17236
|
appKeyAuth: []
|
|
16282
|
-
- AuthZ:
|
|
17237
|
+
- AuthZ:
|
|
17238
|
+
- user_access_read
|
|
16283
17239
|
summary: Get a user permissions
|
|
16284
17240
|
tags:
|
|
16285
17241
|
- Users
|
|
@@ -16327,6 +17283,10 @@ tags:
|
|
|
16327
17283
|
|
|
16328
17284
|
sent from Identity Providers.'
|
|
16329
17285
|
name: AuthN Mappings
|
|
17286
|
+
- description: Search or aggregate your CI Visibility pipeline events over HTTP.
|
|
17287
|
+
name: CI Visibility Pipelines
|
|
17288
|
+
- description: Search or aggregate your CI Visibility test events over HTTP.
|
|
17289
|
+
name: CI Visibility Tests
|
|
16330
17290
|
- description: Workload activity security rules for generating events using the Datadog
|
|
16331
17291
|
security Agent.
|
|
16332
17292
|
name: Cloud Workload Security
|