.generator/schemas/v2/openapi.yaml in datadog_api_client-1.8.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-1.9.0

- old
+ new

@@ -1592,10 +1592,27 @@ example: payment type: string required: - name type: object + HourlyUsageType: + description: Usage type that is being measured. + enum: + - observability_pipelines_bytes_processed + example: observability_pipelines_bytes_processed + type: string + x-enum-varnames: + - OBSERVABILITY_PIPELINES_BYTES_PROCESSSED + IdPMetadataFormData: + description: The form data submitted to upload IdP metadata + properties: + idp_file: + description: The IdP metadata XML file + format: binary + type: string + x-mimetype: application/xml + type: object IncidentCreateAttributes: description: The incident's attributes for a create request. properties: customer_impacted: description: A flag indicating whether the incident caused customer impact. @@ -2741,10 +2758,11 @@ - pc99 - sum - min - max - avg + - median example: pc90 type: string x-enum-varnames: - COUNT - CARDINALITY @@ -2755,10 +2773,11 @@ - PERCENTILE_99 - SUM - MIN - MAX - AVG + - MEDIAN LogsArchive: description: The logs archive. properties: data: $ref: '#/components/schemas/LogsArchiveDefinition' @@ -4499,10 +4518,190 @@ - desc type: string x-enum-varnames: - ASC - DESC + RUMAggregateBucketValue: + description: A bucket value, can be either a timeseries or a single value. + oneOf: + - $ref: '#/components/schemas/RUMAggregateBucketValueSingleString' + - $ref: '#/components/schemas/RUMAggregateBucketValueSingleNumber' + - $ref: '#/components/schemas/RUMAggregateBucketValueTimeseries' + RUMAggregateBucketValueSingleNumber: + description: A single number value. + format: double + type: number + RUMAggregateBucketValueSingleString: + description: A single string value. + type: string + RUMAggregateBucketValueTimeseries: + description: A timeseries array. + items: + $ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint' + type: array + + RUMAggregateBucketValueTimeseriesPoint: + description: A timeseries point. + properties: + time: + description: The time value for this point. + example: '2020-06-08T11:55:00.123Z' + format: date-time + type: string + value: + description: The value for this point. + example: 19 + format: double + type: number + type: object + RUMAggregateRequest: + description: The object sent with the request to retrieve aggregation buckets + of RUM events from your organization. + properties: + compute: + description: The list of metrics or timeseries to compute for the retrieved + buckets. + items: + $ref: '#/components/schemas/RUMCompute' + type: array + filter: + $ref: '#/components/schemas/RUMQueryFilter' + group_by: + description: The rules for the group by. + items: + $ref: '#/components/schemas/RUMGroupBy' + type: array + options: + $ref: '#/components/schemas/RUMQueryOptions' + page: + $ref: '#/components/schemas/RUMQueryPageOptions' + type: object + RUMAggregateSort: + description: A sort rule. + example: + aggregation: count + order: asc + properties: + aggregation: + $ref: '#/components/schemas/RUMAggregationFunction' + metric: + description: The metric to sort by (only used for `type=measure`). + example: '@duration' + type: string + order: + $ref: '#/components/schemas/RUMSortOrder' + type: + $ref: '#/components/schemas/RUMAggregateSortType' + type: object + RUMAggregateSortType: + default: alphabetical + description: The type of sorting algorithm. + enum: + - alphabetical + - measure + type: string + x-enum-varnames: + - ALPHABETICAL + - MEASURE + RUMAggregationBucketsResponse: + description: The query results. + properties: + buckets: + description: The list of matching buckets, one item per bucket. + items: + $ref: '#/components/schemas/RUMBucketResponse' + type: array + type: object + RUMAggregationFunction: + description: An aggregation function. + enum: + - count + - cardinality + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg + - median + example: pc90 + type: string + x-enum-varnames: + - COUNT + - CARDINALITY + - PERCENTILE_75 + - PERCENTILE_90 + - PERCENTILE_95 + - PERCENTILE_98 + - PERCENTILE_99 + - SUM + - MIN + - MAX + - AVG + - MEDIAN + RUMAnalyticsAggregateResponse: + description: The response object for the RUM events aggregate API endpoint. + properties: + data: + $ref: '#/components/schemas/RUMAggregationBucketsResponse' + links: + $ref: '#/components/schemas/RUMResponseLinks' + meta: + $ref: '#/components/schemas/RUMResponseMetadata' + type: object + RUMBucketResponse: + 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: + '@session.type': user + '@type': view + type: object + computes: + additionalProperties: + $ref: '#/components/schemas/RUMAggregateBucketValue' + description: A map of the metric name to value for regular compute, or a + list of values for a timeseries. + type: object + type: object + RUMCompute: + description: A compute rule to compute metrics or timeseries. + properties: + aggregation: + $ref: '#/components/schemas/RUMAggregationFunction' + interval: + description: 'The time buckets'' size (only used for type=timeseries) + + Defaults to a resolution of 150 points.' + example: 5m + type: string + metric: + description: The metric to use. + example: '@duration' + type: string + type: + $ref: '#/components/schemas/RUMComputeType' + required: + - aggregation + type: object + RUMComputeType: + default: total + description: The type of compute. + enum: + - timeseries + - total + type: string + x-enum-varnames: + - TIMESERIES + - TOTAL RUMEvent: description: Object description of a RUM event after being processed and stored by Datadog. properties: attributes: @@ -4568,10 +4767,93 @@ links: $ref: '#/components/schemas/RUMResponseLinks' meta: $ref: '#/components/schemas/RUMResponseMetadata' type: object + RUMGroupBy: + description: A group-by rule. + properties: + facet: + description: The name of the facet to use (required). + example: '@view.time_spent' + type: string + histogram: + $ref: '#/components/schemas/RUMGroupByHistogram' + limit: + default: 10 + description: The maximum buckets to return for this group-by. + format: int64 + type: integer + missing: + $ref: '#/components/schemas/RUMGroupByMissing' + sort: + $ref: '#/components/schemas/RUMAggregateSort' + total: + $ref: '#/components/schemas/RUMGroupByTotal' + required: + - facet + type: object + RUMGroupByHistogram: + 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.' + properties: + interval: + description: The bin size of the histogram buckets. + example: 10 + format: double + type: number + max: + description: 'The maximum value for the measure used in the histogram + + (values greater than this one are filtered out).' + example: 100 + format: double + type: number + min: + description: 'The minimum value for the measure used in the histogram + + (values smaller than this one are filtered out).' + example: 50 + format: double + type: number + required: + - interval + - min + - max + type: object + RUMGroupByMissing: + description: The value to use for logs that don't have the facet used to group + by. + oneOf: + - $ref: '#/components/schemas/RUMGroupByMissingString' + - $ref: '#/components/schemas/RUMGroupByMissingNumber' + RUMGroupByMissingNumber: + description: The missing value to use if there is a number valued facet. + format: double + type: number + RUMGroupByMissingString: + description: The missing value to use if there is string valued facet. + type: string + RUMGroupByTotal: + default: false + description: A resulting object to put the given computes in over all the matching + records. + oneOf: + - $ref: '#/components/schemas/RUMGroupByTotalBoolean' + - $ref: '#/components/schemas/RUMGroupByTotalString' + - $ref: '#/components/schemas/RUMGroupByTotalNumber' + RUMGroupByTotalBoolean: + description: If set to true, creates an additional bucket labeled "$facet_total". + type: boolean + RUMGroupByTotalNumber: + description: A number to use as the key value for the total bucket. + format: double + type: number + RUMGroupByTotalString: + description: A string to use as the key value for the total bucket. + type: string RUMQueryFilter: description: The search and filter query settings. properties: from: default: now-15m @@ -4698,10 +4980,20 @@ - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING + RUMSortOrder: + description: The order to use, ascending or descending. + enum: + - asc + - desc + example: asc + type: string + x-enum-varnames: + - ASCENDING + - DESCENDING RUMWarning: description: A warning message indicating something that went wrong with the query. properties: code: @@ -6011,14 +6303,14 @@ tags: description: An array of tags associated with the security signal. example: - security:attack - technique:T1110-brute-force - format: array items: description: The tag associated with the security signal. type: string + type: array timestamp: description: The timestamp of the security signal. example: '2019-01-02T09:42:36.320Z' format: date-time type: string @@ -6168,10 +6460,73 @@ data: $ref: '#/components/schemas/ServiceAccountCreateData' required: - data type: object + UsageAttributesObject: + description: Usage attributes data. + properties: + org_name: + description: The organization name. + type: string + product_family: + description: The product for which usage is being reported. + type: string + public_id: + description: The organization public ID. + type: string + timeseries: + description: List of usage data reported for each requested hour. + items: + $ref: '#/components/schemas/UsageTimeSeriesObject' + type: array + usage_type: + $ref: '#/components/schemas/HourlyUsageType' + type: object + UsageDataObject: + description: Usage data. + properties: + attributes: + $ref: '#/components/schemas/UsageAttributesObject' + id: + description: Unique ID of the response. + type: string + type: + $ref: '#/components/schemas/UsageTimeSeriesType' + type: object + UsageObservabilityPipelinesResponse: + description: Observability Pipelines usage response. + properties: + data: + description: Response containing Observability Pipelines usage. + items: + $ref: '#/components/schemas/UsageDataObject' + type: array + type: object + UsageTimeSeriesObject: + description: Usage timeseries data. + properties: + timestamp: + description: Datetime in ISO-8601 format, UTC. The hour for the usage. + format: date-time + type: string + value: + description: Contains the number measured for the given usage_type during + the hour. + format: int64 + nullable: true + type: integer + type: object + UsageTimeSeriesType: + default: usage_timeseries + description: Type of usage data. + enum: + - usage_timeseries + example: usage_timeseries + type: string + x-enum-varnames: + - USAGE_TIMESERIES User: description: User object returned by the API. properties: attributes: $ref: '#/components/schemas/UserAttributes' @@ -6464,12 +6819,12 @@ security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. 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, and manage SAML-to-role - mappings. + user_access_manage: Disable users, manage user roles, manage SAML-to-role + mappings, and configure logs restriction queries. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header @@ -6912,10 +7267,15 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a list of Audit Logs events tags: - Audit x-menu-order: 2 + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.after + limitParam: page[limit] + resultsPath: data x-undo: type: safe /api/v2/audit/events/search: post: description: 'List endpoint returns Audit Logs events that match an Audit search @@ -6951,10 +7311,15 @@ summary: Search Audit Logs events tags: - Audit x-codegen-request-body-name: body x-menu-order: 1 + x-pagination: + cursorParam: body.page.cursor + cursorPath: meta.page.after + limitParam: body.page.limit + resultsPath: data x-undo: type: safe /api/v2/authn_mappings: get: description: List all AuthN Mappings in the org. @@ -7543,10 +7908,27 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Add Items to a Dashboard List tags: - Dashboard Lists x-codegen-request-body-name: body + x-given: + dashboard_list_dashboard: + parameters: + - name: dashboard_list_id + source: dashboard_list.id + - name: body + value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ dashboard.id + }}\",\n \"type\": \"custom_timeboard\"\n }\n ]\n}" + step: the "dashboard_list" has the "dashboard" + dashboard_list_screenboard_dashboard: + parameters: + - name: dashboard_list_id + source: dashboard_list.id + - name: body + value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ screenboard_dashboard.id + }}\",\n \"type\": \"custom_screenboard\"\n }\n ]\n}" + step: the "dashboard_list" has the "screenboard_dashboard" x-menu-order: 2 x-undo: type: safe put: description: Update dashboards of an existing dashboard list. @@ -7631,10 +8013,14 @@ - AuthZ: - incident_read summary: Get a list of incidents tags: - Incidents + x-pagination: + limitParam: page[size] + pageOffsetParam: page[offset] + resultsPath: data x-undo: type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' @@ -8712,10 +9098,15 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a list of logs tags: - Logs x-menu-order: 3 + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.after + limitParam: page[limit] + resultsPath: data x-undo: type: safe /api/v2/logs/events/search: post: description: 'List endpoint returns logs that match a log search query. @@ -8759,10 +9150,15 @@ summary: Search logs tags: - Logs x-codegen-request-body-name: body x-menu-order: 2 + x-pagination: + cursorParam: body.page.cursor + cursorPath: meta.page.after + limitParam: body.page.limit + resultsPath: data x-undo: type: safe /api/v2/metrics: get: description: 'Returns all configured count/gauge/rate/distribution metric names @@ -9229,11 +9625,11 @@ parameters: - name: metric_name value: '"{{ unique_alnum }}"' - name: body value: "{\n \"data\": {\n \"attributes\": {\n \"tags\":[\"app\", - \"datacenter\", \"{{ unique_alnum }}\"],\n \"metric_type\":\"distribution\"\n + \"datacenter\", \"{{ unique_alnum }}\"],\n \"metric_type\":\"gauge\"\n \ },\n \"type\": \"manage_tags\",\n \"id\": \"{{ unique_alnum }}\"\n }\n}" step: there is a valid "metric_tag_configuration" in the system x-menu-order: 1 x-undo: @@ -9432,10 +9828,15 @@ - AuthZ: [] summary: Get all processes tags: - Processes x-menu-order: 1 + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.after + limitParam: page[limit] + resultsPath: data x-undo: type: safe /api/v2/roles: get: description: Returns all roles, including their names and their unique identifiers. @@ -10041,10 +10442,45 @@ \"{{ user.data.type }}\"\n }\n}" step: the "user" has the "role" x-menu-order: 10 x-undo: type: safe + /api/v2/rum/analytics/aggregate: + post: + description: The API endpoint to aggregate RUM events into buckets of computed + metrics and timeseries. + operationId: AggregateRUMEvents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RUMAggregateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMAnalyticsAggregateResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Aggregate RUM events + tags: + - RUM + x-codegen-request-body-name: body + x-menu-order: 3 + x-undo: + type: safe /api/v2/rum/events: get: description: 'List endpoint returns events that match a RUM search query. [Results are paginated][1]. @@ -10122,10 +10558,15 @@ - AuthZ: [] summary: Get a list of RUM events tags: - RUM x-menu-order: 2 + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.after + limitParam: page[limit] + resultsPath: data x-undo: type: safe /api/v2/rum/events/search: post: description: 'List endpoint returns RUM events that match a RUM search query. @@ -10141,11 +10582,11 @@ requestBody: content: application/json: schema: $ref: '#/components/schemas/RUMSearchEventsRequest' - required: false + required: true responses: '200': content: application/json: schema: @@ -10164,12 +10605,54 @@ summary: Search RUM events tags: - RUM x-codegen-request-body-name: body x-menu-order: 1 + x-pagination: + cursorParam: body.page.cursor + cursorPath: meta.page.after + limitParam: body.page.limit + resultsPath: data x-undo: type: safe + /api/v2/saml_configurations/idp_metadata: + post: + description: 'Endpoint for uploading IdP metadata for SAML setup. + + + Use this endpoint to upload or replace IdP metadata for SAML login configuration.' + operationId: UploadIdPMetadata + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/IdPMetadataFormData' + required: true + responses: + '200': + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Upload IdP metadata + tags: + - Organizations + x-codegen-request-body-name: body + x-menu-order: 1 + x-undo: + type: idempotent /api/v2/security/cloud_workload/policy/download: get: description: 'The download endpoint generates a Cloud Workload Security policy file from your currently active @@ -10787,10 +11270,15 @@ - security_monitoring_signals_read summary: Get a quick list of security signals tags: - Security Monitoring x-menu-order: 7 + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.after + limitParam: page[limit] + resultsPath: data x-undo: type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' @@ -10829,10 +11317,15 @@ summary: Get a list of security signals tags: - Security Monitoring x-codegen-request-body-name: body x-menu-order: 6 + x-pagination: + cursorParam: body.page.cursor + cursorPath: meta.page.after + limitParam: body.page.limit + resultsPath: data x-undo: type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' @@ -11506,10 +11999,69 @@ x-undo: type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/usage/observability_pipelines: + get: + description: Get hourly usage for Observability Pipelines. + operationId: GetUsageObservabilityPipelines + parameters: + - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` + for usage beginning at this hour.' + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` + for usage ending + + **before** this hour.' + in: query + name: end_hr + required: false + schema: + format: date-time + type: string + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/UsageObservabilityPipelinesResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + summary: Get hourly usage for Observability Pipelines + tags: + - Usage Metering + x-menu-order: 38 + x-undo: + type: safe /api/v2/user_invitations: post: description: Sends emails to one or more users inviting them to join the organization. operationId: SendInvitations requestBody: @@ -11985,11 +12537,11 @@ default: api description: The subdomain where the API is deployed. tags: - description: Search your Audit Logs events over HTTP. name: Audit -- description: '[AuthN Mappings API] (https://docs.datadoghq.com/account_management/authn_mapping/?tab=example) +- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example) is used to automatically map group of users to roles in Datadog using attributes sent from Identity Providers.' name: AuthN Mappings @@ -12046,13 +12598,19 @@ 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: Create, edit, and manage your organizations. Read more about [multi-org + accounts](https://docs.datadoghq.com/account_management/multi_organization). + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/account_management/multi_organization + name: Organizations - description: The processes API allows you to query processes data for your organization. name: Processes -- description: Search your RUM events over HTTP. +- description: Search or aggregate your RUM events over HTTP. name: RUM - description: 'The Roles API is used to create and manage Datadog roles, what [global permissions](https://docs.datadoghq.com/account_management/rbac/) @@ -12071,9 +12629,30 @@ signals.' name: Security Monitoring - description: Create, edit, and disable service accounts. name: Service Accounts +- description: 'The usage metering API allows you to get hourly, daily, and + + monthly usage across multiple facets of Datadog. + + This API is available to all Pro and Enterprise customers. + + Usage is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). + + + **Note**: Usage data is delayed by up to 72 hours from when it was incurred. + + It is retained for 15 months. + + + You can retrieve up to 24 hours of hourly usage data for multiple organizations, + + and up to two months of hourly usage data for a single organization in one request.' + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/account_management/billing/usage_details/ + name: Usage Metering - description: Create, edit, and disable users. externalDocs: url: https://docs.datadoghq.com/account_management/users name: Users x-group-parameters: true