.generator/schemas/v2/openapi.yaml in datadog_api_client-2.5.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.6.0

- old
+ new

@@ -195,10 +195,48 @@ required: false schema: items: $ref: '#/components/schemas/IncidentRelatedObject' type: array + IncidentSearchIncludeQueryParameter: + description: Specifies which types of related objects should be included in + the response. + in: query + name: include + required: false + schema: + $ref: '#/components/schemas/IncidentRelatedObject' + IncidentSearchQueryQueryParameter: + description: 'Specifies which incidents should be returned. After entering a + search query in your [Incidents page][1], + + use the query parameter value in the URL of the page as the value for this + parameter. + + + The query can contain any number of incident facets joined by `ANDs`, along + with multiple values for each of + + those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2 + OR SEV-1)"`. + + + [1]: https://app.datadoghq.com/incidents' + explode: false + in: query + name: query + required: true + schema: + type: string + IncidentSearchSortQueryParameter: + description: Specifies the order of returned incidents. + explode: false + in: query + name: sort + required: false + schema: + $ref: '#/components/schemas/IncidentSearchSortOrder' IncidentServiceIDPathParameter: description: The ID of the incident service. in: path name: service_id required: true @@ -1383,11 +1421,11 @@ $ref: '#/components/schemas/CIAppPipelineEvent' type: array links: $ref: '#/components/schemas/CIAppResponseLinks' meta: - $ref: '#/components/schemas/CIAppResponseMetadata' + $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object CIAppPipelinesAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of pipeline events from your organization. properties: @@ -1404,12 +1442,10 @@ items: $ref: '#/components/schemas/CIAppPipelinesGroupBy' type: array options: $ref: '#/components/schemas/CIAppQueryOptions' - page: - $ref: '#/components/schemas/CIAppQueryPageOptions' type: object CIAppPipelinesAggregationBucketsResponse: description: The query results. properties: buckets: @@ -1432,11 +1468,10 @@ description: Bucket values. properties: by: additionalProperties: description: The values for each group-by. - type: string description: The key-value pairs for each group-by. example: '@ci.provider.name': gitlab '@ci.status': success type: object @@ -1536,10 +1571,33 @@ elapsed: description: The time elapsed in milliseconds. example: 132 format: int64 type: integer + request_id: + description: The identifier of the request. + example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + type: string + status: + $ref: '#/components/schemas/CIAppResponseStatus' + warnings: + description: 'A list of warnings (non-fatal errors) encountered. Partial + results may return if + + warnings are present in the response.' + items: + $ref: '#/components/schemas/CIAppWarning' + type: array + type: object + CIAppResponseMetadataWithPagination: + description: The metadata associated with a request. + properties: + elapsed: + description: The time elapsed in milliseconds. + example: 132 + format: int64 + type: integer page: $ref: '#/components/schemas/CIAppResponsePage' request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR @@ -1636,11 +1694,11 @@ $ref: '#/components/schemas/CIAppTestEvent' type: array links: $ref: '#/components/schemas/CIAppResponseLinks' meta: - $ref: '#/components/schemas/CIAppResponseMetadata' + $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object CIAppTestsAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of test events from your organization. properties: @@ -1657,12 +1715,10 @@ items: $ref: '#/components/schemas/CIAppTestsGroupBy' type: array options: $ref: '#/components/schemas/CIAppQueryOptions' - page: - $ref: '#/components/schemas/CIAppQueryPageOptions' type: object CIAppTestsAggregationBucketsResponse: description: The query results. properties: buckets: @@ -1685,11 +1741,10 @@ description: Bucket values. properties: by: additionalProperties: description: The values for each group-by. - type: string description: The key-value pairs for each group-by. example: '@test.service': web-ui-tests '@test.status': skip type: object @@ -1774,11 +1829,16 @@ description: The product for which cost is being reported. example: infra_host type: string type: object CloudConfigurationComplianceRuleOptions: - description: Options for cloud_configuration rules. + description: 'Options for cloud_configuration rules. + + Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration` + rules. + + ' properties: complexRule: description: 'Whether the rule is a complex one. Must be set to true if `regoRule.resourceTypes` contains more than one @@ -1793,13 +1853,10 @@ specified again in `regoRule.resourceTypes`. ' example: aws_acm type: string - required: - - resourceType - - regoRule type: object CloudConfigurationRegoRule: description: Rule details. properties: policy: @@ -2821,10 +2878,99 @@ - event example: event type: string x-enum-varnames: - EVENT + EventsAggregation: + default: count + description: The type of aggregation that can be performed on events-based queries. + enum: + - count + - cardinality + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg + example: count + type: string + x-enum-varnames: + - COUNT + - CARDINALITY + - PC75 + - PC90 + - PC95 + - PC98 + - PC99 + - SUM + - MIN + - MAX + - AVG + EventsCompute: + description: The instructions for what to compute for this query. + properties: + aggregation: + $ref: '#/components/schemas/EventsAggregation' + interval: + description: Interval for compute in milliseconds. + example: 60000 + format: int64 + type: integer + metric: + description: The "measure" attribute on which to perform the computation. + type: string + required: + - aggregation + type: object + EventsDataSource: + default: logs + description: A data source that is powered by the Events Platform. + enum: + - logs + example: logs + type: string + x-enum-varnames: + - LOGS + EventsGroupBy: + description: A dimension on which to split a query's results. + properties: + facet: + description: The facet by which to split groups. + example: '@error.type' + type: string + limit: + description: The maximum number of groups to return. + example: 10 + format: int32 + maximum: 2147483647 + type: integer + sort: + $ref: '#/components/schemas/EventsGroupBySort' + required: + - facet + type: object + EventsGroupBySort: + description: The dimension by which to sort a query's results. + properties: + aggregation: + $ref: '#/components/schemas/EventsAggregation' + metric: + description: Metric whose calculated value should be used to define the + sort order of a query's results. + example: '@duration' + type: string + order: + $ref: '#/components/schemas/QuerySortOrder' + type: + $ref: '#/components/schemas/EventsSortType' + required: + - aggregation + type: object EventsListRequest: description: The object sent with the request to retrieve a list of events from your organization. properties: filter: @@ -2880,10 +3026,15 @@ description: The maximum time for the requested events. Supports date math and regular timestamps in milliseconds. example: now type: string type: object + EventsQueryGroupBys: + description: The list of facets on which to split results. + items: + $ref: '#/components/schemas/EventsGroupBy' + type: array EventsQueryOptions: description: 'The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.' @@ -2946,19 +3097,86 @@ parameters with the addition of the `page[cursor]`.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object + EventsScalarQuery: + description: An individual scalar events query. + properties: + compute: + $ref: '#/components/schemas/EventsCompute' + data_source: + $ref: '#/components/schemas/EventsDataSource' + group_by: + $ref: '#/components/schemas/EventsQueryGroupBys' + indexes: + description: The indexes in which to search. + items: + description: The unique index name. + example: main + type: string + type: array + name: + description: The variable name for use in formulas. + type: string + search: + $ref: '#/components/schemas/EventsSearch' + required: + - data_source + - compute + type: object + EventsSearch: + description: Configuration of the search/filter for an events query. + properties: + query: + description: The search/filter string for an events query. + example: status:warn service:foo + type: string + type: object EventsSort: description: The sort parameters when querying events. enum: - timestamp - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING + EventsSortType: + description: The type of sort to use on the calculated value. + enum: + - alphabetical + - measure + type: string + x-enum-varnames: + - ALPHABETICAL + - MEASURE + EventsTimeseriesQuery: + description: An individual timeseries events query. + properties: + compute: + $ref: '#/components/schemas/EventsCompute' + data_source: + $ref: '#/components/schemas/EventsDataSource' + group_by: + $ref: '#/components/schemas/EventsQueryGroupBys' + indexes: + description: The indexes in which to search. + items: + description: The unique index name. + example: main + type: string + type: array + name: + description: The variable name for use in formulas. + type: string + search: + $ref: '#/components/schemas/EventsSearch' + required: + - data_source + - compute + type: object EventsWarning: description: A warning message indicating something is wrong with the query. properties: code: description: A unique code for this type of warning. @@ -2972,10 +3190,23 @@ description: A short human-readable summary of the warning. example: One or several indexes are missing or invalid. Results hold data from the other indexes. type: string type: object + FormulaLimit: + description: Message for specifying limits to the number of values returned + by a query. + properties: + count: + description: The number of results to which to limit. + example: 10 + format: int32 + maximum: 2147483647 + type: integer + order: + $ref: '#/components/schemas/QuerySortOrder' + type: object FullAPIKey: description: Datadog API key. properties: attributes: $ref: '#/components/schemas/FullAPIKeyAttributes' @@ -3064,10 +3295,16 @@ description: Name of scope. type: string nullable: true type: array type: object + GroupTags: + description: List of tags that apply to a single response value. + items: + description: A single tag that applies to a single response value. + type: string + type: array HTTPLog: description: Structured log message. items: $ref: '#/components/schemas/HTTPLogItem' type: array @@ -3828,10 +4065,224 @@ integrations: $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' last_modified_by_user: $ref: '#/components/schemas/RelationshipToUser' type: object + IncidentSearchResponse: + description: Response with incidents and facets. + properties: + data: + $ref: '#/components/schemas/IncidentSearchResponseData' + included: + description: Included related resources that the user requested. + items: + $ref: '#/components/schemas/IncidentResponseIncludedItem' + readOnly: true + type: array + required: + - data + type: object + IncidentSearchResponseAttributes: + description: Attributes returned by an incident search. + properties: + facets: + $ref: '#/components/schemas/IncidentSearchResponseFacetsData' + incidents: + description: Incidents returned by the search. + items: + $ref: '#/components/schemas/IncidentSearchResponseIncidentsData' + type: array + total: + description: Number of incidents returned by the search. + example: 10 + format: int32 + maximum: 2147483647 + type: integer + required: + - facets + - incidents + - total + type: object + IncidentSearchResponseData: + description: Data returned by an incident search. + properties: + attributes: + $ref: '#/components/schemas/IncidentSearchResponseAttributes' + type: + $ref: '#/components/schemas/IncidentSearchResultsType' + type: object + IncidentSearchResponseFacetCount: + description: Count of the facet value appearing in search results. + example: 5 + format: int32 + maximum: 2147483647 + type: integer + IncidentSearchResponseFacetsData: + description: Facet data for incidents returned by a search query. + properties: + commander: + description: Facet data for incident commander users. + items: + $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + type: array + created_by: + description: Facet data for incident creator users. + items: + $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + type: array + fields: + description: Facet data for incident property fields. + items: + $ref: '#/components/schemas/IncidentSearchResponsePropertyFieldFacetData' + type: array + impact: + description: Facet data for incident impact attributes. + items: + $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + type: array + last_modified_by: + description: Facet data for incident last modified by users. + items: + $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + type: array + postmortem: + description: Facet data for incident postmortem existence. + items: + $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + type: array + responder: + description: Facet data for incident responder users. + items: + $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + type: array + severity: + description: Facet data for incident severity attributes. + items: + $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + type: array + state: + description: Facet data for incident state attributes. + items: + $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + type: array + time_to_repair: + description: Facet data for incident time to repair metrics. + items: + $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData' + type: array + time_to_resolve: + description: Facet data for incident time to resolve metrics. + items: + $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData' + type: array + type: object + IncidentSearchResponseFieldFacetData: + description: Facet value and number of occurrences for a property field of an + incident. + properties: + count: + $ref: '#/components/schemas/IncidentSearchResponseFacetCount' + name: + description: The facet value appearing in search results. + example: SEV-2 + type: string + type: object + IncidentSearchResponseIncidentsData: + description: Incident returned by the search. + properties: + data: + $ref: '#/components/schemas/IncidentResponseData' + required: + - data + type: object + IncidentSearchResponseNumericFacetData: + description: Facet data numeric attributes of an incident. + properties: + aggregates: + $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates' + name: + description: Name of the incident property field. + example: time_to_repair + type: string + required: + - name + - aggregates + type: object + IncidentSearchResponseNumericFacetDataAggregates: + description: Aggregate information for numeric incident data. + properties: + max: + description: Maximum value of the numeric aggregates. + example: 1234.0 + format: double + nullable: true + type: number + min: + description: Minimum value of the numeric aggregates. + example: 20.0 + format: double + nullable: true + type: number + type: object + IncidentSearchResponsePropertyFieldFacetData: + description: Facet data for the incident property fields. + properties: + aggregates: + $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates' + facets: + description: Facet data for the property field of an incident. + items: + $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + type: array + name: + description: Name of the incident property field. + example: Severity + type: string + required: + - facets + - name + type: object + IncidentSearchResponseUserFacetData: + description: Facet data for user attributes of an incident. + properties: + count: + $ref: '#/components/schemas/IncidentSearchResponseFacetCount' + email: + description: Email of the user. + example: datadog.user@example.com + type: string + handle: + description: Handle of the user. + example: '@datadog.user@example.com' + type: string + name: + description: Name of the user. + example: Datadog User + type: string + uuid: + description: ID of the user. + example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 + type: string + type: object + IncidentSearchResultsType: + default: incidents_search_results + description: Incident search result type. + enum: + - incidents_search_results + example: incidents_search_results + type: string + x-enum-varnames: + - INCIDENTS_SEARCH_RESULTS + IncidentSearchSortOrder: + description: The ways searched incidents can be sorted. + enum: + - created + - -created + type: string + x-enum-varnames: + - CREATED_ASCENDING + - CREATED_DESCENDING IncidentServiceCreateAttributes: description: The incident service's attributes for a create request. properties: name: description: Name of the incident service. @@ -4488,11 +4939,10 @@ description: A bucket values properties: by: additionalProperties: description: The values for each group by - type: string description: The key, value pairs for each group by example: '@state': success '@version': abc type: object @@ -6349,10 +6799,27 @@ properties: data: $ref: '#/components/schemas/MetricVolumes' readOnly: true type: object + MetricsAggregator: + default: avg + description: The type of aggregation that can be performed on metrics queries. + enum: + - avg + - min + - max + - sum + - last + example: avg + type: string + x-enum-varnames: + - AVG + - MIN + - MAX + - SUM + - LAST MetricsAndMetricTagConfigurations: description: Object for a metrics and metric tag configurations. oneOf: - $ref: '#/components/schemas/Metric' - $ref: '#/components/schemas/MetricTagConfiguration' @@ -6365,10 +6832,54 @@ items: $ref: '#/components/schemas/MetricsAndMetricTagConfigurations' type: array readOnly: true type: object + MetricsDataSource: + default: metrics + description: A data source that is powered by the Metrics backend. + enum: + - metrics + example: metrics + type: string + x-enum-varnames: + - METRICS + MetricsScalarQuery: + description: An individual scalar metrics query. + properties: + aggregator: + $ref: '#/components/schemas/MetricsAggregator' + data_source: + $ref: '#/components/schemas/MetricsDataSource' + name: + description: The variable name for use in formulas. + type: string + query: + description: A classic metrics query string. + example: avg:system.cpu.user{*} + type: string + required: + - data_source + - query + - aggregator + type: object + MetricsTimeseriesQuery: + description: An individual timeseries metrics query. + properties: + data_source: + $ref: '#/components/schemas/MetricsDataSource' + name: + description: The variable name for use in formulas. + type: string + query: + description: A classic metrics query string. + example: avg:system.cpu.user{*} + type: string + required: + - data_source + - query + type: object MonitorType: description: Attributes from the monitor that triggered the event. nullable: true properties: created_at: @@ -6911,10 +7422,23 @@ - process example: process type: string x-enum-varnames: - PROCESS + QueryFormula: + description: A formula for calculation based on one or more queries. + properties: + formula: + description: Formula string, referencing one or more queries with their + name property. + example: a+b + type: string + limit: + $ref: '#/components/schemas/FormulaLimit' + required: + - formula + type: object QuerySortOrder: default: desc description: Direction of sort. enum: - asc @@ -8203,10 +8727,138 @@ - saml_assertion_attributes example: saml_assertion_attributes type: string x-enum-varnames: - SAML_ASSERTION_ATTRIBUTES + ScalarColumn: + description: A single column in a scalar query response. + properties: + unit: + description: List of units. + items: + $ref: '#/components/schemas/Unit' + type: array + values: + description: Array of values for each group-by combination that results + from one formula or query. + items: + description: An individual value for a given column and group-by. + format: double + type: number + type: array + type: object + ScalarFormulaQueryRequest: + description: A wrapper request around one scalar query to be executed. + properties: + data: + $ref: '#/components/schemas/ScalarFormulaRequest' + required: + - data + type: object + ScalarFormulaQueryResponse: + description: A message containing one or more responses to scalar queries. + properties: + data: + $ref: '#/components/schemas/ScalarResponse' + errors: + description: An error generated when processing a request. + type: string + type: object + ScalarFormulaRequest: + description: A single scalar query to be executed. + properties: + attributes: + $ref: '#/components/schemas/ScalarFormulaRequestAttributes' + type: + $ref: '#/components/schemas/ScalarFormulaRequestType' + required: + - type + - attributes + type: object + ScalarFormulaRequestAttributes: + description: The object describing a scalar formula request. + properties: + formulas: + description: List of formulas to be calculated and returned as responses. + items: + $ref: '#/components/schemas/QueryFormula' + type: array + from: + description: Start date (inclusive) of the query in milliseconds since the + Unix epoch. + example: 1568899800000 + format: int64 + type: integer + queries: + $ref: '#/components/schemas/ScalarFormulaRequestQueries' + to: + description: End date (exclusive) of the query in milliseconds since the + Unix epoch. + example: 1568923200000 + format: int64 + type: integer + required: + - to + - from + - queries + type: object + ScalarFormulaRequestQueries: + description: List of queries to be run and used as inputs to the formulas. + items: + $ref: '#/components/schemas/ScalarQuery' + type: array + ScalarFormulaRequestType: + default: scalar_request + description: The type of the resource. The value should always be scalar_request. + enum: + - scalar_request + example: scalar_request + type: string + x-enum-varnames: + - SCALAR_REQUEST + ScalarFormulaResponseAtrributes: + description: The object describing a scalar response. + properties: + columns: + description: List of response columns, each corresponding to an individual + formula or query in the request and with values in parallel arrays matching + the series list. + items: + $ref: '#/components/schemas/ScalarColumn' + type: array + series: + $ref: '#/components/schemas/ScalarResponseSeriesList' + type: object + ScalarFormulaResponseType: + default: scalar_response + description: The type of the resource. The value should always be scalar_response. + enum: + - scalar_response + example: scalar_response + type: string + x-enum-varnames: + - SCALAR_RESPONSE + ScalarQuery: + description: An individual scalar query to one of the basic Datadog data sources. + 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' + type: + $ref: '#/components/schemas/ScalarFormulaResponseType' + type: object + ScalarResponseSeriesList: + description: List of group-by tags for the response. Parallel array to the values + in each scalar column. + items: + $ref: '#/components/schemas/GroupTags' + type: array SecurityFilter: description: The security filter's properties. properties: attributes: $ref: '#/components/schemas/SecurityFilterAttributes' @@ -10670,15 +11322,204 @@ - team:A items: description: Tag associated with your event. type: string type: array + TimeseriesFormulaQueryRequest: + description: A request wrapper around a single timeseries query to be executed. + properties: + data: + $ref: '#/components/schemas/TimeseriesFormulaRequest' + required: + - data + type: object + TimeseriesFormulaQueryResponse: + description: A message containing one response to a timeseries query made with + timeseries formula query request. + properties: + data: + $ref: '#/components/schemas/TimeseriesResponse' + errors: + description: The error generated by the request. + type: string + type: object + TimeseriesFormulaRequest: + description: A single timeseries query to be executed. + properties: + attributes: + $ref: '#/components/schemas/TimeseriesFormulaRequestAttributes' + type: + $ref: '#/components/schemas/TimeseriesFormulaRequestType' + required: + - type + - attributes + type: object + TimeseriesFormulaRequestAttributes: + description: The object describing a timeseries formula request. + properties: + formulas: + description: List of formulas to be calculated and returned as responses. + items: + $ref: '#/components/schemas/QueryFormula' + type: array + from: + description: Start date (inclusive) of the query in milliseconds since the + Unix epoch. + example: 1568899800000 + format: int64 + type: integer + interval: + description: 'A time interval in milliseconds. + + May be overridden by a larger interval if the query would result in + + too many points for the specified timeframe. + + Defaults to a reasonable interval for the given timeframe.' + example: 5000 + format: int64 + type: integer + queries: + $ref: '#/components/schemas/TimeseriesFormulaRequestQueries' + to: + description: End date (exclusive) of the query in milliseconds since the + Unix epoch. + example: 1568923200000 + format: int64 + type: integer + required: + - to + - from + - queries + type: object + TimeseriesFormulaRequestQueries: + description: List of queries to be run and used as inputs to the formulas. + items: + $ref: '#/components/schemas/TimeseriesQuery' + type: array + TimeseriesFormulaRequestType: + default: timeseries_request + description: The type of the resource. The value should always be timeseries_request. + enum: + - timeseries_request + example: timeseries_request + type: string + x-enum-varnames: + - TIMESERIES_REQUEST + TimeseriesFormulaResponseType: + default: timeseries_response + description: The type of the resource. The value should always be timeseries_response. + enum: + - timeseries_response + example: timeseries_response + type: string + x-enum-varnames: + - TIMESERIES_RESPONSE + TimeseriesQuery: + description: An individual timeseries query to one of the basic Datadog data + sources. + 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' + type: + $ref: '#/components/schemas/TimeseriesFormulaResponseType' + type: object + TimeseriesResponseAttributes: + description: The object describing a timeseries response. + properties: + series: + $ref: '#/components/schemas/TimeseriesResponseSeriesList' + times: + $ref: '#/components/schemas/TimeseriesResponseTimes' + values: + $ref: '#/components/schemas/TimeseriesResponseValuesList' + type: object + TimeseriesResponseSeries: + description: '' + properties: + group_tags: + $ref: '#/components/schemas/GroupTags' + query_index: + description: The index of the query in the "formulas" array (or "queries" + array if no "formulas" was specified). + example: 0 + format: int32 + maximum: 2147483647 + type: integer + unit: + description: List of units. + items: + $ref: '#/components/schemas/Unit' + type: array + type: object + TimeseriesResponseSeriesList: + description: Array of response series. The index here corresponds to the index + in the `formulas` or `queries` array from the request. + items: + $ref: '#/components/schemas/TimeseriesResponseSeries' + type: array + TimeseriesResponseTimes: + description: Array of times, 1-1 match with individual values arrays. + items: + description: Start date (inclusive) of the query in seconds since the Unix + epoch. + example: 1568899800000 + format: int64 + type: integer + type: array + TimeseriesResponseValues: + description: Array of values for an individual formula or query. + items: + description: An individual value for a given time. + format: double + type: number + type: array + TimeseriesResponseValuesList: + 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: + family: + description: Unit family, allows for conversion between units of the same + family, for scaling. + example: time + type: string + name: + description: Unit name + example: minute + type: string + plural: + description: Plural form of the unit name. + example: minutes + type: string + scale_factor: + description: Factor for scaling between units of the same family. + example: 60.0 + format: double + type: number + short_name: + description: Abbreviation of the unit. + example: min + type: string + type: object UsageApplicationSecurityMonitoringResponse: description: Application Security Monitoring usage response. properties: data: description: Response containing Application Security Monitoring usage. @@ -11044,10 +11885,13 @@ events_read: Read Events data. incident_read: View incidents in Datadog. incident_settings_write: Configure Incidents settings. incident_write: Create, view, and manage incidents in Datadog. 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. monitors_read: View monitors. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. @@ -12610,10 +13454,46 @@ - Incidents x-codegen-request-body-name: body x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/incidents/search: + get: + description: Search for incidents matching a certain query. + operationId: SearchIncidents + parameters: + - $ref: '#/components/parameters/IncidentSearchIncludeQueryParameter' + - $ref: '#/components/parameters/IncidentSearchQueryQueryParameter' + - $ref: '#/components/parameters/IncidentSearchSortQueryParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentSearchResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + summary: Search for incidents + tags: + - Incidents + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents/{incident_id}: delete: description: Deletes an existing incident from the users organization. operationId: DeleteIncident parameters: @@ -14867,10 +15747,86 @@ x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data + /api/v2/query/scalar: + post: + description: 'The internal endpoint to query scalar/table data for multiple + data sources and + + process the data using formulas and functions.' + operationId: QueryScalarData + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScalarFormulaQueryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ScalarFormulaQueryResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Scalar cross product query + tags: + - Metrics + x-codegen-request-body-name: body + x-unstable: '**Note**: This endpoint is GA for the metrics data source. Logs + is in beta. + + We are gradually onboarding support for more sources. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/query/timeseries: + post: + description: 'The internal endpoint to query timeseries data for multiple data + sources and + + process the data by applying formulas and functions.' + operationId: QueryTimeseriesData + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TimeseriesFormulaQueryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TimeseriesFormulaQueryResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Timeseries cross product query + tags: + - Metrics + x-codegen-request-body-name: body + x-unstable: '**Note**: This endpoint is GA for the metrics data source. Logs + is in beta. + + We are gradually onboarding support for more sources. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/roles: get: description: Returns all roles, including their names and their unique identifiers. operationId: ListRoles parameters: @@ -18558,15 +19514,16 @@ externalDocs: description: Find out more at url: https://docs.datadoghq.com/logs/logs_to_metrics/ name: Logs Metrics - description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can - be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period\n- - Modify tag configurations for metrics\n- View tags and volumes for metrics\n\n**Note**: - A graph can only contain a set number of points\nand as the timeframe over which - a metric is viewed increases,\naggregation between points occurs to stay below - that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can - only be performed by\na user who has the `Manage Tags for Metrics` permission." + be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period + (timeseries and scalar)\n- Modify tag configurations for metrics\n- View tags + and volumes for metrics\n\n**Note**: A graph can only contain a set number of + points\nand as the timeframe over which a metric is viewed increases,\naggregation + between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete + `manage_tags` API methods can only be performed by\na user who has the `Manage + Tags for Metrics` permission." name: Metrics - description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) directly through the Datadog API.' externalDocs: