datadog_api_client 2.13.0 → 2.14.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 +181 -16
- data/.generator/schemas/v2/openapi.yaml +391 -151
- data/.generator/src/generator/formatter.py +34 -29
- data/.generator/src/generator/templates/api_client.j2 +81 -53
- data/.generator/src/generator/templates/configuration.j2 +21 -0
- data/.pre-commit-config.yaml +2 -2
- data/CHANGELOG.md +31 -0
- data/README.md +23 -0
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +3 -0
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +3 -0
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +3 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +3 -0
- data/examples/v1/dashboards/CreateDashboard_252716965.rb +6 -0
- data/examples/v1/dashboards/DeletePublicDashboardInvitation.rb +3 -3
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +1 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +3 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +3 -0
- data/examples/v2/logs/AggregateLogs_2955613758.rb +1 -1
- data/examples/v2/teams/CreateTeam.rb +2 -2
- data/examples/v2/teams/CreateTeam_252121814.rb +24 -0
- data/examples/v2/teams/GetUserMemberships.rb +8 -0
- data/examples/v2/teams/UpdateTeam.rb +9 -0
- data/lib/datadog_api_client/api_client.rb +81 -53
- data/lib/datadog_api_client/configuration.rb +22 -0
- data/lib/datadog_api_client/inflector.rb +10 -1
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +2 -2
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +10 -10
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v1/models/azure_account.rb +32 -1
- data/lib/datadog_api_client/v1/models/distribution_widget_definition.rb +13 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +3 -0
- 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 +61 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_ci_visibility_hour.rb +12 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +24 -4
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +24 -4
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +24 -4
- data/lib/datadog_api_client/v1/models/widget_comparator.rb +1 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +10 -6
- data/lib/datadog_api_client/v2/api/ip_allowlist_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +3 -3
- data/lib/datadog_api_client/v2/api/spans_metrics_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/teams_api.rb +65 -0
- data/lib/datadog_api_client/v2/models/application_key_create_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/application_key_update_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/audit_logs_event_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/ci_app_event_attributes.rb +9 -21
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event.rb +1 -1
- data/lib/datadog_api_client/v2/models/{team_data.rb → ci_app_pipeline_event_attributes.rb} +24 -62
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_level.rb +30 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_query_filter.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_test_level.rb +29 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_analytics_aggregate_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_tests_query_filter.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_compliance_signal_options.rb +25 -1
- data/lib/datadog_api_client/v2/models/dashboard_list_item.rb +25 -1
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_response.rb +19 -1
- data/lib/datadog_api_client/v2/models/formula_limit.rb +1 -0
- data/lib/datadog_api_client/v2/models/full_application_key_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_aggregate_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_aggregate_request_page.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_group_by.rb +3 -2
- data/lib/datadog_api_client/v2/models/logs_group_by_histogram.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_list_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_query_options.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_response_metadata_page.rb +1 -1
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap.rb +14 -4
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/partial_application_key_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/query_formula.rb +1 -0
- data/lib/datadog_api_client/v2/models/relationship_to_team_links.rb +14 -4
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_permission.rb +14 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_metadata_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response_query.rb +26 -2
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state_update_data.rb +24 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_update_data.rb +24 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +1 -19
- data/lib/datadog_api_client/v2/models/security_monitoring_triage_user.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_get_config_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_meta.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/team_attributes.rb +50 -4
- data/lib/datadog_api_client/v2/models/team_create_attributes.rb +57 -4
- data/lib/datadog_api_client/v2/models/team_relationships_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/team_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/team_update_attributes.rb +57 -4
- data/lib/datadog_api_client/v2/models/teams_response.rb +24 -4
- data/lib/datadog_api_client/v2/models/teams_response_links.rb +129 -0
- data/lib/datadog_api_client/v2/models/teams_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/teams_response_meta_pagination.rb +150 -0
- data/lib/datadog_api_client/v2/models/usage_attributes_object.rb +11 -1
- data/lib/datadog_api_client/v2/models/user_teams_response.rb +24 -4
- data/lib/datadog_api_client/version.rb +1 -1
- data/spec/configuration_spec.rb +17 -0
- data/spec/retry_spec.rb +44 -0
- metadata +16 -3
|
@@ -622,7 +622,6 @@ components:
|
|
|
622
622
|
description: An object related to an API key.
|
|
623
623
|
oneOf:
|
|
624
624
|
- $ref: '#/components/schemas/User'
|
|
625
|
-
type: object
|
|
626
625
|
APIKeyUpdateAttributes:
|
|
627
626
|
description: Attributes used to update an API Key.
|
|
628
627
|
properties:
|
|
@@ -710,9 +709,7 @@ components:
|
|
|
710
709
|
example: Application Key for managing dashboards
|
|
711
710
|
type: string
|
|
712
711
|
scopes:
|
|
713
|
-
description: Array of scopes to grant the application key.
|
|
714
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
715
|
-
your application keys.
|
|
712
|
+
description: Array of scopes to grant the application key.
|
|
716
713
|
example:
|
|
717
714
|
- dashboards_read
|
|
718
715
|
- dashboards_write
|
|
@@ -766,7 +763,6 @@ components:
|
|
|
766
763
|
oneOf:
|
|
767
764
|
- $ref: '#/components/schemas/User'
|
|
768
765
|
- $ref: '#/components/schemas/Role'
|
|
769
|
-
type: object
|
|
770
766
|
ApplicationKeyUpdateAttributes:
|
|
771
767
|
description: Attributes used to update an application Key.
|
|
772
768
|
properties:
|
|
@@ -775,9 +771,7 @@ components:
|
|
|
775
771
|
example: Application Key for managing dashboards
|
|
776
772
|
type: string
|
|
777
773
|
scopes:
|
|
778
|
-
description: Array of scopes to grant the application key.
|
|
779
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
780
|
-
your application keys.
|
|
774
|
+
description: Array of scopes to grant the application key.
|
|
781
775
|
example:
|
|
782
776
|
- dashboards_read
|
|
783
777
|
- dashboards_write
|
|
@@ -863,6 +857,9 @@ components:
|
|
|
863
857
|
customAttribute: 123
|
|
864
858
|
duration: 2345
|
|
865
859
|
type: object
|
|
860
|
+
message:
|
|
861
|
+
description: Message of the event.
|
|
862
|
+
type: string
|
|
866
863
|
service:
|
|
867
864
|
description: 'Name of the application or service generating Audit Logs events.
|
|
868
865
|
|
|
@@ -1146,8 +1143,6 @@ components:
|
|
|
1146
1143
|
oneOf:
|
|
1147
1144
|
- $ref: '#/components/schemas/SAMLAssertionAttribute'
|
|
1148
1145
|
- $ref: '#/components/schemas/Role'
|
|
1149
|
-
properties: {}
|
|
1150
|
-
type: object
|
|
1151
1146
|
AuthNMappingRelationships:
|
|
1152
1147
|
description: All relationships associated with AuthN Mapping.
|
|
1153
1148
|
properties:
|
|
@@ -1485,25 +1480,15 @@ components:
|
|
|
1485
1480
|
properties:
|
|
1486
1481
|
attributes:
|
|
1487
1482
|
additionalProperties: {}
|
|
1488
|
-
description: JSON object of attributes from CI Visibility events.
|
|
1483
|
+
description: JSON object of attributes from CI Visibility test events.
|
|
1489
1484
|
example:
|
|
1490
1485
|
customAttribute: 123
|
|
1491
1486
|
duration: 2345
|
|
1492
1487
|
type: object
|
|
1493
|
-
service:
|
|
1494
|
-
description: 'The name of the application or service generating CI Visibility
|
|
1495
|
-
events.
|
|
1496
|
-
|
|
1497
|
-
It is used to switch from CI Visibility to APM, so make sure you define
|
|
1498
|
-
the same
|
|
1499
|
-
|
|
1500
|
-
value when you use both products.'
|
|
1501
|
-
example: web-ui-tests
|
|
1502
|
-
type: string
|
|
1503
1488
|
tags:
|
|
1504
1489
|
$ref: '#/components/schemas/TagsEventAttribute'
|
|
1505
|
-
|
|
1506
|
-
$ref: '#/components/schemas/
|
|
1490
|
+
test_level:
|
|
1491
|
+
$ref: '#/components/schemas/CIAppTestLevel'
|
|
1507
1492
|
type: object
|
|
1508
1493
|
CIAppGitInfo:
|
|
1509
1494
|
description: 'If pipelines are triggered due to actions to a Git repository,
|
|
@@ -1665,7 +1650,7 @@ components:
|
|
|
1665
1650
|
stored by Datadog.
|
|
1666
1651
|
properties:
|
|
1667
1652
|
attributes:
|
|
1668
|
-
$ref: '#/components/schemas/
|
|
1653
|
+
$ref: '#/components/schemas/CIAppPipelineEventAttributes'
|
|
1669
1654
|
id:
|
|
1670
1655
|
description: Unique ID of the event.
|
|
1671
1656
|
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
|
@@ -1673,6 +1658,22 @@ components:
|
|
|
1673
1658
|
type:
|
|
1674
1659
|
$ref: '#/components/schemas/CIAppPipelineEventTypeName'
|
|
1675
1660
|
type: object
|
|
1661
|
+
CIAppPipelineEventAttributes:
|
|
1662
|
+
description: JSON object containing all event attributes and their associated
|
|
1663
|
+
values.
|
|
1664
|
+
properties:
|
|
1665
|
+
attributes:
|
|
1666
|
+
additionalProperties: {}
|
|
1667
|
+
description: JSON object of attributes from CI Visibility pipeline events.
|
|
1668
|
+
example:
|
|
1669
|
+
customAttribute: 123
|
|
1670
|
+
duration: 2345
|
|
1671
|
+
type: object
|
|
1672
|
+
ci_level:
|
|
1673
|
+
$ref: '#/components/schemas/CIAppPipelineLevel'
|
|
1674
|
+
tags:
|
|
1675
|
+
$ref: '#/components/schemas/TagsEventAttribute'
|
|
1676
|
+
type: object
|
|
1676
1677
|
CIAppPipelineEventJob:
|
|
1677
1678
|
description: Details of a CI job.
|
|
1678
1679
|
properties:
|
|
@@ -2194,6 +2195,22 @@ components:
|
|
|
2194
2195
|
meta:
|
|
2195
2196
|
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2196
2197
|
type: object
|
|
2198
|
+
CIAppPipelineLevel:
|
|
2199
|
+
description: Pipeline execution level.
|
|
2200
|
+
enum:
|
|
2201
|
+
- pipeline
|
|
2202
|
+
- stage
|
|
2203
|
+
- job
|
|
2204
|
+
- step
|
|
2205
|
+
- custom
|
|
2206
|
+
example: pipeline
|
|
2207
|
+
type: string
|
|
2208
|
+
x-enum-varnames:
|
|
2209
|
+
- PIPELINE
|
|
2210
|
+
- STAGE
|
|
2211
|
+
- JOB
|
|
2212
|
+
- STEP
|
|
2213
|
+
- CUSTOM
|
|
2197
2214
|
CIAppPipelinesAggregateRequest:
|
|
2198
2215
|
description: The object sent with the request to retrieve aggregation buckets
|
|
2199
2216
|
of pipeline events from your organization.
|
|
@@ -2281,7 +2298,8 @@ components:
|
|
|
2281
2298
|
type: string
|
|
2282
2299
|
query:
|
|
2283
2300
|
default: '*'
|
|
2284
|
-
description: The search query following the
|
|
2301
|
+
description: The search query following the CI Visibility Explorer search
|
|
2302
|
+
syntax.
|
|
2285
2303
|
example: '@ci.provider.name:github AND @ci.status:error'
|
|
2286
2304
|
type: string
|
|
2287
2305
|
to:
|
|
@@ -2467,6 +2485,20 @@ components:
|
|
|
2467
2485
|
meta:
|
|
2468
2486
|
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2469
2487
|
type: object
|
|
2488
|
+
CIAppTestLevel:
|
|
2489
|
+
description: Test run level.
|
|
2490
|
+
enum:
|
|
2491
|
+
- session
|
|
2492
|
+
- module
|
|
2493
|
+
- suite
|
|
2494
|
+
- test
|
|
2495
|
+
example: test
|
|
2496
|
+
type: string
|
|
2497
|
+
x-enum-varnames:
|
|
2498
|
+
- SESSION
|
|
2499
|
+
- MODULE
|
|
2500
|
+
- SUITE
|
|
2501
|
+
- TEST
|
|
2470
2502
|
CIAppTestsAggregateRequest:
|
|
2471
2503
|
description: The object sent with the request to retrieve aggregation buckets
|
|
2472
2504
|
of test events from your organization.
|
|
@@ -2504,7 +2536,7 @@ components:
|
|
|
2504
2536
|
links:
|
|
2505
2537
|
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
2506
2538
|
meta:
|
|
2507
|
-
$ref: '#/components/schemas/
|
|
2539
|
+
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2508
2540
|
type: object
|
|
2509
2541
|
CIAppTestsBucketResponse:
|
|
2510
2542
|
description: Bucket values.
|
|
@@ -2554,7 +2586,8 @@ components:
|
|
|
2554
2586
|
type: string
|
|
2555
2587
|
query:
|
|
2556
2588
|
default: '*'
|
|
2557
|
-
description: The search query following the
|
|
2589
|
+
description: The search query following the CI Visibility Explorer search
|
|
2590
|
+
syntax.
|
|
2558
2591
|
example: '@test.service:web-ui-tests AND @test.status:fail'
|
|
2559
2592
|
type: string
|
|
2560
2593
|
to:
|
|
@@ -2600,6 +2633,7 @@ components:
|
|
|
2600
2633
|
type: string
|
|
2601
2634
|
type: object
|
|
2602
2635
|
CloudConfigurationComplianceRuleOptions:
|
|
2636
|
+
additionalProperties: {}
|
|
2603
2637
|
description: 'Options for cloud_configuration rules.
|
|
2604
2638
|
|
|
2605
2639
|
Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration`
|
|
@@ -2671,6 +2705,16 @@ components:
|
|
|
2671
2705
|
description: How to generate compliance signals. Useful for cloud_configuration
|
|
2672
2706
|
rules only.
|
|
2673
2707
|
properties:
|
|
2708
|
+
defaultActivationStatus:
|
|
2709
|
+
description: The default activation status.
|
|
2710
|
+
nullable: true
|
|
2711
|
+
type: boolean
|
|
2712
|
+
defaultGroupByFields:
|
|
2713
|
+
description: The default group by fields.
|
|
2714
|
+
items:
|
|
2715
|
+
type: string
|
|
2716
|
+
nullable: true
|
|
2717
|
+
type: array
|
|
2674
2718
|
userActivationStatus:
|
|
2675
2719
|
description: Whether signals will be sent.
|
|
2676
2720
|
nullable: true
|
|
@@ -3557,6 +3601,15 @@ components:
|
|
|
3557
3601
|
maximum: 5
|
|
3558
3602
|
readOnly: true
|
|
3559
3603
|
type: integer
|
|
3604
|
+
tags:
|
|
3605
|
+
description: List of team names representing ownership of a dashboard.
|
|
3606
|
+
items:
|
|
3607
|
+
description: The name of a Datadog team, formatted as `team:<name>`
|
|
3608
|
+
type: string
|
|
3609
|
+
maxItems: 5
|
|
3610
|
+
nullable: true
|
|
3611
|
+
readOnly: true
|
|
3612
|
+
type: array
|
|
3560
3613
|
title:
|
|
3561
3614
|
description: Title of the dashboard.
|
|
3562
3615
|
readOnly: true
|
|
@@ -3820,7 +3873,6 @@ components:
|
|
|
3820
3873
|
oneOf:
|
|
3821
3874
|
- $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
|
|
3822
3875
|
- $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
|
|
3823
|
-
type: object
|
|
3824
3876
|
DowntimeMonitorIdentifierId:
|
|
3825
3877
|
additionalProperties: {}
|
|
3826
3878
|
description: Object of the monitor identifier.
|
|
@@ -4055,13 +4107,11 @@ components:
|
|
|
4055
4107
|
oneOf:
|
|
4056
4108
|
- $ref: '#/components/schemas/User'
|
|
4057
4109
|
- $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
|
|
4058
|
-
type: object
|
|
4059
4110
|
DowntimeScheduleCreateRequest:
|
|
4060
4111
|
description: Schedule for the downtime.
|
|
4061
4112
|
oneOf:
|
|
4062
4113
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest'
|
|
4063
4114
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4064
|
-
type: object
|
|
4065
4115
|
DowntimeScheduleCurrentDowntimeResponse:
|
|
4066
4116
|
description: 'The most recent actual start and end dates for a recurring downtime.
|
|
4067
4117
|
For a canceled downtime,
|
|
@@ -4120,6 +4170,8 @@ components:
|
|
|
4120
4170
|
example: 2020-01-02 03:04:00+00:00
|
|
4121
4171
|
format: date-time
|
|
4122
4172
|
type: string
|
|
4173
|
+
required:
|
|
4174
|
+
- start
|
|
4123
4175
|
type: object
|
|
4124
4176
|
DowntimeScheduleRecurrenceCreateUpdateRequest:
|
|
4125
4177
|
additionalProperties: {}
|
|
@@ -4241,13 +4293,11 @@ components:
|
|
|
4241
4293
|
oneOf:
|
|
4242
4294
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
|
|
4243
4295
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
|
|
4244
|
-
type: object
|
|
4245
4296
|
DowntimeScheduleUpdateRequest:
|
|
4246
4297
|
description: Schedule for the downtime.
|
|
4247
4298
|
oneOf:
|
|
4248
4299
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest'
|
|
4249
4300
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4250
|
-
type: object
|
|
4251
4301
|
DowntimeScope:
|
|
4252
4302
|
description: The scope to which the downtime applies. Must follow the [common
|
|
4253
4303
|
search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
@@ -5183,8 +5233,10 @@ components:
|
|
|
5183
5233
|
x-enum-varnames:
|
|
5184
5234
|
- FINDING
|
|
5185
5235
|
FormulaLimit:
|
|
5186
|
-
description: Message for specifying limits to the number of values returned
|
|
5236
|
+
description: 'Message for specifying limits to the number of values returned
|
|
5187
5237
|
by a query.
|
|
5238
|
+
|
|
5239
|
+
This limit is only for scalar queries and has no effect on timeseries queries.'
|
|
5188
5240
|
properties:
|
|
5189
5241
|
count:
|
|
5190
5242
|
description: The number of results to which to limit.
|
|
@@ -5274,9 +5326,7 @@ components:
|
|
|
5274
5326
|
example: Application Key for managing dashboards
|
|
5275
5327
|
type: string
|
|
5276
5328
|
scopes:
|
|
5277
|
-
description: Array of scopes to grant the application key.
|
|
5278
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
5279
|
-
your application keys.
|
|
5329
|
+
description: Array of scopes to grant the application key.
|
|
5280
5330
|
example:
|
|
5281
5331
|
- dashboards_read
|
|
5282
5332
|
- dashboards_write
|
|
@@ -5799,7 +5849,6 @@ components:
|
|
|
5799
5849
|
oneOf:
|
|
5800
5850
|
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
5801
5851
|
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
5802
|
-
type: object
|
|
5803
5852
|
IncidentAttachmentData:
|
|
5804
5853
|
description: A single incident attachment.
|
|
5805
5854
|
example:
|
|
@@ -5914,7 +5963,6 @@ components:
|
|
|
5914
5963
|
oneOf:
|
|
5915
5964
|
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
5916
5965
|
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
5917
|
-
type: object
|
|
5918
5966
|
IncidentAttachmentUpdateData:
|
|
5919
5967
|
description: A single incident attachment.
|
|
5920
5968
|
properties:
|
|
@@ -6020,7 +6068,6 @@ components:
|
|
|
6020
6068
|
description: An object related to an attachment that is included in the response.
|
|
6021
6069
|
oneOf:
|
|
6022
6070
|
- $ref: '#/components/schemas/User'
|
|
6023
|
-
type: object
|
|
6024
6071
|
IncidentCreateAttributes:
|
|
6025
6072
|
description: The incident's attributes for a create request.
|
|
6026
6073
|
properties:
|
|
@@ -6101,7 +6148,6 @@ components:
|
|
|
6101
6148
|
- $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue'
|
|
6102
6149
|
required:
|
|
6103
6150
|
- type
|
|
6104
|
-
type: object
|
|
6105
6151
|
IncidentFieldAttributesMultipleValue:
|
|
6106
6152
|
description: A field with potentially multiple values selected.
|
|
6107
6153
|
properties:
|
|
@@ -6232,7 +6278,6 @@ components:
|
|
|
6232
6278
|
oneOf:
|
|
6233
6279
|
- $ref: '#/components/schemas/SlackIntegrationMetadata'
|
|
6234
6280
|
- $ref: '#/components/schemas/JiraIntegrationMetadata'
|
|
6235
|
-
type: object
|
|
6236
6281
|
IncidentIntegrationMetadataPatchData:
|
|
6237
6282
|
description: Incident integration metadata data for a patch request.
|
|
6238
6283
|
properties:
|
|
@@ -6286,7 +6331,6 @@ components:
|
|
|
6286
6331
|
in the response.
|
|
6287
6332
|
oneOf:
|
|
6288
6333
|
- $ref: '#/components/schemas/User'
|
|
6289
|
-
type: object
|
|
6290
6334
|
IncidentIntegrationMetadataType:
|
|
6291
6335
|
default: incident_integrations
|
|
6292
6336
|
description: Integration metadata resource type.
|
|
@@ -6466,7 +6510,6 @@ components:
|
|
|
6466
6510
|
oneOf:
|
|
6467
6511
|
- $ref: '#/components/schemas/User'
|
|
6468
6512
|
- $ref: '#/components/schemas/IncidentAttachmentData'
|
|
6469
|
-
type: object
|
|
6470
6513
|
IncidentResponseMeta:
|
|
6471
6514
|
description: The metadata object containing pagination metadata.
|
|
6472
6515
|
properties:
|
|
@@ -6766,7 +6809,6 @@ components:
|
|
|
6766
6809
|
included payload.
|
|
6767
6810
|
oneOf:
|
|
6768
6811
|
- $ref: '#/components/schemas/User'
|
|
6769
|
-
type: object
|
|
6770
6812
|
IncidentServiceRelationships:
|
|
6771
6813
|
description: The incident service's relationships.
|
|
6772
6814
|
properties:
|
|
@@ -6925,7 +6967,6 @@ components:
|
|
|
6925
6967
|
payload.
|
|
6926
6968
|
oneOf:
|
|
6927
6969
|
- $ref: '#/components/schemas/User'
|
|
6928
|
-
type: object
|
|
6929
6970
|
IncidentTeamRelationships:
|
|
6930
6971
|
description: The incident team's relationships.
|
|
6931
6972
|
properties:
|
|
@@ -7052,7 +7093,6 @@ components:
|
|
|
7052
7093
|
description: The timeline cell's attributes for a create request.
|
|
7053
7094
|
oneOf:
|
|
7054
7095
|
- $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes'
|
|
7055
|
-
type: object
|
|
7056
7096
|
IncidentTimelineCellMarkdownContentType:
|
|
7057
7097
|
default: markdown
|
|
7058
7098
|
description: Type of the Markdown timeline cell.
|
|
@@ -7254,7 +7294,6 @@ components:
|
|
|
7254
7294
|
description: An object related to an incident todo that is included in the response.
|
|
7255
7295
|
oneOf:
|
|
7256
7296
|
- $ref: '#/components/schemas/User'
|
|
7257
|
-
type: object
|
|
7258
7297
|
IncidentTodoType:
|
|
7259
7298
|
default: incident_todos
|
|
7260
7299
|
description: Todo resource type.
|
|
@@ -7785,7 +7824,8 @@ components:
|
|
|
7785
7824
|
description: Paging settings
|
|
7786
7825
|
properties:
|
|
7787
7826
|
cursor:
|
|
7788
|
-
description: The returned paging point to use to get the next results
|
|
7827
|
+
description: 'The returned paging point to use to get the next results.
|
|
7828
|
+
Note: at most 1000 results can be paged.'
|
|
7789
7829
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
7790
7830
|
type: string
|
|
7791
7831
|
type: object
|
|
@@ -7993,7 +8033,6 @@ components:
|
|
|
7993
8033
|
required:
|
|
7994
8034
|
- type
|
|
7995
8035
|
- integration
|
|
7996
|
-
type: object
|
|
7997
8036
|
LogsArchiveDefinition:
|
|
7998
8037
|
description: The definition of an archive.
|
|
7999
8038
|
properties:
|
|
@@ -8023,7 +8062,6 @@ components:
|
|
|
8023
8062
|
required:
|
|
8024
8063
|
- type
|
|
8025
8064
|
- integration
|
|
8026
|
-
type: object
|
|
8027
8065
|
LogsArchiveDestinationAzure:
|
|
8028
8066
|
description: The Azure archive destination.
|
|
8029
8067
|
properties:
|
|
@@ -8270,7 +8308,11 @@ components:
|
|
|
8270
8308
|
$ref: '#/components/schemas/LogsGroupByHistogram'
|
|
8271
8309
|
limit:
|
|
8272
8310
|
default: 10
|
|
8273
|
-
description: The maximum buckets to return for this group by
|
|
8311
|
+
description: 'The maximum buckets to return for this group by. Note: at
|
|
8312
|
+
most 10000 buckets are allowed.
|
|
8313
|
+
|
|
8314
|
+
If grouping by multiple facets, the product of limits must not exceed
|
|
8315
|
+
10000.'
|
|
8274
8316
|
format: int64
|
|
8275
8317
|
type: integer
|
|
8276
8318
|
missing:
|
|
@@ -8285,7 +8327,7 @@ components:
|
|
|
8285
8327
|
LogsGroupByHistogram:
|
|
8286
8328
|
description: 'Used to perform a histogram computation (only for measure facets).
|
|
8287
8329
|
|
|
8288
|
-
Note:
|
|
8330
|
+
Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
|
|
8289
8331
|
properties:
|
|
8290
8332
|
interval:
|
|
8291
8333
|
description: The bin size of the histogram buckets
|
|
@@ -8663,7 +8705,7 @@ components:
|
|
|
8663
8705
|
LogsQueryOptions:
|
|
8664
8706
|
description: 'Global query options that are used during the query.
|
|
8665
8707
|
|
|
8666
|
-
Note:
|
|
8708
|
+
Note: you should supply either timezone or time offset, but not both. Otherwise,
|
|
8667
8709
|
the query will fail.'
|
|
8668
8710
|
properties:
|
|
8669
8711
|
timeOffset:
|
|
@@ -8707,7 +8749,7 @@ components:
|
|
|
8707
8749
|
properties:
|
|
8708
8750
|
after:
|
|
8709
8751
|
description: 'The cursor to use to get the next results, if any. To make
|
|
8710
|
-
the next request, use the same
|
|
8752
|
+
the next request, use the same
|
|
8711
8753
|
|
|
8712
8754
|
parameters with the addition of the `page[cursor]`.'
|
|
8713
8755
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
@@ -9567,7 +9609,6 @@ components:
|
|
|
9567
9609
|
oneOf:
|
|
9568
9610
|
- $ref: '#/components/schemas/MetricDistinctVolume'
|
|
9569
9611
|
- $ref: '#/components/schemas/MetricIngestedIndexedVolume'
|
|
9570
|
-
type: object
|
|
9571
9612
|
MetricVolumesResponse:
|
|
9572
9613
|
description: Response object which includes a single metric's volume.
|
|
9573
9614
|
properties:
|
|
@@ -9606,7 +9647,6 @@ components:
|
|
|
9606
9647
|
oneOf:
|
|
9607
9648
|
- $ref: '#/components/schemas/Metric'
|
|
9608
9649
|
- $ref: '#/components/schemas/MetricTagConfiguration'
|
|
9609
|
-
type: object
|
|
9610
9650
|
MetricsAndMetricTagConfigurationsResponse:
|
|
9611
9651
|
description: Response object that includes metrics and metric tag configurations.
|
|
9612
9652
|
properties:
|
|
@@ -9749,12 +9789,10 @@ components:
|
|
|
9749
9789
|
description: Configuration for the policy.
|
|
9750
9790
|
oneOf:
|
|
9751
9791
|
- $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy'
|
|
9752
|
-
type: object
|
|
9753
9792
|
MonitorConfigPolicyPolicyCreateRequest:
|
|
9754
9793
|
description: Configuration for the policy.
|
|
9755
9794
|
oneOf:
|
|
9756
9795
|
- $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest'
|
|
9757
|
-
type: object
|
|
9758
9796
|
MonitorConfigPolicyResourceType:
|
|
9759
9797
|
default: monitor-config-policy
|
|
9760
9798
|
description: Monitor configuration policy resource type.
|
|
@@ -10112,6 +10150,8 @@ components:
|
|
|
10112
10150
|
properties:
|
|
10113
10151
|
attributes:
|
|
10114
10152
|
$ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
|
|
10153
|
+
type:
|
|
10154
|
+
$ref: '#/components/schemas/OnDemandConcurrencyCapType'
|
|
10115
10155
|
type: object
|
|
10116
10156
|
OnDemandConcurrencyCapAttributes:
|
|
10117
10157
|
description: On-demand concurrency cap attributes.
|
|
@@ -10127,6 +10167,13 @@ components:
|
|
|
10127
10167
|
data:
|
|
10128
10168
|
$ref: '#/components/schemas/OnDemandConcurrencyCap'
|
|
10129
10169
|
type: object
|
|
10170
|
+
OnDemandConcurrencyCapType:
|
|
10171
|
+
description: On-demand concurrency cap type.
|
|
10172
|
+
enum:
|
|
10173
|
+
- on_demand_concurrency_cap
|
|
10174
|
+
type: string
|
|
10175
|
+
x-enum-varnames:
|
|
10176
|
+
- ON_DEMAND_CONCURRENCY_CAP
|
|
10130
10177
|
OpsgenieServiceCreateAttributes:
|
|
10131
10178
|
description: The Opsgenie service attributes for a create request.
|
|
10132
10179
|
properties:
|
|
@@ -10430,9 +10477,7 @@ components:
|
|
|
10430
10477
|
example: Application Key for managing dashboards
|
|
10431
10478
|
type: string
|
|
10432
10479
|
scopes:
|
|
10433
|
-
description: Array of scopes to grant the application key.
|
|
10434
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
10435
|
-
your application keys.
|
|
10480
|
+
description: Array of scopes to grant the application key.
|
|
10436
10481
|
example:
|
|
10437
10482
|
- dashboards_read
|
|
10438
10483
|
- dashboards_write
|
|
@@ -11600,6 +11645,8 @@ components:
|
|
|
11600
11645
|
items:
|
|
11601
11646
|
$ref: '#/components/schemas/RelationshipToTeamLinkData'
|
|
11602
11647
|
type: array
|
|
11648
|
+
links:
|
|
11649
|
+
$ref: '#/components/schemas/TeamRelationshipsLinks'
|
|
11603
11650
|
type: object
|
|
11604
11651
|
RelationshipToUser:
|
|
11605
11652
|
description: Relationship to user.
|
|
@@ -11627,6 +11674,8 @@ components:
|
|
|
11627
11674
|
properties:
|
|
11628
11675
|
data:
|
|
11629
11676
|
$ref: '#/components/schemas/RelationshipToUserTeamPermissionData'
|
|
11677
|
+
links:
|
|
11678
|
+
$ref: '#/components/schemas/TeamRelationshipsLinks'
|
|
11630
11679
|
type: object
|
|
11631
11680
|
RelationshipToUserTeamPermissionData:
|
|
11632
11681
|
description: Related user team permission data
|
|
@@ -12063,7 +12112,6 @@ components:
|
|
|
12063
12112
|
oneOf:
|
|
12064
12113
|
- $ref: '#/components/schemas/GroupScalarColumn'
|
|
12065
12114
|
- $ref: '#/components/schemas/DataScalarColumn'
|
|
12066
|
-
type: object
|
|
12067
12115
|
ScalarFormulaQueryRequest:
|
|
12068
12116
|
description: A wrapper request around one scalar query to be executed.
|
|
12069
12117
|
properties:
|
|
@@ -12172,10 +12220,13 @@ components:
|
|
|
12172
12220
|
type: object
|
|
12173
12221
|
ScalarQuery:
|
|
12174
12222
|
description: An individual scalar query to one of the basic Datadog data sources.
|
|
12223
|
+
example:
|
|
12224
|
+
aggregator: avg
|
|
12225
|
+
data_source: metrics
|
|
12226
|
+
query: avg:system.cpu.user{*} by {env}
|
|
12175
12227
|
oneOf:
|
|
12176
12228
|
- $ref: '#/components/schemas/MetricsScalarQuery'
|
|
12177
12229
|
- $ref: '#/components/schemas/EventsScalarQuery'
|
|
12178
|
-
type: object
|
|
12179
12230
|
ScalarResponse:
|
|
12180
12231
|
description: A message containing the response to a scalar query.
|
|
12181
12232
|
properties:
|
|
@@ -12488,7 +12539,6 @@ components:
|
|
|
12488
12539
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload'
|
|
12489
12540
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload'
|
|
12490
12541
|
- $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload'
|
|
12491
|
-
type: object
|
|
12492
12542
|
SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
|
|
12493
12543
|
description: 'If true, signals in non-production environments have a lower severity
|
|
12494
12544
|
than what is defined by the rule case, which can reduce signal noise.
|
|
@@ -12719,7 +12769,6 @@ components:
|
|
|
12719
12769
|
oneOf:
|
|
12720
12770
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
|
|
12721
12771
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
|
|
12722
|
-
type: object
|
|
12723
12772
|
SecurityMonitoringRuleQueryAggregation:
|
|
12724
12773
|
description: The aggregation type.
|
|
12725
12774
|
enum:
|
|
@@ -12746,7 +12795,6 @@ components:
|
|
|
12746
12795
|
oneOf:
|
|
12747
12796
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse'
|
|
12748
12797
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse'
|
|
12749
|
-
type: object
|
|
12750
12798
|
SecurityMonitoringRuleSeverity:
|
|
12751
12799
|
description: Severity of the Security Signal.
|
|
12752
12800
|
enum:
|
|
@@ -12895,6 +12943,7 @@ components:
|
|
|
12895
12943
|
- data
|
|
12896
12944
|
type: object
|
|
12897
12945
|
SecurityMonitoringSignalAttributes:
|
|
12946
|
+
additionalProperties: {}
|
|
12898
12947
|
description: 'The object containing all signal attributes and their
|
|
12899
12948
|
|
|
12900
12949
|
associated values.'
|
|
@@ -13013,6 +13062,21 @@ components:
|
|
|
13013
13062
|
maximum: 1000
|
|
13014
13063
|
type: integer
|
|
13015
13064
|
type: object
|
|
13065
|
+
SecurityMonitoringSignalMetadataType:
|
|
13066
|
+
default: signal_metadata
|
|
13067
|
+
description: The type of event.
|
|
13068
|
+
enum:
|
|
13069
|
+
- signal_metadata
|
|
13070
|
+
example: signal_metadata
|
|
13071
|
+
type: string
|
|
13072
|
+
x-enum-varnames:
|
|
13073
|
+
- SIGNAL_METADATA
|
|
13074
|
+
SecurityMonitoringSignalResponse:
|
|
13075
|
+
description: Security Signal response data object.
|
|
13076
|
+
properties:
|
|
13077
|
+
data:
|
|
13078
|
+
$ref: '#/components/schemas/SecurityMonitoringSignal'
|
|
13079
|
+
type: object
|
|
13016
13080
|
SecurityMonitoringSignalRuleCreatePayload:
|
|
13017
13081
|
description: Create a new signal correlation rule.
|
|
13018
13082
|
properties:
|
|
@@ -13181,7 +13245,7 @@ components:
|
|
|
13181
13245
|
aggregation:
|
|
13182
13246
|
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
|
|
13183
13247
|
correlatedByFields:
|
|
13184
|
-
description: Fields to
|
|
13248
|
+
description: Fields to correlate by.
|
|
13185
13249
|
items:
|
|
13186
13250
|
description: Field.
|
|
13187
13251
|
type: string
|
|
@@ -13195,6 +13259,18 @@ components:
|
|
|
13195
13259
|
description: Default Rule ID to match on signals.
|
|
13196
13260
|
example: d3f-ru1-e1d
|
|
13197
13261
|
type: string
|
|
13262
|
+
distinctFields:
|
|
13263
|
+
description: Field for which the cardinality is measured. Sent as an array.
|
|
13264
|
+
items:
|
|
13265
|
+
description: Field.
|
|
13266
|
+
type: string
|
|
13267
|
+
type: array
|
|
13268
|
+
groupByFields:
|
|
13269
|
+
description: Fields to group by.
|
|
13270
|
+
items:
|
|
13271
|
+
description: Field.
|
|
13272
|
+
type: string
|
|
13273
|
+
type: array
|
|
13198
13274
|
metrics:
|
|
13199
13275
|
description: Group of target fields to aggregate over.
|
|
13200
13276
|
items:
|
|
@@ -13247,6 +13323,10 @@ components:
|
|
|
13247
13323
|
properties:
|
|
13248
13324
|
attributes:
|
|
13249
13325
|
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
|
|
13326
|
+
id:
|
|
13327
|
+
description: The unique ID of the security signal.
|
|
13328
|
+
type:
|
|
13329
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
|
|
13250
13330
|
required:
|
|
13251
13331
|
- attributes
|
|
13252
13332
|
type: object
|
|
@@ -13297,6 +13377,11 @@ components:
|
|
|
13297
13377
|
properties:
|
|
13298
13378
|
attributes:
|
|
13299
13379
|
$ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
|
|
13380
|
+
id:
|
|
13381
|
+
description: The unique ID of the security signal.
|
|
13382
|
+
type: string
|
|
13383
|
+
type:
|
|
13384
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
|
|
13300
13385
|
type: object
|
|
13301
13386
|
SecurityMonitoringSignalTriageUpdateResponse:
|
|
13302
13387
|
description: The response returned after all triage operations, containing the
|
|
@@ -13472,8 +13557,6 @@ components:
|
|
|
13472
13557
|
description: Query to run on logs.
|
|
13473
13558
|
example: a > 3
|
|
13474
13559
|
type: string
|
|
13475
|
-
required:
|
|
13476
|
-
- query
|
|
13477
13560
|
type: object
|
|
13478
13561
|
SecurityMonitoringStandardRuleResponse:
|
|
13479
13562
|
description: Rule.
|
|
@@ -13554,6 +13637,11 @@ components:
|
|
|
13554
13637
|
handle:
|
|
13555
13638
|
description: The handle for this user account.
|
|
13556
13639
|
type: string
|
|
13640
|
+
icon:
|
|
13641
|
+
description: Gravatar icon associated to the user.
|
|
13642
|
+
example: /path/to/matching/gravatar/icon
|
|
13643
|
+
readOnly: true
|
|
13644
|
+
type: string
|
|
13557
13645
|
id:
|
|
13558
13646
|
description: Numerical ID assigned by Datadog to this user account.
|
|
13559
13647
|
format: int64
|
|
@@ -13643,7 +13731,6 @@ components:
|
|
|
13643
13731
|
oneOf:
|
|
13644
13732
|
- $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem'
|
|
13645
13733
|
- $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem'
|
|
13646
|
-
type: object
|
|
13647
13734
|
SensitiveDataScannerGetConfigResponse:
|
|
13648
13735
|
description: Get all groups response.
|
|
13649
13736
|
properties:
|
|
@@ -13657,6 +13744,10 @@ components:
|
|
|
13657
13744
|
SensitiveDataScannerGetConfigResponseData:
|
|
13658
13745
|
description: Response data related to the scanning groups.
|
|
13659
13746
|
properties:
|
|
13747
|
+
attributes:
|
|
13748
|
+
additionalProperties: {}
|
|
13749
|
+
description: Attributes of the Sensitive Data configuration.
|
|
13750
|
+
type: object
|
|
13660
13751
|
id:
|
|
13661
13752
|
description: ID of the configuration.
|
|
13662
13753
|
type: string
|
|
@@ -13841,6 +13932,9 @@ components:
|
|
|
13841
13932
|
description: Whether or not scanned events are highlighted in Logs or RUM
|
|
13842
13933
|
for the org.
|
|
13843
13934
|
type: boolean
|
|
13935
|
+
has_multi_pass_enabled:
|
|
13936
|
+
description: Whether or not scanned events have multi-pass enabled.
|
|
13937
|
+
type: boolean
|
|
13844
13938
|
is_pci_compliant:
|
|
13845
13939
|
description: Whether or not the org is compliant to the payment card industry
|
|
13846
13940
|
standard.
|
|
@@ -14076,6 +14170,9 @@ components:
|
|
|
14076
14170
|
SensitiveDataScannerStandardPatternAttributes:
|
|
14077
14171
|
description: Attributes of the Sensitive Data Scanner standard pattern.
|
|
14078
14172
|
properties:
|
|
14173
|
+
description:
|
|
14174
|
+
description: Description of the standard pattern.
|
|
14175
|
+
type: string
|
|
14079
14176
|
name:
|
|
14080
14177
|
description: Name of the standard pattern.
|
|
14081
14178
|
type: string
|
|
@@ -14362,6 +14459,7 @@ components:
|
|
|
14362
14459
|
description: "Service owner\u2019s Slack channel."
|
|
14363
14460
|
example: https://yourcompany.slack.com/archives/channel123
|
|
14364
14461
|
type: string
|
|
14462
|
+
type: object
|
|
14365
14463
|
ServiceDefinitionV1Info:
|
|
14366
14464
|
description: Basic information about a service.
|
|
14367
14465
|
properties:
|
|
@@ -15877,6 +15975,17 @@ components:
|
|
|
15877
15975
|
TeamAttributes:
|
|
15878
15976
|
description: Team attributes
|
|
15879
15977
|
properties:
|
|
15978
|
+
avatar:
|
|
15979
|
+
description: Unicode representation of the avatar for the team, limited
|
|
15980
|
+
to a single grapheme
|
|
15981
|
+
example: "\U0001F951"
|
|
15982
|
+
nullable: true
|
|
15983
|
+
type: string
|
|
15984
|
+
banner:
|
|
15985
|
+
description: Banner selection for the team
|
|
15986
|
+
format: int64
|
|
15987
|
+
nullable: true
|
|
15988
|
+
type: integer
|
|
15880
15989
|
created_at:
|
|
15881
15990
|
description: Creation date of the team
|
|
15882
15991
|
format: date-time
|
|
@@ -15890,6 +15999,12 @@ components:
|
|
|
15890
15999
|
example: example-team
|
|
15891
16000
|
maxLength: 195
|
|
15892
16001
|
type: string
|
|
16002
|
+
hidden_modules:
|
|
16003
|
+
description: Collection of hidden modules for the team
|
|
16004
|
+
items:
|
|
16005
|
+
description: String identifier of the module
|
|
16006
|
+
type: string
|
|
16007
|
+
type: array
|
|
15893
16008
|
link_count:
|
|
15894
16009
|
description: The number of links belonging to the team
|
|
15895
16010
|
format: int32
|
|
@@ -15916,6 +16031,12 @@ components:
|
|
|
15916
16031
|
maximum: 2147483647
|
|
15917
16032
|
readOnly: true
|
|
15918
16033
|
type: integer
|
|
16034
|
+
visible_modules:
|
|
16035
|
+
description: Collection of visible modules for the team
|
|
16036
|
+
items:
|
|
16037
|
+
description: String identifier of the module
|
|
16038
|
+
type: string
|
|
16039
|
+
type: array
|
|
15919
16040
|
required:
|
|
15920
16041
|
- handle
|
|
15921
16042
|
- name
|
|
@@ -15936,6 +16057,17 @@ components:
|
|
|
15936
16057
|
TeamCreateAttributes:
|
|
15937
16058
|
description: Team creation attributes
|
|
15938
16059
|
properties:
|
|
16060
|
+
avatar:
|
|
16061
|
+
description: Unicode representation of the avatar for the team, limited
|
|
16062
|
+
to a single grapheme
|
|
16063
|
+
example: "\U0001F951"
|
|
16064
|
+
nullable: true
|
|
16065
|
+
type: string
|
|
16066
|
+
banner:
|
|
16067
|
+
description: Banner selection for the team
|
|
16068
|
+
format: int64
|
|
16069
|
+
nullable: true
|
|
16070
|
+
type: integer
|
|
15939
16071
|
description:
|
|
15940
16072
|
description: Free-form markdown description/content for the team's homepage
|
|
15941
16073
|
type: string
|
|
@@ -15944,11 +16076,23 @@ components:
|
|
|
15944
16076
|
example: example-team
|
|
15945
16077
|
maxLength: 195
|
|
15946
16078
|
type: string
|
|
16079
|
+
hidden_modules:
|
|
16080
|
+
description: Collection of hidden modules for the team
|
|
16081
|
+
items:
|
|
16082
|
+
description: String identifier of the module
|
|
16083
|
+
type: string
|
|
16084
|
+
type: array
|
|
15947
16085
|
name:
|
|
15948
16086
|
description: The name of the team
|
|
15949
16087
|
example: Example Team
|
|
15950
16088
|
maxLength: 200
|
|
15951
16089
|
type: string
|
|
16090
|
+
visible_modules:
|
|
16091
|
+
description: Collection of visible modules for the team
|
|
16092
|
+
items:
|
|
16093
|
+
description: String identifier of the module
|
|
16094
|
+
type: string
|
|
16095
|
+
type: array
|
|
15952
16096
|
required:
|
|
15953
16097
|
- handle
|
|
15954
16098
|
- name
|
|
@@ -15967,30 +16111,12 @@ components:
|
|
|
15967
16111
|
required:
|
|
15968
16112
|
- data
|
|
15969
16113
|
type: object
|
|
15970
|
-
TeamData:
|
|
15971
|
-
description: A team
|
|
15972
|
-
properties:
|
|
15973
|
-
attributes:
|
|
15974
|
-
$ref: '#/components/schemas/TeamAttributes'
|
|
15975
|
-
id:
|
|
15976
|
-
description: The team's identifier
|
|
15977
|
-
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
15978
|
-
type: string
|
|
15979
|
-
type:
|
|
15980
|
-
$ref: '#/components/schemas/TeamType'
|
|
15981
|
-
required:
|
|
15982
|
-
- attributes
|
|
15983
|
-
- id
|
|
15984
|
-
- type
|
|
15985
|
-
type: object
|
|
15986
16114
|
TeamIncluded:
|
|
15987
16115
|
description: Included resources related to the team
|
|
15988
16116
|
oneOf:
|
|
15989
16117
|
- $ref: '#/components/schemas/User'
|
|
15990
16118
|
- $ref: '#/components/schemas/TeamLink'
|
|
15991
16119
|
- $ref: '#/components/schemas/UserTeamPermission'
|
|
15992
|
-
properties: {}
|
|
15993
|
-
type: object
|
|
15994
16120
|
TeamLink:
|
|
15995
16121
|
description: Team link
|
|
15996
16122
|
properties:
|
|
@@ -16196,11 +16322,19 @@ components:
|
|
|
16196
16322
|
user_team_permissions:
|
|
16197
16323
|
$ref: '#/components/schemas/RelationshipToUserTeamPermission'
|
|
16198
16324
|
type: object
|
|
16325
|
+
TeamRelationshipsLinks:
|
|
16326
|
+
description: Links attributes.
|
|
16327
|
+
properties:
|
|
16328
|
+
related:
|
|
16329
|
+
description: Related link.
|
|
16330
|
+
example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
|
|
16331
|
+
type: string
|
|
16332
|
+
type: object
|
|
16199
16333
|
TeamResponse:
|
|
16200
16334
|
description: Response with a team
|
|
16201
16335
|
properties:
|
|
16202
16336
|
data:
|
|
16203
|
-
$ref: '#/components/schemas/
|
|
16337
|
+
$ref: '#/components/schemas/Team'
|
|
16204
16338
|
type: object
|
|
16205
16339
|
TeamType:
|
|
16206
16340
|
default: team
|
|
@@ -16227,6 +16361,17 @@ components:
|
|
|
16227
16361
|
TeamUpdateAttributes:
|
|
16228
16362
|
description: Team update attributes
|
|
16229
16363
|
properties:
|
|
16364
|
+
avatar:
|
|
16365
|
+
description: Unicode representation of the avatar for the team, limited
|
|
16366
|
+
to a single grapheme
|
|
16367
|
+
example: "\U0001F951"
|
|
16368
|
+
nullable: true
|
|
16369
|
+
type: string
|
|
16370
|
+
banner:
|
|
16371
|
+
description: Banner selection for the team
|
|
16372
|
+
format: int64
|
|
16373
|
+
nullable: true
|
|
16374
|
+
type: integer
|
|
16230
16375
|
color:
|
|
16231
16376
|
description: An identifier for the color representing the team
|
|
16232
16377
|
format: int32
|
|
@@ -16241,11 +16386,23 @@ components:
|
|
|
16241
16386
|
example: example-team
|
|
16242
16387
|
maxLength: 195
|
|
16243
16388
|
type: string
|
|
16389
|
+
hidden_modules:
|
|
16390
|
+
description: Collection of hidden modules for the team
|
|
16391
|
+
items:
|
|
16392
|
+
description: String identifier of the module
|
|
16393
|
+
type: string
|
|
16394
|
+
type: array
|
|
16244
16395
|
name:
|
|
16245
16396
|
description: The name of the team
|
|
16246
16397
|
example: Example Team
|
|
16247
16398
|
maxLength: 200
|
|
16248
16399
|
type: string
|
|
16400
|
+
visible_modules:
|
|
16401
|
+
description: Collection of visible modules for the team
|
|
16402
|
+
items:
|
|
16403
|
+
description: String identifier of the module
|
|
16404
|
+
type: string
|
|
16405
|
+
type: array
|
|
16249
16406
|
required:
|
|
16250
16407
|
- handle
|
|
16251
16408
|
- name
|
|
@@ -16277,6 +16434,72 @@ components:
|
|
|
16277
16434
|
items:
|
|
16278
16435
|
$ref: '#/components/schemas/TeamIncluded'
|
|
16279
16436
|
type: array
|
|
16437
|
+
links:
|
|
16438
|
+
$ref: '#/components/schemas/TeamsResponseLinks'
|
|
16439
|
+
meta:
|
|
16440
|
+
$ref: '#/components/schemas/TeamsResponseMeta'
|
|
16441
|
+
type: object
|
|
16442
|
+
TeamsResponseLinks:
|
|
16443
|
+
description: Teams response links.
|
|
16444
|
+
properties:
|
|
16445
|
+
first:
|
|
16446
|
+
description: First link.
|
|
16447
|
+
type: string
|
|
16448
|
+
last:
|
|
16449
|
+
description: Last link.
|
|
16450
|
+
nullable: true
|
|
16451
|
+
type: string
|
|
16452
|
+
next:
|
|
16453
|
+
description: Next link.
|
|
16454
|
+
type: string
|
|
16455
|
+
prev:
|
|
16456
|
+
description: Previous link.
|
|
16457
|
+
nullable: true
|
|
16458
|
+
type: string
|
|
16459
|
+
self:
|
|
16460
|
+
description: Current link.
|
|
16461
|
+
type: string
|
|
16462
|
+
type: object
|
|
16463
|
+
TeamsResponseMeta:
|
|
16464
|
+
description: Teams response metadata.
|
|
16465
|
+
properties:
|
|
16466
|
+
pagination:
|
|
16467
|
+
$ref: '#/components/schemas/TeamsResponseMetaPagination'
|
|
16468
|
+
type: object
|
|
16469
|
+
TeamsResponseMetaPagination:
|
|
16470
|
+
description: Teams response metadata.
|
|
16471
|
+
properties:
|
|
16472
|
+
first_offset:
|
|
16473
|
+
description: The first offset.
|
|
16474
|
+
format: int64
|
|
16475
|
+
type: integer
|
|
16476
|
+
last_offset:
|
|
16477
|
+
description: The last offset.
|
|
16478
|
+
format: int64
|
|
16479
|
+
type: integer
|
|
16480
|
+
limit:
|
|
16481
|
+
description: Pagination limit.
|
|
16482
|
+
format: int64
|
|
16483
|
+
type: integer
|
|
16484
|
+
next_offset:
|
|
16485
|
+
description: The next offset.
|
|
16486
|
+
format: int64
|
|
16487
|
+
type: integer
|
|
16488
|
+
offset:
|
|
16489
|
+
description: The offset.
|
|
16490
|
+
format: int64
|
|
16491
|
+
type: integer
|
|
16492
|
+
prev_offset:
|
|
16493
|
+
description: The previous offset.
|
|
16494
|
+
format: int64
|
|
16495
|
+
type: integer
|
|
16496
|
+
total:
|
|
16497
|
+
description: Total results.
|
|
16498
|
+
format: int64
|
|
16499
|
+
type: integer
|
|
16500
|
+
type:
|
|
16501
|
+
description: Offset type.
|
|
16502
|
+
type: string
|
|
16280
16503
|
type: object
|
|
16281
16504
|
TimeseriesFormulaQueryRequest:
|
|
16282
16505
|
description: A request wrapper around a single timeseries query to be executed.
|
|
@@ -16371,10 +16594,12 @@ components:
|
|
|
16371
16594
|
TimeseriesQuery:
|
|
16372
16595
|
description: An individual timeseries query to one of the basic Datadog data
|
|
16373
16596
|
sources.
|
|
16597
|
+
example:
|
|
16598
|
+
data_source: metrics
|
|
16599
|
+
query: avg:system.cpu.user{*} by {env}
|
|
16374
16600
|
oneOf:
|
|
16375
16601
|
- $ref: '#/components/schemas/MetricsTimeseriesQuery'
|
|
16376
16602
|
- $ref: '#/components/schemas/EventsTimeseriesQuery'
|
|
16377
|
-
type: object
|
|
16378
16603
|
TimeseriesResponse:
|
|
16379
16604
|
description: A message containing the response to a timeseries query.
|
|
16380
16605
|
properties:
|
|
@@ -16451,11 +16676,6 @@ components:
|
|
|
16451
16676
|
items:
|
|
16452
16677
|
$ref: '#/components/schemas/TimeseriesResponseValues'
|
|
16453
16678
|
type: array
|
|
16454
|
-
TimestampEventAttribute:
|
|
16455
|
-
description: Timestamp of your event.
|
|
16456
|
-
example: '2019-01-02T09:42:36.320Z'
|
|
16457
|
-
format: date-time
|
|
16458
|
-
type: string
|
|
16459
16679
|
Unit:
|
|
16460
16680
|
description: Object containing the metric unit family, scale factor, name, and
|
|
16461
16681
|
short name.
|
|
@@ -16505,6 +16725,10 @@ components:
|
|
|
16505
16725
|
public_id:
|
|
16506
16726
|
description: The organization public ID.
|
|
16507
16727
|
type: string
|
|
16728
|
+
region:
|
|
16729
|
+
description: The region of the Datadog instance that the organization belongs
|
|
16730
|
+
to.
|
|
16731
|
+
type: string
|
|
16508
16732
|
timeseries:
|
|
16509
16733
|
description: List of usage data reported for each requested hour.
|
|
16510
16734
|
items:
|
|
@@ -16765,7 +16989,6 @@ components:
|
|
|
16765
16989
|
- $ref: '#/components/schemas/Organization'
|
|
16766
16990
|
- $ref: '#/components/schemas/Permission'
|
|
16767
16991
|
- $ref: '#/components/schemas/Role'
|
|
16768
|
-
type: object
|
|
16769
16992
|
UserResponseRelationships:
|
|
16770
16993
|
description: Relationships of the user object returned by the API.
|
|
16771
16994
|
properties:
|
|
@@ -16918,6 +17141,10 @@ components:
|
|
|
16918
17141
|
items:
|
|
16919
17142
|
$ref: '#/components/schemas/UserTeam'
|
|
16920
17143
|
type: array
|
|
17144
|
+
links:
|
|
17145
|
+
$ref: '#/components/schemas/TeamsResponseLinks'
|
|
17146
|
+
meta:
|
|
17147
|
+
$ref: '#/components/schemas/TeamsResponseMeta'
|
|
16921
17148
|
type: object
|
|
16922
17149
|
UserUpdateAttributes:
|
|
16923
17150
|
description: Attributes of the edited user.
|
|
@@ -16995,33 +17222,29 @@ components:
|
|
|
16995
17222
|
dashboards_read: View dashboards.
|
|
16996
17223
|
dashboards_write: Create and change dashboards.
|
|
16997
17224
|
events_read: Read Events data.
|
|
17225
|
+
incident_notification_settings_write: Configure Incidents Notification
|
|
17226
|
+
settings.
|
|
16998
17227
|
incident_read: View incidents in Datadog.
|
|
16999
|
-
incident_settings_write: Configure
|
|
17228
|
+
incident_settings_write: Configure Incident Settings.
|
|
17000
17229
|
incident_write: Create, view, and manage incidents in Datadog.
|
|
17001
|
-
metric_tags_write: Create and edit tag configurations for custom metrics.
|
|
17002
17230
|
metrics_read: View custom metrics.
|
|
17003
17231
|
monitors_downtime: Set downtimes to suppress alerts from any monitor in
|
|
17004
|
-
an organization. The ability to write monitors
|
|
17005
|
-
downtimes.
|
|
17232
|
+
an organization. Mute and unmute hosts. The ability to write monitors
|
|
17233
|
+
is not required to set downtimes.
|
|
17006
17234
|
monitors_read: View monitors.
|
|
17007
|
-
org_management: Edit organization configurations, including authentication
|
|
17008
|
-
and certain security preferences.
|
|
17009
17235
|
security_monitoring_filters_read: Read Security Filters.
|
|
17010
17236
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
17011
17237
|
security_monitoring_findings_read: View CSPM Findings.
|
|
17012
|
-
security_monitoring_findings_write: Mute CSPM Findings.
|
|
17013
17238
|
security_monitoring_rules_read: Read Detection Rules.
|
|
17014
17239
|
security_monitoring_rules_write: Create and edit Detection Rules.
|
|
17015
17240
|
security_monitoring_signals_read: View Security Signals.
|
|
17016
|
-
|
|
17017
|
-
|
|
17018
|
-
|
|
17019
|
-
Synthetic Monitoring.
|
|
17020
|
-
teams_manage: Manage Teams. Create, delete, rename, and edit the metadata
|
|
17241
|
+
synthetics_read: List and view configured Synthetic tests and test results.
|
|
17242
|
+
synthetics_write: Create, edit, and delete Synthetic tests.
|
|
17243
|
+
teams_manage: Manage Teams. Create, delete, rename, and edit metadata
|
|
17021
17244
|
of all Teams. To control Team membership across all Teams, use the User
|
|
17022
17245
|
Access Manage permission.
|
|
17023
|
-
teams_read: Read Teams data.
|
|
17024
|
-
are on each Team.
|
|
17246
|
+
teams_read: Read Teams data. A User with this permission can view Team
|
|
17247
|
+
names, metadata, and which Users are on each Team.
|
|
17025
17248
|
timeseries_query: Query Timeseries data.
|
|
17026
17249
|
usage_read: View your organization's usage and usage attribution.
|
|
17027
17250
|
user_access_invite: Invite other users to your organization.
|
|
@@ -17237,10 +17460,6 @@ paths:
|
|
|
17237
17460
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
17238
17461
|
'429':
|
|
17239
17462
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17240
|
-
security:
|
|
17241
|
-
- apiKeyAuth: []
|
|
17242
|
-
appKeyAuth: []
|
|
17243
|
-
- AuthZ: []
|
|
17244
17463
|
summary: Get all span-based metrics
|
|
17245
17464
|
tags:
|
|
17246
17465
|
- Spans Metrics
|
|
@@ -17312,10 +17531,6 @@ paths:
|
|
|
17312
17531
|
$ref: '#/components/responses/NotFoundResponse'
|
|
17313
17532
|
'429':
|
|
17314
17533
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17315
|
-
security:
|
|
17316
|
-
- apiKeyAuth: []
|
|
17317
|
-
appKeyAuth: []
|
|
17318
|
-
- AuthZ: []
|
|
17319
17534
|
summary: Get a span-based metric
|
|
17320
17535
|
tags:
|
|
17321
17536
|
- Spans Metrics
|
|
@@ -17839,14 +18054,11 @@ paths:
|
|
|
17839
18054
|
post:
|
|
17840
18055
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
|
17841
18056
|
details about how pipeline executions are modeled and what execution types
|
|
17842
|
-
we support, see
|
|
18057
|
+
we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).
|
|
17843
18058
|
|
|
17844
18059
|
|
|
17845
18060
|
Pipeline events can be submitted with a timestamp that is up to 18 hours in
|
|
17846
|
-
the past.
|
|
17847
|
-
|
|
17848
|
-
|
|
17849
|
-
This API endpoint is in private beta.'
|
|
18061
|
+
the past.'
|
|
17850
18062
|
operationId: CreateCIAppPipelineEvent
|
|
17851
18063
|
requestBody:
|
|
17852
18064
|
content:
|
|
@@ -17913,10 +18125,12 @@ paths:
|
|
|
17913
18125
|
tags:
|
|
17914
18126
|
- CI Visibility Pipelines
|
|
17915
18127
|
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).'
|
|
17916
18130
|
/api/v2/ci/pipelines/analytics/aggregate:
|
|
17917
18131
|
post:
|
|
17918
|
-
description:
|
|
17919
|
-
buckets of computed metrics and timeseries.
|
|
18132
|
+
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
|
18133
|
+
into buckets of computed metrics and timeseries.
|
|
17920
18134
|
operationId: AggregateCIAppPipelineEvents
|
|
17921
18135
|
requestBody:
|
|
17922
18136
|
content:
|
|
@@ -17944,7 +18158,7 @@ paths:
|
|
|
17944
18158
|
/api/v2/ci/pipelines/events:
|
|
17945
18159
|
get:
|
|
17946
18160
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
17947
|
-
a [
|
|
18161
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
17948
18162
|
|
|
17949
18163
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
17950
18164
|
|
|
@@ -18023,7 +18237,7 @@ paths:
|
|
|
18023
18237
|
/api/v2/ci/pipelines/events/search:
|
|
18024
18238
|
post:
|
|
18025
18239
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
18026
|
-
a [
|
|
18240
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
18027
18241
|
|
|
18028
18242
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
18029
18243
|
|
|
@@ -18603,7 +18817,7 @@ paths:
|
|
|
18603
18817
|
- apiKeyAuth: []
|
|
18604
18818
|
appKeyAuth: []
|
|
18605
18819
|
- AuthZ:
|
|
18606
|
-
-
|
|
18820
|
+
- monitors_downtime
|
|
18607
18821
|
summary: Get all downtimes
|
|
18608
18822
|
tags:
|
|
18609
18823
|
- Downtimes
|
|
@@ -20549,11 +20763,6 @@ paths:
|
|
|
20549
20763
|
$ref: '#/components/responses/NotFoundResponse'
|
|
20550
20764
|
'429':
|
|
20551
20765
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20552
|
-
security:
|
|
20553
|
-
- apiKeyAuth: []
|
|
20554
|
-
appKeyAuth: []
|
|
20555
|
-
- AuthZ:
|
|
20556
|
-
- org_management
|
|
20557
20766
|
summary: Get IP Allowlist
|
|
20558
20767
|
tags:
|
|
20559
20768
|
- IP Allowlist
|
|
@@ -20581,11 +20790,6 @@ paths:
|
|
|
20581
20790
|
$ref: '#/components/responses/NotFoundResponse'
|
|
20582
20791
|
'429':
|
|
20583
20792
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20584
|
-
security:
|
|
20585
|
-
- apiKeyAuth: []
|
|
20586
|
-
appKeyAuth: []
|
|
20587
|
-
- AuthZ:
|
|
20588
|
-
- org_management
|
|
20589
20793
|
summary: Update IP Allowlist
|
|
20590
20794
|
tags:
|
|
20591
20795
|
- IP Allowlist
|
|
@@ -21573,7 +21777,7 @@ paths:
|
|
|
21573
21777
|
- description: 'The number of seconds of look back (from now) to apply to a
|
|
21574
21778
|
filter[tag] or filter[queried] query.
|
|
21575
21779
|
|
|
21576
|
-
|
|
21780
|
+
Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).'
|
|
21577
21781
|
example: 3600
|
|
21578
21782
|
in: query
|
|
21579
21783
|
name: window[seconds]
|
|
@@ -21824,7 +22028,8 @@ paths:
|
|
|
21824
22028
|
security:
|
|
21825
22029
|
- apiKeyAuth: []
|
|
21826
22030
|
appKeyAuth: []
|
|
21827
|
-
- AuthZ:
|
|
22031
|
+
- AuthZ:
|
|
22032
|
+
- metrics_read
|
|
21828
22033
|
summary: List tags by metric name
|
|
21829
22034
|
tags:
|
|
21830
22035
|
- Metrics
|
|
@@ -22377,7 +22582,7 @@ paths:
|
|
|
22377
22582
|
- apiKeyAuth: []
|
|
22378
22583
|
appKeyAuth: []
|
|
22379
22584
|
- AuthZ:
|
|
22380
|
-
-
|
|
22585
|
+
- monitors_downtime
|
|
22381
22586
|
summary: Get active downtimes for a monitor
|
|
22382
22587
|
tags:
|
|
22383
22588
|
- Downtimes
|
|
@@ -22414,7 +22619,8 @@ paths:
|
|
|
22414
22619
|
security:
|
|
22415
22620
|
- apiKeyAuth: []
|
|
22416
22621
|
appKeyAuth: []
|
|
22417
|
-
- AuthZ:
|
|
22622
|
+
- AuthZ:
|
|
22623
|
+
- user_access_read
|
|
22418
22624
|
summary: List permissions
|
|
22419
22625
|
tags:
|
|
22420
22626
|
- Roles
|
|
@@ -22669,8 +22875,6 @@ paths:
|
|
|
22669
22875
|
security:
|
|
22670
22876
|
- apiKeyAuth: []
|
|
22671
22877
|
appKeyAuth: []
|
|
22672
|
-
- AuthZ:
|
|
22673
|
-
- security_monitoring_findings_write
|
|
22674
22878
|
summary: Mute or unmute a finding
|
|
22675
22879
|
tags:
|
|
22676
22880
|
- Security Monitoring
|
|
@@ -22851,8 +23055,6 @@ paths:
|
|
|
22851
23055
|
appKeyAuth: []
|
|
22852
23056
|
- AuthZ:
|
|
22853
23057
|
- timeseries_query
|
|
22854
|
-
- metrics_read
|
|
22855
|
-
- metric_tags_write
|
|
22856
23058
|
summary: Query timeseries data across multiple products
|
|
22857
23059
|
tags:
|
|
22858
23060
|
- Metrics
|
|
@@ -23016,7 +23218,8 @@ paths:
|
|
|
23016
23218
|
security:
|
|
23017
23219
|
- apiKeyAuth: []
|
|
23018
23220
|
appKeyAuth: []
|
|
23019
|
-
- AuthZ:
|
|
23221
|
+
- AuthZ:
|
|
23222
|
+
- user_access_read
|
|
23020
23223
|
summary: List roles
|
|
23021
23224
|
tags:
|
|
23022
23225
|
- Roles
|
|
@@ -23120,7 +23323,8 @@ paths:
|
|
|
23120
23323
|
security:
|
|
23121
23324
|
- apiKeyAuth: []
|
|
23122
23325
|
appKeyAuth: []
|
|
23123
|
-
- AuthZ:
|
|
23326
|
+
- AuthZ:
|
|
23327
|
+
- user_access_read
|
|
23124
23328
|
summary: Get a role
|
|
23125
23329
|
tags:
|
|
23126
23330
|
- Roles
|
|
@@ -23311,7 +23515,8 @@ paths:
|
|
|
23311
23515
|
security:
|
|
23312
23516
|
- apiKeyAuth: []
|
|
23313
23517
|
appKeyAuth: []
|
|
23314
|
-
- AuthZ:
|
|
23518
|
+
- AuthZ:
|
|
23519
|
+
- user_access_read
|
|
23315
23520
|
summary: List permissions for a role
|
|
23316
23521
|
tags:
|
|
23317
23522
|
- Roles
|
|
@@ -23460,7 +23665,8 @@ paths:
|
|
|
23460
23665
|
security:
|
|
23461
23666
|
- apiKeyAuth: []
|
|
23462
23667
|
appKeyAuth: []
|
|
23463
|
-
- AuthZ:
|
|
23668
|
+
- AuthZ:
|
|
23669
|
+
- user_access_read
|
|
23464
23670
|
summary: Get all users of a role
|
|
23465
23671
|
tags:
|
|
23466
23672
|
- Roles
|
|
@@ -24416,7 +24622,7 @@ paths:
|
|
|
24416
24622
|
content:
|
|
24417
24623
|
application/json:
|
|
24418
24624
|
schema:
|
|
24419
|
-
$ref: '#/components/schemas/
|
|
24625
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalResponse'
|
|
24420
24626
|
description: OK
|
|
24421
24627
|
'404':
|
|
24422
24628
|
$ref: '#/components/responses/NotFoundResponse'
|
|
@@ -27460,6 +27666,40 @@ paths:
|
|
|
27460
27666
|
tags:
|
|
27461
27667
|
- Users
|
|
27462
27668
|
x-codegen-request-body-name: body
|
|
27669
|
+
/api/v2/users/{user_uuid}/memberships:
|
|
27670
|
+
get:
|
|
27671
|
+
description: Get a list of memberships for a user
|
|
27672
|
+
operationId: GetUserMemberships
|
|
27673
|
+
parameters:
|
|
27674
|
+
- description: None
|
|
27675
|
+
in: path
|
|
27676
|
+
name: user_uuid
|
|
27677
|
+
required: true
|
|
27678
|
+
schema:
|
|
27679
|
+
type: string
|
|
27680
|
+
responses:
|
|
27681
|
+
'200':
|
|
27682
|
+
content:
|
|
27683
|
+
application/json:
|
|
27684
|
+
schema:
|
|
27685
|
+
$ref: '#/components/schemas/UserTeamsResponse'
|
|
27686
|
+
description: Represents a user's association to a team
|
|
27687
|
+
'404':
|
|
27688
|
+
content:
|
|
27689
|
+
application/json:
|
|
27690
|
+
schema:
|
|
27691
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
27692
|
+
description: API error response.
|
|
27693
|
+
'429':
|
|
27694
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
27695
|
+
security:
|
|
27696
|
+
- apiKeyAuth: []
|
|
27697
|
+
appKeyAuth: []
|
|
27698
|
+
- AuthZ:
|
|
27699
|
+
- teams_read
|
|
27700
|
+
summary: Get user memberships
|
|
27701
|
+
tags:
|
|
27702
|
+
- Teams
|
|
27463
27703
|
security:
|
|
27464
27704
|
- apiKeyAuth: []
|
|
27465
27705
|
appKeyAuth: []
|