.generator/schemas/v2/openapi.yaml in datadog_api_client-2.13.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.14.0

- old
+ new

@@ -620,11 +620,10 @@ type: object APIKeyResponseIncludedItem: description: An object related to an API key. oneOf: - $ref: '#/components/schemas/User' - type: object APIKeyUpdateAttributes: description: Attributes used to update an API Key. properties: name: description: Name of the API key. @@ -708,13 +707,11 @@ name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: - description: Array of scopes to grant the application key. This feature - is in private beta, please contact Datadog support to enable scopes for - your application keys. + description: Array of scopes to grant the application key. example: - dashboards_read - dashboards_write - dashboards_public_share items: @@ -764,22 +761,19 @@ ApplicationKeyResponseIncludedItem: description: An object related to an application key. oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/Role' - type: object ApplicationKeyUpdateAttributes: description: Attributes used to update an application Key. properties: name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: - description: Array of scopes to grant the application key. This feature - is in private beta, please contact Datadog support to enable scopes for - your application keys. + description: Array of scopes to grant the application key. example: - dashboards_read - dashboards_write - dashboards_public_share items: @@ -861,10 +855,13 @@ description: JSON object of attributes from Audit Logs events. example: customAttribute: 123 duration: 2345 type: object + message: + description: Message of the event. + type: string service: description: 'Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same @@ -1144,12 +1141,10 @@ AuthNMappingIncluded: description: Included data in the AuthN Mapping response. oneOf: - $ref: '#/components/schemas/SAMLAssertionAttribute' - $ref: '#/components/schemas/Role' - properties: {} - type: object AuthNMappingRelationships: description: All relationships associated with AuthN Mapping. properties: role: $ref: '#/components/schemas/RelationshipToRole' @@ -1483,29 +1478,19 @@ description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} - description: JSON object of attributes from CI Visibility events. + description: JSON object of attributes from CI Visibility test events. example: customAttribute: 123 duration: 2345 type: object - service: - description: 'The name of the application or service generating CI Visibility - events. - - It is used to switch from CI Visibility to APM, so make sure you define - the same - - value when you use both products.' - example: web-ui-tests - type: string tags: $ref: '#/components/schemas/TagsEventAttribute' - timestamp: - $ref: '#/components/schemas/TimestampEventAttribute' + test_level: + $ref: '#/components/schemas/CIAppTestLevel' type: object CIAppGitInfo: description: 'If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. @@ -1663,18 +1648,34 @@ CIAppPipelineEvent: description: Object description of a pipeline event after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/CIAppEventAttributes' + $ref: '#/components/schemas/CIAppPipelineEventAttributes' id: description: Unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/CIAppPipelineEventTypeName' type: object + CIAppPipelineEventAttributes: + description: JSON object containing all event attributes and their associated + values. + properties: + attributes: + additionalProperties: {} + description: JSON object of attributes from CI Visibility pipeline events. + example: + customAttribute: 123 + duration: 2345 + type: object + ci_level: + $ref: '#/components/schemas/CIAppPipelineLevel' + tags: + $ref: '#/components/schemas/TagsEventAttribute' + type: object CIAppPipelineEventJob: description: Details of a CI job. properties: dependencies: description: A list of job IDs that this job depends on. @@ -2192,10 +2193,26 @@ links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object + CIAppPipelineLevel: + description: Pipeline execution level. + enum: + - pipeline + - stage + - job + - step + - custom + example: pipeline + type: string + x-enum-varnames: + - PIPELINE + - STAGE + - JOB + - STEP + - CUSTOM CIAppPipelinesAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of pipeline events from your organization. properties: compute: @@ -2279,11 +2296,12 @@ and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' - description: The search query following the Log search syntax. + description: The search query following the CI Visibility Explorer search + syntax. example: '@ci.provider.name:github AND @ci.status:error' type: string to: default: now description: The maximum time for the requested events, supports date, math, @@ -2465,10 +2483,24 @@ links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object + CIAppTestLevel: + description: Test run level. + enum: + - session + - module + - suite + - test + example: test + type: string + x-enum-varnames: + - SESSION + - MODULE + - SUITE + - TEST CIAppTestsAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of test events from your organization. properties: compute: @@ -2502,11 +2534,11 @@ data: $ref: '#/components/schemas/CIAppTestsAggregationBucketsResponse' links: $ref: '#/components/schemas/CIAppResponseLinks' meta: - $ref: '#/components/schemas/CIAppResponseMetadata' + $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object CIAppTestsBucketResponse: description: Bucket values. properties: by: @@ -2552,11 +2584,12 @@ and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' - description: The search query following the Log search syntax. + description: The search query following the CI Visibility Explorer search + syntax. example: '@test.service:web-ui-tests AND @test.status:fail' type: string to: default: now description: The maximum time for the requested events, supports date, math, @@ -2598,10 +2631,11 @@ description: The product for which cost is being reported. example: infra_host type: string type: object CloudConfigurationComplianceRuleOptions: + additionalProperties: {} description: 'Options for cloud_configuration rules. Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration` rules. @@ -2669,10 +2703,20 @@ type: object CloudConfigurationRuleComplianceSignalOptions: description: How to generate compliance signals. Useful for cloud_configuration rules only. properties: + defaultActivationStatus: + description: The default activation status. + nullable: true + type: boolean + defaultGroupByFields: + description: The default group by fields. + items: + type: string + nullable: true + type: array userActivationStatus: description: Whether signals will be sent. nullable: true type: boolean userGroupByFields: @@ -3555,10 +3599,19 @@ description: Popularity of the dashboard. format: int32 maximum: 5 readOnly: true type: integer + tags: + description: List of team names representing ownership of a dashboard. + items: + description: The name of a Datadog team, formatted as `team:<name>` + type: string + maxItems: 5 + nullable: true + readOnly: true + type: array title: description: Title of the dashboard. readOnly: true type: string type: @@ -3818,11 +3871,10 @@ DowntimeMonitorIdentifier: description: Monitor identifier for the downtime. oneOf: - $ref: '#/components/schemas/DowntimeMonitorIdentifierId' - $ref: '#/components/schemas/DowntimeMonitorIdentifierTags' - type: object DowntimeMonitorIdentifierId: additionalProperties: {} description: Object of the monitor identifier. properties: monitor_id: @@ -4053,17 +4105,15 @@ DowntimeResponseIncludedItem: description: An object related to a downtime. oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/DowntimeMonitorIncludedItem' - type: object DowntimeScheduleCreateRequest: description: Schedule for the downtime. oneOf: - $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest' - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest' - type: object DowntimeScheduleCurrentDowntimeResponse: description: 'The most recent actual start and end dates for a recurring downtime. For a canceled downtime, this is the previously occurring downtime. For active downtimes, this is the @@ -4118,10 +4168,12 @@ start: description: ISO-8601 Datetime to start the downtime. example: 2020-01-02 03:04:00+00:00 format: date-time type: string + required: + - start type: object DowntimeScheduleRecurrenceCreateUpdateRequest: additionalProperties: {} description: An object defining the recurrence of the downtime. properties: @@ -4239,17 +4291,15 @@ provided, the downtime will begin immediately and never end.' oneOf: - $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse' - $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse' - type: object DowntimeScheduleUpdateRequest: description: Schedule for the downtime. oneOf: - $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest' - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest' - type: object DowntimeScope: description: The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/). example: env:(staging OR prod) AND datacenter:us-east-1 type: string @@ -5181,12 +5231,14 @@ example: finding type: string x-enum-varnames: - FINDING FormulaLimit: - description: Message for specifying limits to the number of values returned + description: 'Message for specifying limits to the number of values returned by a query. + + This limit is only for scalar queries and has no effect on timeseries queries.' properties: count: description: The number of results to which to limit. example: 10 format: int32 @@ -5272,13 +5324,11 @@ name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: - description: Array of scopes to grant the application key. This feature - is in private beta, please contact Datadog support to enable scopes for - your application keys. + description: Array of scopes to grant the application key. example: - dashboards_read - dashboards_write - dashboards_public_share items: @@ -5797,11 +5847,10 @@ IncidentAttachmentAttributes: description: The attributes object for an attachment. oneOf: - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes' - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes' - type: object IncidentAttachmentData: description: A single incident attachment. example: attributes: attachment: @@ -5912,11 +5961,10 @@ IncidentAttachmentUpdateAttributes: description: Incident attachment attributes. oneOf: - $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes' - $ref: '#/components/schemas/IncidentAttachmentLinkAttributes' - type: object IncidentAttachmentUpdateData: description: A single incident attachment. properties: attributes: $ref: '#/components/schemas/IncidentAttachmentUpdateAttributes' @@ -6018,11 +6066,10 @@ type: object IncidentAttachmentsResponseIncludedItem: description: An object related to an attachment that is included in the response. oneOf: - $ref: '#/components/schemas/User' - type: object IncidentCreateAttributes: description: The incident's attributes for a create request. properties: customer_impact_scope: description: Required if `customer_impacted:"true"`. A summary of the impact @@ -6099,11 +6146,10 @@ oneOf: - $ref: '#/components/schemas/IncidentFieldAttributesSingleValue' - $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue' required: - type - type: object IncidentFieldAttributesMultipleValue: description: A field with potentially multiple values selected. properties: type: $ref: '#/components/schemas/IncidentFieldAttributesValueType' @@ -6230,11 +6276,10 @@ IncidentIntegrationMetadataMetadata: description: Incident integration metadata's metadata attribute. oneOf: - $ref: '#/components/schemas/SlackIntegrationMetadata' - $ref: '#/components/schemas/JiraIntegrationMetadata' - type: object IncidentIntegrationMetadataPatchData: description: Incident integration metadata data for a patch request. properties: attributes: $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes' @@ -6284,11 +6329,10 @@ IncidentIntegrationMetadataResponseIncludedItem: description: An object related to an incident integration metadata that is included in the response. oneOf: - $ref: '#/components/schemas/User' - type: object IncidentIntegrationMetadataType: default: incident_integrations description: Integration metadata resource type. enum: - incident_integrations @@ -6464,11 +6508,10 @@ IncidentResponseIncludedItem: description: An object related to an incident that is included in the response. oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/IncidentAttachmentData' - type: object IncidentResponseMeta: description: The metadata object containing pagination metadata. properties: pagination: $ref: '#/components/schemas/IncidentResponseMetaPagination' @@ -6764,11 +6807,10 @@ IncidentServiceIncludedItems: description: An object related to an incident service which is present in the included payload. oneOf: - $ref: '#/components/schemas/User' - type: object IncidentServiceRelationships: description: The incident service's relationships. properties: created_by: $ref: '#/components/schemas/RelationshipToUser' @@ -6923,11 +6965,10 @@ IncidentTeamIncludedItems: description: An object related to an incident team which is present in the included payload. oneOf: - $ref: '#/components/schemas/User' - type: object IncidentTeamRelationships: description: The incident team's relationships. properties: created_by: $ref: '#/components/schemas/RelationshipToUser' @@ -7050,11 +7091,10 @@ type: object IncidentTimelineCellCreateAttributes: description: The timeline cell's attributes for a create request. oneOf: - $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes' - type: object IncidentTimelineCellMarkdownContentType: default: markdown description: Type of the Markdown timeline cell. enum: - markdown @@ -7252,11 +7292,10 @@ type: object IncidentTodoResponseIncludedItem: description: An object related to an incident todo that is included in the response. oneOf: - $ref: '#/components/schemas/User' - type: object IncidentTodoType: default: incident_todos description: Todo resource type. enum: - incident_todos @@ -7783,11 +7822,12 @@ type: object LogsAggregateRequestPage: description: Paging settings properties: cursor: - description: The returned paging point to use to get the next results + description: 'The returned paging point to use to get the next results. + Note: at most 1000 results can be paged.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object LogsAggregateResponse: description: The response object for the logs aggregate API endpoint @@ -7991,11 +8031,10 @@ - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - $ref: '#/components/schemas/LogsArchiveDestinationS3' required: - type - integration - type: object LogsArchiveDefinition: description: The definition of an archive. properties: attributes: $ref: '#/components/schemas/LogsArchiveAttributes' @@ -8021,11 +8060,10 @@ - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - $ref: '#/components/schemas/LogsArchiveDestinationS3' required: - type - integration - type: object LogsArchiveDestinationAzure: description: The Azure archive destination. properties: container: description: The container where the archive will be stored. @@ -8268,11 +8306,15 @@ type: string histogram: $ref: '#/components/schemas/LogsGroupByHistogram' limit: default: 10 - description: The maximum buckets to return for this group by + description: 'The maximum buckets to return for this group by. Note: at + most 10000 buckets are allowed. + + If grouping by multiple facets, the product of limits must not exceed + 10000.' format: int64 type: integer missing: $ref: '#/components/schemas/LogsGroupByMissing' sort: @@ -8283,11 +8325,11 @@ - facet type: object LogsGroupByHistogram: description: 'Used to perform a histogram computation (only for measure facets). - Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.' + Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.' properties: interval: description: The bin size of the histogram buckets example: 10 format: double @@ -8661,11 +8703,11 @@ type: string type: object LogsQueryOptions: description: 'Global query options that are used during the query. - Note: You should only supply timezone or time offset but not both otherwise + Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.' properties: timeOffset: description: The time offset (in seconds) to apply to the query. format: int64 @@ -8705,11 +8747,11 @@ LogsResponseMetadataPage: description: Paging attributes. properties: after: description: 'The cursor to use to get the next results, if any. To make - the next request, use the same. + the next request, use the same parameters with the addition of the `page[cursor]`.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object @@ -9565,11 +9607,10 @@ MetricVolumes: description: Possible response objects for a metric's volume. oneOf: - $ref: '#/components/schemas/MetricDistinctVolume' - $ref: '#/components/schemas/MetricIngestedIndexedVolume' - type: object MetricVolumesResponse: description: Response object which includes a single metric's volume. properties: data: $ref: '#/components/schemas/MetricVolumes' @@ -9604,11 +9645,10 @@ MetricsAndMetricTagConfigurations: description: Object for a metrics and metric tag configurations. oneOf: - $ref: '#/components/schemas/Metric' - $ref: '#/components/schemas/MetricTagConfiguration' - type: object MetricsAndMetricTagConfigurationsResponse: description: Response object that includes metrics and metric tag configurations. properties: data: description: Array of metrics and metric tag configurations. @@ -9747,16 +9787,14 @@ type: object MonitorConfigPolicyPolicy: description: Configuration for the policy. oneOf: - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy' - type: object MonitorConfigPolicyPolicyCreateRequest: description: Configuration for the policy. oneOf: - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest' - type: object MonitorConfigPolicyResourceType: default: monitor-config-policy description: Monitor configuration policy resource type. enum: - monitor-config-policy @@ -10110,10 +10148,12 @@ OnDemandConcurrencyCap: description: On-demand concurrency cap. properties: attributes: $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes' + type: + $ref: '#/components/schemas/OnDemandConcurrencyCapType' type: object OnDemandConcurrencyCapAttributes: description: On-demand concurrency cap attributes. properties: on_demand_concurrency_cap: @@ -10125,10 +10165,17 @@ description: On-demand concurrency cap response. properties: data: $ref: '#/components/schemas/OnDemandConcurrencyCap' type: object + OnDemandConcurrencyCapType: + description: On-demand concurrency cap type. + enum: + - on_demand_concurrency_cap + type: string + x-enum-varnames: + - ON_DEMAND_CONCURRENCY_CAP OpsgenieServiceCreateAttributes: description: The Opsgenie service attributes for a create request. properties: custom_url: description: The custom URL for a custom region. @@ -10428,13 +10475,11 @@ name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: - description: Array of scopes to grant the application key. This feature - is in private beta, please contact Datadog support to enable scopes for - your application keys. + description: Array of scopes to grant the application key. example: - dashboards_read - dashboards_write - dashboards_public_share items: @@ -11598,10 +11643,12 @@ data: description: Related team links items: $ref: '#/components/schemas/RelationshipToTeamLinkData' type: array + links: + $ref: '#/components/schemas/TeamRelationshipsLinks' type: object RelationshipToUser: description: Relationship to user. properties: data: @@ -11625,10 +11672,12 @@ RelationshipToUserTeamPermission: description: Relationship between a user team permission and a team properties: data: $ref: '#/components/schemas/RelationshipToUserTeamPermissionData' + links: + $ref: '#/components/schemas/TeamRelationshipsLinks' type: object RelationshipToUserTeamPermissionData: description: Related user team permission data properties: id: @@ -12061,11 +12110,10 @@ ScalarColumn: description: A single column in a scalar query response. oneOf: - $ref: '#/components/schemas/GroupScalarColumn' - $ref: '#/components/schemas/DataScalarColumn' - type: object ScalarFormulaQueryRequest: description: A wrapper request around one scalar query to be executed. properties: data: $ref: '#/components/schemas/ScalarFormulaRequest' @@ -12170,14 +12218,17 @@ $ref: '#/components/schemas/Unit' type: array type: object ScalarQuery: description: An individual scalar query to one of the basic Datadog data sources. + example: + aggregator: avg + data_source: metrics + query: avg:system.cpu.user{*} by {env} oneOf: - $ref: '#/components/schemas/MetricsScalarQuery' - $ref: '#/components/schemas/EventsScalarQuery' - type: object ScalarResponse: description: A message containing the response to a scalar query. properties: attributes: $ref: '#/components/schemas/ScalarFormulaResponseAtrributes' @@ -12486,11 +12537,10 @@ description: Create a new rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload' - $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload' - type: object SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv: description: 'If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise. The severity is decreased by one level: `CRITICAL` in production becomes `HIGH` @@ -12717,11 +12767,10 @@ SecurityMonitoringRuleQuery: description: Query for matching rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery' - type: object SecurityMonitoringRuleQueryAggregation: description: The aggregation type. enum: - count - cardinality @@ -12744,11 +12793,10 @@ SecurityMonitoringRuleResponse: description: Create a new rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse' - type: object SecurityMonitoringRuleSeverity: description: Severity of the Security Signal. enum: - info - low @@ -12893,10 +12941,11 @@ $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData' required: - data type: object SecurityMonitoringSignalAttributes: + additionalProperties: {} description: 'The object containing all signal attributes and their associated values.' properties: attributes: @@ -13011,10 +13060,25 @@ example: 25 format: int32 maximum: 1000 type: integer type: object + SecurityMonitoringSignalMetadataType: + default: signal_metadata + description: The type of event. + enum: + - signal_metadata + example: signal_metadata + type: string + x-enum-varnames: + - SIGNAL_METADATA + SecurityMonitoringSignalResponse: + description: Security Signal response data object. + properties: + data: + $ref: '#/components/schemas/SecurityMonitoringSignal' + type: object SecurityMonitoringSignalRuleCreatePayload: description: Create a new signal correlation rule. properties: cases: description: Cases for generating signals. @@ -13179,11 +13243,11 @@ description: Query for matching rule on signals. properties: aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' correlatedByFields: - description: Fields to group by. + description: Fields to correlate by. items: description: Field. type: string type: array correlatedQueryIndex: @@ -13193,10 +13257,22 @@ type: integer defaultRuleId: description: Default Rule ID to match on signals. example: d3f-ru1-e1d type: string + distinctFields: + description: Field for which the cardinality is measured. Sent as an array. + items: + description: Field. + type: string + type: array + groupByFields: + description: Fields to group by. + items: + description: Field. + type: string + type: array metrics: description: Group of target fields to aggregate over. items: description: Field. type: string @@ -13245,10 +13321,14 @@ SecurityMonitoringSignalStateUpdateData: description: Data containing the patch for changing the state of a signal. properties: attributes: $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes' + id: + description: The unique ID of the security signal. + type: + $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType' required: - attributes type: object SecurityMonitoringSignalStateUpdateRequest: description: Request body for changing the state of a given security monitoring @@ -13295,10 +13375,15 @@ SecurityMonitoringSignalTriageUpdateData: description: Data containing the updated triage attributes of the signal. properties: attributes: $ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes' + id: + description: The unique ID of the security signal. + type: string + type: + $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType' type: object SecurityMonitoringSignalTriageUpdateResponse: description: The response returned after all triage operations, containing the updated signal triage data. properties: @@ -13470,12 +13555,10 @@ type: string query: description: Query to run on logs. example: a > 3 type: string - required: - - query type: object SecurityMonitoringStandardRuleResponse: description: Rule. properties: cases: @@ -13552,10 +13635,15 @@ description: Object representing a given user entity. properties: handle: description: The handle for this user account. type: string + icon: + description: Gravatar icon associated to the user. + example: /path/to/matching/gravatar/icon + readOnly: true + type: string id: description: Numerical ID assigned by Datadog to this user account. format: int64 type: integer name: @@ -13641,11 +13729,10 @@ SensitiveDataScannerGetConfigIncludedItem: description: An object related to the configuration. oneOf: - $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem' - $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem' - type: object SensitiveDataScannerGetConfigResponse: description: Get all groups response. properties: data: $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponseData' @@ -13655,10 +13742,14 @@ $ref: '#/components/schemas/SensitiveDataScannerMeta' type: object SensitiveDataScannerGetConfigResponseData: description: Response data related to the scanning groups. properties: + attributes: + additionalProperties: {} + description: Attributes of the Sensitive Data configuration. + type: object id: description: ID of the configuration. type: string relationships: $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' @@ -13839,10 +13930,13 @@ type: integer has_highlight_enabled: description: Whether or not scanned events are highlighted in Logs or RUM for the org. type: boolean + has_multi_pass_enabled: + description: Whether or not scanned events have multi-pass enabled. + type: boolean is_pci_compliant: description: Whether or not the org is compliant to the payment card industry standard. type: boolean version: @@ -14074,10 +14168,13 @@ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' type: object SensitiveDataScannerStandardPatternAttributes: description: Attributes of the Sensitive Data Scanner standard pattern. properties: + description: + description: Description of the standard pattern. + type: string name: description: Name of the standard pattern. type: string pattern: description: Regex to match. @@ -14360,10 +14457,11 @@ type: string slack: description: "Service owner\u2019s Slack channel." example: https://yourcompany.slack.com/archives/channel123 type: string + type: object ServiceDefinitionV1Info: description: Basic information about a service. properties: dd-service: description: Unique identifier of the service. Must be unique across all @@ -15875,10 +15973,21 @@ - type type: object TeamAttributes: description: Team attributes properties: + avatar: + description: Unicode representation of the avatar for the team, limited + to a single grapheme + example: "\U0001F951" + nullable: true + type: string + banner: + description: Banner selection for the team + format: int64 + nullable: true + type: integer created_at: description: Creation date of the team format: date-time type: string description: @@ -15888,10 +15997,16 @@ handle: description: The team's identifier example: example-team maxLength: 195 type: string + hidden_modules: + description: Collection of hidden modules for the team + items: + description: String identifier of the module + type: string + type: array link_count: description: The number of links belonging to the team format: int32 maximum: 2147483647 readOnly: true @@ -15914,10 +16029,16 @@ description: The number of users belonging to the team format: int32 maximum: 2147483647 readOnly: true type: integer + visible_modules: + description: Collection of visible modules for the team + items: + description: String identifier of the module + type: string + type: array required: - handle - name type: object TeamCreate: @@ -15934,23 +16055,46 @@ - type type: object TeamCreateAttributes: description: Team creation attributes properties: + avatar: + description: Unicode representation of the avatar for the team, limited + to a single grapheme + example: "\U0001F951" + nullable: true + type: string + banner: + description: Banner selection for the team + format: int64 + nullable: true + type: integer description: description: Free-form markdown description/content for the team's homepage type: string handle: description: The team's identifier example: example-team maxLength: 195 type: string + hidden_modules: + description: Collection of hidden modules for the team + items: + description: String identifier of the module + type: string + type: array name: description: The name of the team example: Example Team maxLength: 200 type: string + visible_modules: + description: Collection of visible modules for the team + items: + description: String identifier of the module + type: string + type: array required: - handle - name type: object TeamCreateRelationships: @@ -15965,34 +16109,16 @@ data: $ref: '#/components/schemas/TeamCreate' required: - data type: object - TeamData: - description: A team - properties: - attributes: - $ref: '#/components/schemas/TeamAttributes' - id: - description: The team's identifier - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 - type: string - type: - $ref: '#/components/schemas/TeamType' - required: - - attributes - - id - - type - type: object TeamIncluded: description: Included resources related to the team oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/TeamLink' - $ref: '#/components/schemas/UserTeamPermission' - properties: {} - type: object TeamLink: description: Team link properties: attributes: $ref: '#/components/schemas/TeamLinkAttributes' @@ -16194,15 +16320,23 @@ team_links: $ref: '#/components/schemas/RelationshipToTeamLinks' user_team_permissions: $ref: '#/components/schemas/RelationshipToUserTeamPermission' type: object + TeamRelationshipsLinks: + description: Links attributes. + properties: + related: + description: Related link. + example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links + type: string + type: object TeamResponse: description: Response with a team properties: data: - $ref: '#/components/schemas/TeamData' + $ref: '#/components/schemas/Team' type: object TeamType: default: team description: Team type enum: @@ -16225,10 +16359,21 @@ - type type: object TeamUpdateAttributes: description: Team update attributes properties: + avatar: + description: Unicode representation of the avatar for the team, limited + to a single grapheme + example: "\U0001F951" + nullable: true + type: string + banner: + description: Banner selection for the team + format: int64 + nullable: true + type: integer color: description: An identifier for the color representing the team format: int32 maximum: 13 minimum: 0 @@ -16239,15 +16384,27 @@ handle: description: The team's identifier example: example-team maxLength: 195 type: string + hidden_modules: + description: Collection of hidden modules for the team + items: + description: String identifier of the module + type: string + type: array name: description: The name of the team example: Example Team maxLength: 200 type: string + visible_modules: + description: Collection of visible modules for the team + items: + description: String identifier of the module + type: string + type: array required: - handle - name type: object TeamUpdateRelationships: @@ -16275,11 +16432,77 @@ included: description: Resources related to the team items: $ref: '#/components/schemas/TeamIncluded' type: array + links: + $ref: '#/components/schemas/TeamsResponseLinks' + meta: + $ref: '#/components/schemas/TeamsResponseMeta' type: object + TeamsResponseLinks: + description: Teams response links. + properties: + first: + description: First link. + type: string + last: + description: Last link. + nullable: true + type: string + next: + description: Next link. + type: string + prev: + description: Previous link. + nullable: true + type: string + self: + description: Current link. + type: string + type: object + TeamsResponseMeta: + description: Teams response metadata. + properties: + pagination: + $ref: '#/components/schemas/TeamsResponseMetaPagination' + type: object + TeamsResponseMetaPagination: + description: Teams response metadata. + properties: + first_offset: + description: The first offset. + format: int64 + type: integer + last_offset: + description: The last offset. + format: int64 + type: integer + limit: + description: Pagination limit. + format: int64 + type: integer + next_offset: + description: The next offset. + format: int64 + type: integer + offset: + description: The offset. + format: int64 + type: integer + prev_offset: + description: The previous offset. + format: int64 + type: integer + total: + description: Total results. + format: int64 + type: integer + type: + description: Offset type. + type: string + type: object TimeseriesFormulaQueryRequest: description: A request wrapper around a single timeseries query to be executed. properties: data: $ref: '#/components/schemas/TimeseriesFormulaRequest' @@ -16369,14 +16592,16 @@ x-enum-varnames: - TIMESERIES_RESPONSE TimeseriesQuery: description: An individual timeseries query to one of the basic Datadog data sources. + example: + data_source: metrics + query: avg:system.cpu.user{*} by {env} oneOf: - $ref: '#/components/schemas/MetricsTimeseriesQuery' - $ref: '#/components/schemas/EventsTimeseriesQuery' - type: object TimeseriesResponse: description: A message containing the response to a timeseries query. properties: attributes: $ref: '#/components/schemas/TimeseriesResponseAttributes' @@ -16449,15 +16674,10 @@ description: Array of value-arrays. The index here corresponds to the index in the `formulas` or `queries` array from the request. items: $ref: '#/components/schemas/TimeseriesResponseValues' type: array - TimestampEventAttribute: - description: Timestamp of your event. - example: '2019-01-02T09:42:36.320Z' - format: date-time - type: string Unit: description: Object containing the metric unit family, scale factor, name, and short name. nullable: true properties: @@ -16503,10 +16723,14 @@ description: The product for which usage is being reported. type: string public_id: description: The organization public ID. type: string + region: + description: The region of the Datadog instance that the organization belongs + to. + type: string timeseries: description: List of usage data reported for each requested hour. items: $ref: '#/components/schemas/UsageTimeSeriesObject' type: array @@ -16763,11 +16987,10 @@ description: An object related to a user. oneOf: - $ref: '#/components/schemas/Organization' - $ref: '#/components/schemas/Permission' - $ref: '#/components/schemas/Role' - type: object UserResponseRelationships: description: Relationships of the user object returned by the API. properties: org: $ref: '#/components/schemas/RelationshipToOrganization' @@ -16916,10 +17139,14 @@ data: description: Team memberships response data items: $ref: '#/components/schemas/UserTeam' type: array + links: + $ref: '#/components/schemas/TeamsResponseLinks' + meta: + $ref: '#/components/schemas/TeamsResponseMeta' type: object UserUpdateAttributes: description: Attributes of the edited user. properties: disabled: @@ -16993,37 +17220,33 @@ apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. events_read: Read Events data. + incident_notification_settings_write: Configure Incidents Notification + settings. incident_read: View incidents in Datadog. - incident_settings_write: Configure Incidents settings. + incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. - metric_tags_write: Create and edit tag configurations for custom metrics. metrics_read: View custom metrics. monitors_downtime: Set downtimes to suppress alerts from any monitor in - an organization. The ability to write monitors is not required to set - downtimes. + an organization. Mute and unmute hosts. The ability to write monitors + is not required to set downtimes. monitors_read: View monitors. - org_management: Edit organization configurations, including authentication - and certain security preferences. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View CSPM Findings. - security_monitoring_findings_write: Mute CSPM Findings. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. - synthetics_default_settings_read: View the default settings for Synthetic - Monitoring. - synthetics_default_settings_write: Create and edit default settings for - Synthetic Monitoring. - teams_manage: Manage Teams. Create, delete, rename, and edit the metadata + synthetics_read: List and view configured Synthetic tests and test results. + synthetics_write: Create, edit, and delete Synthetic tests. + teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. - teams_read: Read Teams data. View Team names, metadata, and which users - are on each Team. + teams_read: Read Teams data. A User with this permission can view Team + names, metadata, and which Users are on each Team. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. @@ -17235,14 +17458,10 @@ description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get all span-based metrics tags: - Spans Metrics post: description: 'Create a metric based on your ingested spans in your organization. @@ -17310,14 +17529,10 @@ $ref: '#/components/responses/NotAuthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get a span-based metric tags: - Spans Metrics patch: description: 'Update a specific span-based metric from your organization. @@ -17837,18 +18052,15 @@ x-permission: OR(USER_ACCESS_MANAGE) /api/v2/ci/pipeline: post: description: 'Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types - we support, see the [guide](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). + we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). Pipeline events can be submitted with a timestamp that is up to 18 hours in - the past. - - - This API endpoint is in private beta.' + the past.' operationId: CreateCIAppPipelineEvent requestBody: content: application/json: schema: @@ -17911,14 +18123,16 @@ description: Service Unavailable summary: Send pipeline event tags: - CI Visibility Pipelines x-codegen-request-body-name: body + x-unstable: '**Note**: This API endpoint is in private beta. Request access + [here](https://docs.google.com/forms/d/e/1FAIpQLSdNejCvhMbdBW5nnGly1yvmYMn2Wpj4JOI0zKIiEx6O6I2dbQ/viewform).' /api/v2/ci/pipelines/analytics/aggregate: post: - description: The API endpoint to aggregate CI Visibility pipeline events into - buckets of computed metrics and timeseries. + description: Use this API endpoint to aggregate CI Visibility pipeline events + into buckets of computed metrics and timeseries. operationId: AggregateCIAppPipelineEvents requestBody: content: application/json: schema: @@ -17942,11 +18156,11 @@ - CI Visibility Pipelines x-codegen-request-body-name: body /api/v2/ci/pipelines/events: get: description: 'List endpoint returns CI Visibility pipeline events that match - a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). + a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest pipeline events.' @@ -18021,11 +18235,11 @@ limitParam: page[limit] resultsPath: data /api/v2/ci/pipelines/events/search: post: description: 'List endpoint returns CI Visibility pipeline events that match - a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). + a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' @@ -18601,11 +18815,11 @@ $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - monitors_read + - monitors_downtime summary: Get all downtimes tags: - Downtimes x-unstable: '**Note**: This endpoint is in private beta. @@ -20547,15 +20761,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management summary: Get IP Allowlist tags: - IP Allowlist patch: description: Edit the entries in the IP allowlist, and enable or disable it. @@ -20579,15 +20788,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management summary: Update IP Allowlist tags: - IP Allowlist x-codegen-request-body-name: body /api/v2/logs: @@ -21571,11 +21775,11 @@ schema: type: string - description: 'The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query. - Defaults value is 3600 (1 hour), maximum value is 1,209,600 (2 weeks).' + Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).' example: 3600 in: query name: window[seconds] required: false schema: @@ -21822,11 +22026,12 @@ $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - metrics_read summary: List tags by metric name tags: - Metrics /api/v2/metrics/{metric_name}/estimate: get: @@ -22375,11 +22580,11 @@ $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - monitors_read + - monitors_downtime summary: Get active downtimes for a monitor tags: - Downtimes x-codegen-request-body-name: body x-unstable: '**Note**: This endpoint is in private beta. @@ -22412,11 +22617,12 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - user_access_read summary: List permissions tags: - Roles /api/v2/posture_management/findings: get: @@ -22667,12 +22873,10 @@ '429': $ref: '#/components/responses/FindingsTooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_write summary: Mute or unmute a finding tags: - Security Monitoring x-codegen-request-body-name: body x-unstable: '**Note**: This endpoint is in public beta. @@ -22849,12 +23053,10 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - timeseries_query - - metrics_read - - metric_tags_write summary: Query timeseries data across multiple products tags: - Metrics x-codegen-request-body-name: body x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring @@ -23014,11 +23216,12 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - user_access_read summary: List roles tags: - Roles post: description: Create a new role for your organization. @@ -23118,11 +23321,12 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - user_access_read summary: Get a role tags: - Roles x-codegen-request-body-name: body patch: @@ -23309,11 +23513,12 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - user_access_read summary: List permissions for a role tags: - Roles x-codegen-request-body-name: body post: @@ -23458,11 +23663,12 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - - AuthZ: [] + - AuthZ: + - user_access_read summary: Get all users of a role tags: - Roles post: description: Adds a user to a role. @@ -24414,11 +24620,11 @@ responses: '200': content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignal' + $ref: '#/components/schemas/SecurityMonitoringSignalResponse' description: OK '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' @@ -27458,9 +27664,43 @@ - user_access_read summary: Get a user permissions tags: - Users x-codegen-request-body-name: body + /api/v2/users/{user_uuid}/memberships: + get: + description: Get a list of memberships for a user + operationId: GetUserMemberships + parameters: + - description: None + in: path + name: user_uuid + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserTeamsResponse' + description: Represents a user's association to a team + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Get user memberships + tags: + - Teams security: - apiKeyAuth: [] appKeyAuth: [] servers: - url: https://{subdomain}.{site}