.generator/schemas/v2/openapi.yaml in datadog_api_client-1.11.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.0.0

- old
+ new

@@ -288,10 +288,17 @@ name: service_account_id required: true schema: example: 00000000-0000-1234-0000-000000000000 type: string + SignalID: + description: The ID of the signal. + in: path + name: signal_id + required: true + schema: + type: string UserID: description: The ID of the user. in: path name: user_id required: true @@ -1501,10 +1508,344 @@ - CUSTOM_TIMEBOARD - CUSTOM_SCREENBOARD - INTEGRATION_SCREENBOARD - INTEGRATION_TIMEBOARD - HOST_TIMEBOARD + Event: + description: The metadata associated with a request. + properties: + id: + description: Event ID. + example: '6509751066204996294' + type: string + name: + description: The event name. + type: string + source_id: + description: Event source ID. + example: 36 + type: integer + type: + description: Event type. + example: error_tracking_alert + type: string + type: object + EventAttributes: + description: Object description of attributes from your event. + properties: + aggregation_key: + description: Aggregation key of the event. + type: string + date_happened: + description: 'POSIX timestamp of the event. Must be sent as an integer (no + quotation marks). + + Limited to events no older than 18 hours.' + format: int64 + type: integer + device_name: + description: A device name. + type: string + duration: + description: The duration between the triggering of the event and its recovery + in nanoseconds. + format: int64 + type: integer + event_object: + description: The event title. + example: Did you hear the news today? + type: string + evt: + $ref: '#/components/schemas/Event' + hostname: + description: 'Host name to associate with the event. + + Any tags associated with the host are also applied to this event.' + type: string + monitor: + $ref: '#/components/schemas/MonitorType' + monitor_groups: + description: List of groups referred to in the event. + items: + description: Group referred to in the event. + type: string + nullable: true + type: array + monitor_id: + description: ID of the monitor that triggered the event. When an event isn't + related to a monitor, this field is empty. + nullable: true + type: integer + priority: + $ref: '#/components/schemas/EventPriority' + related_event_id: + description: Related event ID. + type: integer + service: + description: Service that triggered the event. + example: datadog-api + type: string + source_type_name: + description: 'The type of event being posted. + + For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, + `git` or `bitbucket`. + + The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + type: string + sourcecategory: + description: Identifier for the source of the event, such as a monitor alert, + an externally-submitted event, or an integration. + type: string + status: + $ref: '#/components/schemas/EventStatusType' + tags: + description: A list of tags to apply to the event. + example: + - environment:test + items: + description: A tag. + type: string + type: array + timestamp: + description: POSIX timestamp of your event in milliseconds. + example: 1652274265000 + format: int64 + type: integer + title: + description: The event title. + example: Oh boy! + type: string + type: object + EventPriority: + description: The priority of the event's monitor. For example, `normal` or `low`. + enum: + - normal + - low + example: normal + nullable: true + type: string + x-enum-varnames: + - NORMAL + - LOW + EventResponse: + description: The object description of an event after being processed and stored + by Datadog. + properties: + attributes: + $ref: '#/components/schemas/EventResponseAttributes' + id: + description: the unique ID of the event. + example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: string + type: + $ref: '#/components/schemas/EventType' + type: object + EventResponseAttributes: + description: The object description of an event response attribute. + properties: + attributes: + $ref: '#/components/schemas/EventAttributes' + tags: + description: An array of tags associated with the event. + example: + - team:A + items: + description: The tag associated with the event. + type: string + type: array + timestamp: + description: The timestamp of the event. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + type: object + EventStatusType: + description: 'If an alert event is enabled, its status is one of the following: + + `failure`, `error`, `warning`, `info`, `success`, `user_update`, + + `recommendation`, or `snapshot`.' + enum: + - failure + - error + - warning + - info + - success + - user_update + - recommendation + - snapshot + example: info + type: string + x-enum-varnames: + - FAILURE + - ERROR + - WARNING + - INFO + - SUCCESS + - USER_UPDATE + - RECOMMENDATION + - SNAPSHOT + EventType: + default: event + description: Type of the event. + enum: + - event + example: event + type: string + x-enum-varnames: + - EVENT + EventsListRequest: + description: The object sent with the request to retrieve a list of events from + your organization. + properties: + filter: + $ref: '#/components/schemas/EventsQueryFilter' + options: + $ref: '#/components/schemas/EventsQueryOptions' + page: + $ref: '#/components/schemas/EventsRequestPage' + sort: + $ref: '#/components/schemas/EventsSort' + type: object + EventsListResponse: + description: The response object with all events matching the request and pagination + information. + properties: + data: + description: An array of events matching the request. + items: + $ref: '#/components/schemas/EventResponse' + type: array + links: + $ref: '#/components/schemas/EventsListResponseLinks' + meta: + $ref: '#/components/schemas/EventsResponseMetadata' + type: object + EventsListResponseLinks: + description: Links attributes. + properties: + next: + description: 'Link for the next set of results. Note that the request can + also be made using the + + POST endpoint.' + example: https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + EventsQueryFilter: + description: The search and filter query settings. + properties: + from: + default: now-15m + description: The minimum time for the requested events. Supports date math + and regular timestamps in milliseconds. + example: now-15m + type: string + query: + default: '*' + description: The search query following the event search syntax. + example: service:web* AND @http.status_code:[200 TO 299] + type: string + to: + default: now + description: The maximum time for the requested events. Supports date math + and regular timestamps in milliseconds. + example: now + type: string + type: object + EventsQueryOptions: + description: 'The global query options that are used. Either provide a timezone + or a time offset but not both, + + otherwise the query fails.' + properties: + timeOffset: + description: The time offset to apply to the query in seconds. + format: int64 + type: integer + timezone: + default: UTC + description: 'The timezone can be specified as an offset, for example: `UTC+03:00`.' + example: GMT + type: string + type: object + EventsRequestPage: + description: Pagination settings. + properties: + cursor: + description: The returned paging point to use to get the next results. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + limit: + default: 10 + description: The maximum number of logs in the response. + example: 25 + format: int32 + maximum: 1000 + type: integer + type: object + EventsResponseMetadata: + 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/EventsResponseMetadataPage' + request_id: + description: The identifier of the request. + example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + type: string + warnings: + description: 'A list of warnings (non-fatal errors) encountered. Partial + results might be returned if + + warnings are present in the response.' + items: + $ref: '#/components/schemas/EventsWarning' + type: array + type: object + EventsResponseMetadataPage: + description: Pagination attributes. + properties: + after: + description: 'The cursor to use to get the next results, if any. To make + the next request, use the same + + parameters with the addition of the `page[cursor]`.' + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + EventsSort: + description: The sort parameters when querying events. + enum: + - timestamp + - -timestamp + type: string + x-enum-varnames: + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING + EventsWarning: + description: A warning message indicating something is wrong with the query. + properties: + code: + description: A unique code for this type of warning. + example: unknown_index + type: string + detail: + description: A detailed explanation of this specific warning. + example: 'indexes: foo, bar' + type: string + title: + 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 FullAPIKey: description: Datadog API key. properties: attributes: $ref: '#/components/schemas/FullAPIKeyAttributes' @@ -1674,10 +2015,88 @@ example: payment type: string required: - message type: object + HourlyUsage: + description: Hourly usage for a product family for an org. + properties: + attributes: + $ref: '#/components/schemas/HourlyUsageAttributes' + id: + description: Unique ID of the response. + type: string + type: + $ref: '#/components/schemas/UsageTimeSeriesType' + type: object + HourlyUsageAttributes: + description: Attributes of hourly usage for a product family for an org for + a time period. + properties: + measurements: + description: List of the measured usage values for the product family for + the org for the time period. + items: + $ref: '#/components/schemas/HourlyUsageMeasurement' + type: array + 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 + region: + description: The region of the Datadog instance that the organization belongs + to. + type: string + timestamp: + description: Datetime in ISO-8601 format, UTC. The hour for the usage. + format: date-time + type: string + type: object + HourlyUsageMeasurement: + description: Usage amount for a given usage type. + properties: + usage_type: + description: Type of usage. + type: string + value: + description: Contains the number measured for the given usage_type during + the hour. + format: int64 + nullable: true + type: integer + type: object + HourlyUsageMetadata: + description: The object containing document metadata. + properties: + pagination: + $ref: '#/components/schemas/HourlyUsagePagination' + type: object + HourlyUsagePagination: + description: The metadata for the current pagination. + properties: + next_record_id: + description: The cursor to get the next results (if any). To make the next + request, use the same parameters and add `next_record_id`. + nullable: true + type: string + type: object + HourlyUsageResponse: + description: Hourly usage response. + properties: + data: + description: Response containing hourly usage. + items: + $ref: '#/components/schemas/HourlyUsage' + type: array + meta: + $ref: '#/components/schemas/HourlyUsageMetadata' + type: object HourlyUsageType: description: Usage type that is being measured. enum: - app_sec_host_count - observability_pipelines_bytes_processed @@ -4108,25 +4527,24 @@ example: metric_volumes type: string x-enum-varnames: - METRIC_VOLUMES MetricIntakeType: - description: The type of metric. + description: The type of metric. The available types are `0` (unspecified), + `1` (count), `2` (rate), and `3` (gauge). enum: - 0 - 1 - 2 - 3 - - 15 format: int32 type: integer x-enum-varnames: - UNSPECIFIED - COUNT - RATE - GAUGE - - UNSPECIFIED_LEGACY MetricMetadata: description: Metadata for the metric. properties: origin: $ref: '#/components/schemas/MetricOrigin' @@ -4165,10 +4583,13 @@ example: - metric: system.load.1 points: - timestamp: 1475317847 value: 0.7 + resources: + - name: dummyhost + type: host items: $ref: '#/components/schemas/MetricSeries' type: array required: - series @@ -4192,16 +4613,19 @@ format: double type: number type: object MetricResource: description: Metric resource. + example: + name: dummyhost + type: host properties: name: - description: The name of the metric. + description: The name of the resource. type: string type: - description: The type of metric. + description: The type of the resource. type: string type: object MetricSeries: description: 'A metric to submit to Datadog. @@ -4493,10 +4917,58 @@ items: $ref: '#/components/schemas/MetricsAndMetricTagConfigurations' type: array readOnly: true type: object + MonitorType: + description: Attributes from the monitor that triggered the event. + nullable: true + properties: + created_at: + description: The POSIX timestamp of the monitor's creation in nanoseconds. + example: 1646318692000 + type: integer + group_status: + description: Monitor group status used when there is no `result_groups`. + type: integer + groups: + description: Groups to which the monitor belongs. + items: + description: A group. + type: string + type: array + id: + description: The monitor ID. + type: integer + message: + description: The monitor message. + type: string + modified: + description: The monitor's last-modified timestamp. + type: integer + name: + description: The monitor name. + type: string + query: + description: The query that triggers the alert. + type: string + tags: + description: A list of tags attached to the monitor. + example: + - environment:test + items: + description: A tag. + type: string + type: array + templated_name: + description: The templated name of the monitor before resolving any template + variables. + type: string + type: + description: The monitor type. + type: string + type: object NullableRelationshipToUser: description: Relationship to user. properties: data: $ref: '#/components/schemas/NullableRelationshipToUserData' @@ -6583,10 +7055,17 @@ metric: description: 'The target field to aggregate over when using the sum or max aggregations.' type: string + metrics: + description: Group of target fields to aggregate over when using the new + value aggregations. + items: + description: Field. + type: string + type: array name: description: Name of the query. type: string query: description: Query to run on logs. @@ -6629,10 +7108,17 @@ metric: description: 'The target field to aggregate over when using the sum or max aggregations.' type: string + metrics: + description: Group of target fields to aggregate over when using the new + value aggregations. + items: + description: Field. + type: string + type: array name: description: Name of the query. type: string query: description: Query to run on logs. @@ -6804,10 +7290,53 @@ example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/SecurityMonitoringSignalType' type: object + SecurityMonitoringSignalArchiveComment: + description: Optional comment to display on archived signals. + type: string + SecurityMonitoringSignalArchiveReason: + description: Reason a signal is archived. + enum: + - none + - false_positive + - testing_or_maintenance + - other + type: string + x-enum-varnames: + - NONE + - FALSE_POSITIVE + - TESTING_OR_MAINTENANCE + - OTHER + SecurityMonitoringSignalAssigneeUpdateAttributes: + description: Attributes describing the new assignee of a security signal. + properties: + assignee: + $ref: '#/components/schemas/SecurityMonitoringTriageUser' + version: + $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + required: + - assignee + type: object + SecurityMonitoringSignalAssigneeUpdateData: + description: Data containing the patch for changing the assignee of a signal. + properties: + attributes: + $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes' + required: + - attributes + type: object + SecurityMonitoringSignalAssigneeUpdateRequest: + description: Request body for changing the assignee of a given security monitoring + signal. + properties: + data: + $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData' + required: + - data + type: object SecurityMonitoringSignalAttributes: description: 'The object containing all signal attributes and their associated values.' properties: @@ -6841,10 +7370,48 @@ description: The timestamp of the security signal. example: '2019-01-02T09:42:36.320Z' format: date-time type: string type: object + SecurityMonitoringSignalIncidentIds: + description: Array of incidents that are associated with this signal. + items: + description: Public ID attribute of the incident that is associated with the + signal. + example: 2066 + format: int64 + type: integer + type: array + SecurityMonitoringSignalIncidentsUpdateAttributes: + description: Attributes describing the new list of related signals for a security + signal. + properties: + incident_ids: + $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds' + version: + $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + required: + - incident_ids + type: object + SecurityMonitoringSignalIncidentsUpdateData: + description: Data containing the patch for changing the related incidents of + a signal. + properties: + attributes: + $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes' + required: + - attributes + type: object + SecurityMonitoringSignalIncidentsUpdateRequest: + description: Request body for changing the related incidents of a given security + monitoring signal. + properties: + data: + $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData' + required: + - data + type: object SecurityMonitoringSignalListRequest: description: The request for a security signal list. properties: filter: $ref: '#/components/schemas/SecurityMonitoringSignalListRequestFilter' @@ -6885,19 +7452,114 @@ example: 25 format: int32 maximum: 1000 type: integer type: object + SecurityMonitoringSignalState: + description: The new triage state of the signal. + enum: + - open + - archived + - under_review + type: string + x-enum-varnames: + - OPEN + - ARCHIVED + - UNDER_REVIEW + SecurityMonitoringSignalStateUpdateAttributes: + description: Attributes describing the change of state of a security signal. + properties: + archive_comment: + $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment' + archive_reason: + $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason' + state: + $ref: '#/components/schemas/SecurityMonitoringSignalState' + version: + $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + required: + - state + type: object + SecurityMonitoringSignalStateUpdateData: + description: Data containing the patch for changing the state of a signal. + properties: + attributes: + $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes' + required: + - attributes + type: object + SecurityMonitoringSignalStateUpdateRequest: + description: Request body for changing the state of a given security monitoring + signal. + properties: + data: + $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateData' + required: + - data + type: object + SecurityMonitoringSignalTriageAttributes: + description: Attributes describing a triage state update operation over a security + signal. + properties: + archive_comment: + $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment' + archive_comment_timestamp: + description: Timestamp of the last edit to the comment. + format: int64 + minimum: 0 + type: integer + archive_comment_user: + $ref: '#/components/schemas/SecurityMonitoringTriageUser' + archive_reason: + $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason' + assignee: + $ref: '#/components/schemas/SecurityMonitoringTriageUser' + incident_ids: + $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds' + state: + $ref: '#/components/schemas/SecurityMonitoringSignalState' + state_update_timestamp: + description: Timestamp of the last update to the signal state. + format: int64 + minimum: 0 + type: integer + state_update_user: + $ref: '#/components/schemas/SecurityMonitoringTriageUser' + required: + - assignee + - state + - incident_ids + type: object + SecurityMonitoringSignalTriageUpdateData: + description: Data containing the updated triage attributes of the signal. + properties: + attributes: + $ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes' + type: object + SecurityMonitoringSignalTriageUpdateResponse: + description: The response returned after all triage operations, containing the + updated signal triage data. + properties: + data: + $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateData' + required: + - data + type: object SecurityMonitoringSignalType: default: signal description: The type of event. enum: - signal example: signal type: string x-enum-varnames: - SIGNAL + SecurityMonitoringSignalVersion: + description: Version of the updated signal. If server side version is higher, + update will be rejected. + format: int64 + type: integer SecurityMonitoringSignalsListResponse: description: 'The response object with all security signals matching the request and pagination information.' properties: @@ -6946,10 +7608,30 @@ - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING + SecurityMonitoringTriageUser: + description: Object representing a given user entity. + properties: + handle: + description: The handle for this user account. + type: string + id: + description: Numerical ID assigned by Datadog to this user account. + format: int64 + type: integer + name: + description: The name for this user account. + type: string + uuid: + description: UUID assigned by Datadog to this user account. + example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 + type: string + required: + - uuid + type: object ServiceAccountCreateAttributes: description: Attributes of the created user. properties: email: description: The email of the user. @@ -7358,11 +8040,10 @@ 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_read: View monitors. - monitors_write: Edit, mute, and delete individual 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. security_monitoring_signals_read: View Security Signals. @@ -8519,10 +9200,137 @@ - Dashboard Lists x-codegen-request-body-name: body x-menu-order: 3 x-undo: type: safe + /api/v2/events: + get: + description: 'List endpoint returns events that match an events search query. + + [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). + + + Use this endpoint to see your latest events.' + operationId: ListEvents + parameters: + - description: Search query following events syntax. + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + in: query + name: filter[from] + required: false + schema: + type: string + - description: Maximum timestamp for requested events. + in: query + name: filter[to] + required: false + schema: + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: '#/components/schemas/EventsSort' + - description: List following results with a cursor provided in the previous + query. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventsListResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read + summary: Get a list of events + tags: + - Events + x-menu-order: 1 + 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 private beta. + + For access, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/events/search: + post: + description: 'List endpoint returns events that match an events search query. + + [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.' + operationId: SearchEvents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventsListRequest' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventsListResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Search events + tags: + - Events + 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 + x-unstable: '**Note**: This endpoint is in private beta. + + For access, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents: get: description: Get all incidents for the user's organization. operationId: ListIncidents parameters: @@ -10279,10 +11087,15 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: List tag configuration by name tags: - Metrics x-menu-order: 2 x-undo: @@ -12083,20 +12896,173 @@ cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-undo: type: safe + /api/v2/security_monitoring/signals/{signal_id}/assignee: + patch: + description: Modify the triage assignee of a security signal. + operationId: EditSecurityMonitoringSignalAssignee + parameters: + - $ref: '#/components/parameters/SignalID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest' + description: Attributes describing the signal update. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + 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 + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Not Found + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_write + summary: Modify the triage assignee of a security signal + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-undo: + type: idempotent + /api/v2/security_monitoring/signals/{signal_id}/incidents: + patch: + description: Change the related incidents for a security signal. + operationId: EditSecurityMonitoringSignalIncidents + parameters: + - $ref: '#/components/parameters/SignalID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest' + description: Attributes describing the signal update. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + 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 + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Not Found + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_write + summary: Change the related incidents of a security signal + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-undo: + type: idempotent + /api/v2/security_monitoring/signals/{signal_id}/state: + patch: + description: Change the triage state of a security signal. + operationId: EditSecurityMonitoringSignalState + parameters: + - $ref: '#/components/parameters/SignalID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateRequest' + description: Attributes describing the signal update. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + 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 + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Not Found + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_write + summary: Change the triage state of a security signal + tags: + - Security Monitoring + x-codegen-request-body-name: body + x-undo: + type: idempotent /api/v2/series: post: description: "The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).\n\nIf you\u2019re submitting metrics directly to the Datadog API without using DogStatsD, expect:\n\n- 64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric names\n- 50 bytes for the timeseries\n- The full payload is approximately - 100 bytes." + 100 bytes.\n\nHost name is one of the resources in the Resources field." operationId: SubmitMetrics parameters: - description: HTTP header used to compress the media-type. in: header name: Content-Encoding @@ -12831,11 +13797,14 @@ 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/application_security: get: - description: Get hourly usage for Application Security . + description: 'Get hourly usage for application security . + + **Note:** hourly usage data for all products is now available in the [Get + hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)' operationId: GetUsageApplicationSecurityMonitoring parameters: - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.' in: query @@ -12882,14 +13851,14 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - usage_read - summary: Get hourly usage for Application Security + summary: Get hourly usage for application security tags: - Usage Metering - x-menu-order: 38 + x-menu-order: 37 x-undo: type: safe /api/v2/usage/cost_by_org: get: description: Get cost across multi-org account. Cost by org data for a given @@ -12943,21 +13912,32 @@ - AuthZ: - usage_read summary: Get cost across multi-org account tags: - Usage Metering - x-menu-order: 39 + x-menu-order: 5 x-undo: type: safe - /api/v2/usage/estimated_cost_by_org: + /api/v2/usage/estimated_cost: get: - description: Get estimated cost across multi-org account. + description: 'Get estimated cost across multi-org and single root-org accounts. + + Estimated cost data is only available for the current month and previous month. + To access historical costs prior to this, use the /cost_by_org endpoint.' operationId: GetEstimatedCostByOrg parameters: + - description: String to specify whether cost is broken down at a parent-org + level or at the sub-org level. Currently, only the 'sub-org' view is supported. + in: query + name: view + required: true + schema: + type: string - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. Either start_month or start_date should be - specified, but not both.' + specified, but not both. (start_month cannot go beyond two months in the + past)' in: query name: start_month required: false schema: format: date-time @@ -12970,11 +13950,12 @@ schema: format: date-time type: string - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. Either start_month or start_date should be - specified, but not both.' + specified, but not both. (start_date cannot go beyond two months in the + past)' in: query name: start_date required: false schema: format: date-time @@ -13015,19 +13996,140 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - usage_read - summary: Get estimated cost across multi-org account + summary: Get estimated cost across your account tags: - Usage Metering x-menu-order: 39 x-undo: type: safe + x-unstable: '**Note**: This endpoint is in public beta. + + Only the sub-org view is available currently, the summary view will be released + at a later date.' + /api/v2/usage/hourly_usage: + get: + description: Get hourly usage by product family + operationId: GetHourlyUsage + parameters: + - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] + for usage beginning at this hour.' + in: query + name: filter[timestamp][start] + 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: filter[timestamp][end] + required: false + schema: + format: date-time + type: string + - description: 'Comma separated list of product families to retrieve. Available + families are `all`, `analyzed_logs`, + + `application_security`, `audit_logs`, `serverless`, `ci_app`, `cspm`, `custom_events`, + `cws`, `dbm`, `fargate`, + + `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, + `iot`, + + `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`, + + `online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, + `sds`, `snmp`, + + `synthetics_api`, `synthetics_browser`, and `timeseries`.' + in: query + name: filter[product_families] + required: true + schema: + type: string + - description: Include child org usage in the response. Defaults to false. + in: query + name: filter[include_descendants] + required: false + schema: + default: false + type: boolean + - description: 'Comma separated list of product family versions to use in the + format `product_family:version`. For example, + + `infra_hosts:1.0.0`. If this parameter is not used, the API will use the + latest version of each requested + + product family. Currently all families have one version `1.0.0`.' + in: query + name: filter[versions] + required: false + schema: + type: string + - description: Maximum number of results to return (between 1 and 500) - defaults + to 500 if limit not specified. + in: query + name: page[limit] + required: false + schema: + default: 500 + format: int32 + maximum: 500 + minimum: 1 + type: integer + - description: List following results with a next_record_id provided in the + previous query. + in: query + name: page[next_record_id] + required: false + schema: + type: string + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/HourlyUsageResponse' + 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 by product family + tags: + - Usage Metering + x-menu-order: 1 + x-undo: + type: safe /api/v2/usage/lambda_traced_invocations: get: - description: Get hourly usage for Lambda Traced Invocations. + description: 'Get hourly usage for lambda traced invocations. + + **Note:** hourly usage data for all products is now available in the [Get + hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)' operationId: GetUsageLambdaTracedInvocations parameters: - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.' in: query @@ -13074,19 +14176,22 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - usage_read - summary: Get hourly usage for Lambda Traced Invocations + summary: Get hourly usage for lambda traced invocations tags: - Usage Metering - x-menu-order: 38 + x-menu-order: 36 x-undo: type: safe /api/v2/usage/observability_pipelines: get: - description: Get hourly usage for Observability Pipelines. + description: 'Get hourly usage for observability pipelines. + + **Note:** hourly usage data for all products is now available in the [Get + hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)' operationId: GetUsageObservabilityPipelines parameters: - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.' in: query @@ -13133,11 +14238,11 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - usage_read - summary: Get hourly usage for Observability Pipelines + summary: Get hourly usage for observability pipelines tags: - Usage Metering x-menu-order: 38 x-undo: type: safe @@ -13633,9 +14738,19 @@ organize, find, and share all of your dashboards with your team and organization.' name: Dashboard Lists +- description: 'The events service allows you to programmatically post events to the + event stream + + and fetch events from the event stream. Events are limited to 4000 characters. + + If an event is sent out with a message containing more than 4000 characters, only + the + + first 4000 characters are displayed.' + name: Events - description: Create, update, delete, and retrieve services which can be associated with incidents. name: Incident Services - description: Create, update, delete and retrieve teams which can be associated with incidents.