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

- old
+ new

@@ -253,11 +253,11 @@ default: 10 example: 10 format: int64 type: integer RoleID: - description: The ID of the role. + description: The unique identifier of the role. in: path name: role_id required: true schema: type: string @@ -622,10 +622,227 @@ - application_keys example: application_keys type: string x-enum-varnames: - APPLICATION_KEYS + AuditLogsEvent: + description: Object description of an Audit Logs event after it is processed + and stored by Datadog. + properties: + attributes: + $ref: '#/components/schemas/AuditLogsEventAttributes' + id: + description: Unique ID of the event. + example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: string + type: + $ref: '#/components/schemas/AuditLogsEventType' + type: object + AuditLogsEventAttributes: + description: JSON object containing all event attributes and their associated + values. + properties: + attributes: + additionalProperties: {} + description: JSON object of attributes from Audit Logs events. + example: + customAttribute: 123 + duration: 2345 + type: object + service: + description: 'Name of the application or service generating Audit Logs events. + + This name is used to correlate Audit Logs to APM, so make sure you specify + the same + + value when you use both products.' + example: web-app + type: string + tags: + description: Array of tags associated with your event. + example: + - team:A + items: + description: Tag associated with your event. + type: string + type: array + timestamp: + description: Timestamp of your event. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + type: object + AuditLogsEventType: + default: audit + description: Type of the event. + enum: + - audit + example: audit + type: string + x-enum-varnames: + - Audit + AuditLogsEventsResponse: + description: Response object with all events matching the request and pagination + information. + properties: + data: + description: Array of events matching the request. + items: + $ref: '#/components/schemas/AuditLogsEvent' + type: array + links: + $ref: '#/components/schemas/AuditLogsResponseLinks' + meta: + $ref: '#/components/schemas/AuditLogsResponseMetadata' + type: object + AuditLogsQueryFilter: + description: Search and filter query settings. + properties: + from: + default: now-15m + description: Minimum time for the requested events. Supports date, math, + and regular timestamps (in milliseconds). + example: now-15m + type: string + query: + default: '*' + description: Search query following the Audit Logs search syntax. + example: '@type:session AND @session.type:user' + type: string + to: + default: now + description: Maximum time for the requested events. Supports date, math, + and regular timestamps (in milliseconds). + example: now + type: string + type: object + AuditLogsQueryOptions: + description: 'Global query options that are used during the query. + + Note: Specify either timezone or time offset, not both. Otherwise, the query + fails.' + properties: + time_offset: + description: Time offset (in seconds) to apply to the query. + format: int64 + type: integer + timezone: + default: UTC + description: 'Timezone code. Can be specified as an offset, for example: + "UTC+03:00".' + example: GMT + type: string + type: object + AuditLogsQueryPageOptions: + description: Paging attributes for listing events. + properties: + cursor: + description: List following results with a cursor provided in the previous + query. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + limit: + default: 10 + description: Maximum number of events in the response. + example: 25 + format: int32 + maximum: 1000 + type: integer + type: object + AuditLogsResponseLinks: + 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/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + AuditLogsResponseMetadata: + description: The metadata associated with a request. + properties: + elapsed: + description: Time elapsed in milliseconds. + example: 132 + format: int64 + type: integer + page: + $ref: '#/components/schemas/AuditLogsResponsePage' + request_id: + description: The identifier of the request. + example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + type: string + status: + $ref: '#/components/schemas/AuditLogsResponseStatus' + 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/AuditLogsWarning' + type: array + type: object + AuditLogsResponsePage: + description: Paging attributes. + properties: + after: + description: The cursor to use to get the next results, if any. To make + the next request, use the same parameters with the addition of `page[cursor]`. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + AuditLogsResponseStatus: + description: The status of the response. + enum: + - done + - timeout + example: done + type: string + x-enum-varnames: + - DONE + - TIMEOUT + AuditLogsSearchEventsRequest: + description: The request for a Audit Logs events list. + properties: + filter: + $ref: '#/components/schemas/AuditLogsQueryFilter' + options: + $ref: '#/components/schemas/AuditLogsQueryOptions' + page: + $ref: '#/components/schemas/AuditLogsQueryPageOptions' + sort: + $ref: '#/components/schemas/AuditLogsSort' + type: object + AuditLogsSort: + description: Sort parameters when querying events. + enum: + - timestamp + - -timestamp + type: string + x-enum-varnames: + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING + AuditLogsWarning: + description: Warning message indicating something that went wrong with the query. + properties: + code: + description: Unique code for this type of warning. + example: unknown_index + type: string + detail: + description: Detailed explanation of this specific warning. + example: 'indexes: foo, bar' + type: string + title: + description: 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 AuthNMapping: description: The AuthN Mapping object returned by API. properties: attributes: $ref: '#/components/schemas/AuthNMappingAttributes' @@ -1429,14 +1646,14 @@ type: object IncidentCreateRelationships: description: The relationships the incident will have with other resources once created. properties: - commander: - $ref: '#/components/schemas/RelationshipToUser' + commander_user: + $ref: '#/components/schemas/NullableRelationshipToUser' required: - - commander + - commander_user type: object IncidentCreateRequest: description: Create request for an incident. properties: data: @@ -1716,11 +1933,11 @@ type: object IncidentResponseRelationships: description: The incident's relationships from a response. properties: commander_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: '#/components/schemas/NullableRelationshipToUser' created_by_user: $ref: '#/components/schemas/RelationshipToUser' integrations: $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' last_modified_by_user: @@ -2063,28 +2280,30 @@ description: Timeline cell data for Markdown timeline cells for a create request. properties: cell_type: $ref: '#/components/schemas/IncidentTimelineCellMarkdownContentType' content: - description: The Markdown timeline cell contents. - properties: - content: - description: The Markdown content of the cell. - example: An example timeline cell message. - nullable: false - type: string - type: object + $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributesContent' important: default: false description: A flag indicating whether the timeline cell is important and should be highlighted. example: false type: boolean required: - content - cell_type type: object + IncidentTimelineCellMarkdownCreateAttributesContent: + description: The Markdown timeline cell contents. + properties: + content: + description: The Markdown content of the cell. + example: An example timeline cell message. + nullable: false + type: string + type: object IncidentType: default: incidents description: Incident resource type. enum: - incidents @@ -2163,17 +2382,13 @@ type: object IncidentUpdateRelationships: description: The incident's relationships for an update request. properties: commander_user: - $ref: '#/components/schemas/RelationshipToUser' - created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: '#/components/schemas/NullableRelationshipToUser' integrations: $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' - last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' postmortem: $ref: '#/components/schemas/RelationshipToIncidentPostmortem' type: object IncidentUpdateRequest: description: Update request for an incident. @@ -2308,69 +2523,70 @@ Log: description: Object description of a log after being processed and stored by Datadog. properties: attributes: - description: JSON object containing all log attributes and their associated - values. - properties: - attributes: - additionalProperties: {} - description: JSON object of attributes from your log. - example: - customAttribute: 123 - duration: 2345 - type: object - host: - description: Name of the machine from where the logs are being sent. - example: i-0123 - type: string - message: - description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) - - of your log. By default, Datadog ingests the value of the message - attribute as the body of the log entry. - - That value is then highlighted and displayed in the Logstream, where - it is indexed for full text search.' - example: Host connected to remote - type: string - service: - description: 'The name of the application or service generating the - log events. - - It is used to switch from Logs to APM, so make sure you define the - same - - value when you use both products.' - example: agent - type: string - status: - description: Status of the message associated with your log. - example: INFO - type: string - tags: - description: Array of tags associated with your log. - example: - - team:A - items: - description: Tag associated with your log. - type: string - type: array - timestamp: - description: Timestamp of your log. - example: '2019-01-02T09:42:36.320Z' - format: date-time - type: string - type: object + $ref: '#/components/schemas/LogAttributes' id: description: Unique ID of the Log. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/LogType' type: object + LogAttributes: + description: JSON object containing all log attributes and their associated + values. + properties: + attributes: + additionalProperties: {} + description: JSON object of attributes from your log. + example: + customAttribute: 123 + duration: 2345 + type: object + host: + description: Name of the machine from where the logs are being sent. + example: i-0123 + type: string + message: + description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) + + of your log. By default, Datadog ingests the value of the message attribute + as the body of the log entry. + + That value is then highlighted and displayed in the Logstream, where it + is indexed for full text search.' + example: Host connected to remote + type: string + service: + description: 'The name of the application or service generating the log + events. + + It is used to switch from Logs to APM, so make sure you define the same + + value when you use both products.' + example: agent + type: string + status: + description: Status of the message associated with your log. + example: INFO + type: string + tags: + description: Array of tags associated with your log. + example: + - team:A + items: + description: Tag associated with your log. + type: string + type: array + timestamp: + description: Timestamp of your log. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + type: object LogType: default: log description: Type of the event. enum: - log @@ -2447,33 +2663,37 @@ $ref: '#/components/schemas/LogsGroupBy' type: array options: $ref: '#/components/schemas/LogsQueryOptions' page: - description: Paging settings - properties: - cursor: - description: The returned paging point to use to get the next results - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - type: object + $ref: '#/components/schemas/LogsAggregateRequestPage' type: object + LogsAggregateRequestPage: + description: Paging settings + properties: + cursor: + description: The returned paging point to use to get the next results + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object LogsAggregateResponse: description: The response object for the logs aggregate API endpoint properties: data: - description: The query results - properties: - buckets: - description: The list of matching buckets, one item per bucket - items: - $ref: '#/components/schemas/LogsAggregateBucket' - type: array - type: object + $ref: '#/components/schemas/LogsAggregateResponseData' meta: $ref: '#/components/schemas/LogsResponseMetadata' type: object + LogsAggregateResponseData: + description: The query results + properties: + buckets: + description: The list of matching buckets, one item per bucket + items: + $ref: '#/components/schemas/LogsAggregateBucket' + type: array + type: object LogsAggregateResponseStatus: description: The status of the response enum: - done - timeout @@ -2917,40 +3137,11 @@ facet: description: The name of the facet to use (required) example: host type: string histogram: - 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 + $ref: '#/components/schemas/LogsGroupByHistogram' limit: default: 10 description: The maximum buckets to return for this group by format: int64 type: integer @@ -2961,10 +3152,39 @@ total: $ref: '#/components/schemas/LogsGroupByTotal' required: - facet type: object + LogsGroupByHistogram: + description: 'Used to perform a histogram computation (only for measure facets). + + Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.' + 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 LogsGroupByMissing: description: The value to use for logs that don't have the facet used to group by oneOf: - $ref: '#/components/schemas/LogsGroupByMissingString' @@ -3000,51 +3220,55 @@ filter: $ref: '#/components/schemas/LogsQueryFilter' options: $ref: '#/components/schemas/LogsQueryOptions' page: - description: Paging attributes for listing logs. - properties: - cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - limit: - default: 10 - description: Maximum number of logs in the response. - example: 25 - format: int32 - maximum: 1000 - type: integer - type: object + $ref: '#/components/schemas/LogsListRequestPage' sort: $ref: '#/components/schemas/LogsSort' type: object + LogsListRequestPage: + description: Paging attributes for listing logs. + properties: + cursor: + description: List following results with a cursor provided in the previous + query. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + limit: + default: 10 + description: Maximum number of logs in the response. + example: 25 + format: int32 + maximum: 1000 + type: integer + type: object LogsListResponse: description: Response object with all logs matching the request and pagination information. properties: data: description: Array of logs matching the request. items: $ref: '#/components/schemas/Log' type: array links: - 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/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - type: object + $ref: '#/components/schemas/LogsListResponseLinks' meta: $ref: '#/components/schemas/LogsResponseMetadata' type: object + LogsListResponseLinks: + 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/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object LogsMetricCompute: description: The compute rule to compute the log-based metric. properties: aggregation_type: $ref: '#/components/schemas/LogsMetricComputeAggregationType' @@ -3311,20 +3535,11 @@ description: The time elapsed in milliseconds example: 132 format: int64 type: integer page: - description: Paging attributes. - properties: - after: - description: 'The cursor to use to get the next results, if any. To - make the next request, use the same. - - parameters with the addition of the `page[cursor]`.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - type: object + $ref: '#/components/schemas/LogsResponseMetadataPage' request_id: description: The identifier of the request example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: @@ -3336,10 +3551,21 @@ warnings are present in the response.' items: $ref: '#/components/schemas/LogsWarning' type: array type: object + LogsResponseMetadataPage: + description: Paging attributes. + properties: + after: + description: 'The cursor to use to get the next results, if any. To make + the next request, use the same. + + parameters with the addition of the `page[cursor]`.' + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object LogsSort: description: Sort parameters when querying logs. enum: - timestamp - -timestamp @@ -3936,10 +4162,32 @@ items: $ref: '#/components/schemas/MetricsAndMetricTagConfigurations' type: array readOnly: true type: object + NullableRelationshipToUser: + description: Relationship to user. + properties: + data: + $ref: '#/components/schemas/NullableRelationshipToUserData' + required: + - data + type: object + NullableRelationshipToUserData: + description: Relationship to user object. + nullable: true + properties: + id: + description: A unique identifier that represents the user. + example: 00000000-0000-0000-0000-000000000000 + type: string + type: + $ref: '#/components/schemas/UsersType' + required: + - id + - type + type: object Organization: description: Organization object. properties: attributes: $ref: '#/components/schemas/OrganizationAttributes' @@ -4158,26 +4406,28 @@ - PERMISSIONS ProcessSummariesMeta: description: Response metadata object. properties: page: - description: Paging attributes. - properties: - after: - description: 'The cursor used to get the next results, if any. To make - the next request, use the same + $ref: '#/components/schemas/ProcessSummariesMetaPage' + type: object + ProcessSummariesMetaPage: + description: Paging attributes. + properties: + after: + description: 'The cursor used to get the next results, if any. To make the + next request, use the same - parameters with the addition of the `page[cursor]`.' - example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd - type: string - size: - description: Number of results returned. - format: int32 - maximum: 10000 - minimum: 0 - type: integer - type: object + parameters with the addition of the `page[cursor]`.' + example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd + type: string + size: + description: Number of results returned. + format: int32 + maximum: 10000 + minimum: 0 + type: integer type: object ProcessSummariesResponse: description: List of process summaries. properties: data: @@ -4249,10 +4499,227 @@ - desc type: string x-enum-varnames: - ASC - DESC + RUMEvent: + description: Object description of a RUM event after being processed and stored + by Datadog. + properties: + attributes: + $ref: '#/components/schemas/RUMEventAttributes' + id: + description: Unique ID of the event. + example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: string + type: + $ref: '#/components/schemas/RUMEventType' + type: object + RUMEventAttributes: + description: JSON object containing all event attributes and their associated + values. + properties: + attributes: + additionalProperties: {} + description: JSON object of attributes from RUM events. + example: + customAttribute: 123 + duration: 2345 + type: object + service: + description: 'The name of the application or service generating RUM events. + + It is used to switch from RUM to APM, so make sure you define the same + + value when you use both products.' + example: web-app + type: string + tags: + description: Array of tags associated with your event. + example: + - team:A + items: + description: Tag associated with your event. + type: string + type: array + timestamp: + description: Timestamp of your event. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + type: object + RUMEventType: + default: rum + description: Type of the event. + enum: + - rum + example: rum + type: string + x-enum-varnames: + - RUM + RUMEventsResponse: + description: Response object with all events matching the request and pagination + information. + properties: + data: + description: Array of events matching the request. + items: + $ref: '#/components/schemas/RUMEvent' + type: array + links: + $ref: '#/components/schemas/RUMResponseLinks' + meta: + $ref: '#/components/schemas/RUMResponseMetadata' + type: object + RUMQueryFilter: + 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 RUM search syntax. + example: '@type:session AND @session.type:user' + 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 + RUMQueryOptions: + description: 'Global query options that are used during the query. + + Note: Only supply timezone or time offset, not both. Otherwise, the query + fails.' + properties: + time_offset: + description: The time offset (in seconds) to apply to the query. + format: int64 + type: integer + timezone: + default: UTC + description: 'The timezone can be specified both as an offset, for example: + "UTC+03:00".' + example: GMT + type: string + type: object + RUMQueryPageOptions: + description: Paging attributes for listing events. + properties: + cursor: + description: List following results with a cursor provided in the previous + query. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + limit: + default: 10 + description: Maximum number of events in the response. + example: 25 + format: int32 + maximum: 1000 + type: integer + type: object + RUMResponseLinks: + 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/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + RUMResponseMetadata: + 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/RUMResponsePage' + request_id: + description: The identifier of the request. + example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + type: string + status: + $ref: '#/components/schemas/RUMResponseStatus' + 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/RUMWarning' + type: array + type: object + RUMResponsePage: + description: Paging attributes. + properties: + after: + description: The cursor to use to get the next results, if any. To make + the next request, use the same parameters with the addition of `page[cursor]`. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + type: object + RUMResponseStatus: + description: The status of the response. + enum: + - done + - timeout + example: done + type: string + x-enum-varnames: + - DONE + - TIMEOUT + RUMSearchEventsRequest: + description: The request for a RUM events list. + properties: + filter: + $ref: '#/components/schemas/RUMQueryFilter' + options: + $ref: '#/components/schemas/RUMQueryOptions' + page: + $ref: '#/components/schemas/RUMQueryPageOptions' + sort: + $ref: '#/components/schemas/RUMSort' + type: object + RUMSort: + description: Sort parameters when querying events. + enum: + - timestamp + - -timestamp + type: string + x-enum-varnames: + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING + RUMWarning: + description: A warning message indicating something that went 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 RelationshipToIncidentIntegrationMetadataData: description: A relationship reference for an integration metadata object. example: id: 00000000-abcd-0002-0000-000000000000 type: incident_integrations @@ -4382,21 +4849,21 @@ type: object RelationshipToRoleData: description: Relationship to role object. properties: id: - description: ID of the role. + description: The unique identifier of the role. example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d type: string type: $ref: '#/components/schemas/RolesType' type: object RelationshipToRoles: description: Relationship to roles. properties: data: - description: An array containing type and ID of a role. + description: An array containing type and the unique identifier of a role. items: $ref: '#/components/schemas/RelationshipToRoleData' type: array type: object RelationshipToSAMLAssertionAttribute: @@ -4465,11 +4932,11 @@ description: Role object returned by the API. properties: attributes: $ref: '#/components/schemas/RoleAttributes' id: - description: ID of the role. + description: The unique identifier of the role. type: string relationships: $ref: '#/components/schemas/RoleResponseRelationships' type: $ref: '#/components/schemas/RolesType' @@ -4488,11 +4955,12 @@ description: Time of last role modification. format: date-time readOnly: true type: string name: - description: Name of the role. + description: The name of the role. The name is neither unique nor a stable + identifier of the role. type: string user_count: description: Number of users with that role. format: int64 readOnly: true @@ -4570,25 +5038,27 @@ type: object RoleCreateResponse: description: Response containing information about a created role. properties: data: - description: Role object returned by the API. - properties: - attributes: - $ref: '#/components/schemas/RoleCreateAttributes' - id: - description: ID of the role. - type: string - relationships: - $ref: '#/components/schemas/RoleResponseRelationships' - type: - $ref: '#/components/schemas/RolesType' - required: - - type - type: object + $ref: '#/components/schemas/RoleCreateResponseData' type: object + RoleCreateResponseData: + description: Role object returned by the API. + properties: + attributes: + $ref: '#/components/schemas/RoleCreateAttributes' + id: + description: The unique identifier of the role. + type: string + relationships: + $ref: '#/components/schemas/RoleResponseRelationships' + type: + $ref: '#/components/schemas/RolesType' + required: + - type + type: object RoleRelationships: description: Relationships of the role object. properties: permissions: $ref: '#/components/schemas/RelationshipToPermissions' @@ -4628,11 +5098,11 @@ description: Data related to the update of a role. properties: attributes: $ref: '#/components/schemas/RoleUpdateAttributes' id: - description: ID of the role. + description: The unique identifier of the role. example: 00000000-0000-1111-0000-000000000000 type: string type: $ref: '#/components/schemas/RolesType' required: @@ -4650,25 +5120,27 @@ type: object RoleUpdateResponse: description: Response containing information about an updated role. properties: data: - description: Role object returned by the API. - properties: - attributes: - $ref: '#/components/schemas/RoleUpdateAttributes' - id: - description: ID of the role. - type: string - relationships: - $ref: '#/components/schemas/RoleResponseRelationships' - type: - $ref: '#/components/schemas/RolesType' - required: - - type - type: object + $ref: '#/components/schemas/RoleUpdateResponseData' type: object + RoleUpdateResponseData: + description: Role object returned by the API. + properties: + attributes: + $ref: '#/components/schemas/RoleUpdateAttributes' + id: + description: The unique identifier of the role. + type: string + relationships: + $ref: '#/components/schemas/RoleResponseRelationships' + type: + $ref: '#/components/schemas/RolesType' + required: + - type + type: object RolesResponse: description: Response containing information about multiple roles. properties: data: description: Array of returned roles. @@ -5106,15 +5578,17 @@ description: The detection method. enum: - threshold - new_value - anomaly_detection + - impossible_travel type: string x-enum-varnames: - THRESHOLD - NEW_VALUE - ANOMALY_DETECTION + - IMPOSSIBLE_TRAVEL SecurityMonitoringRuleEvaluationWindow: description: 'A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time.' @@ -5136,10 +5610,24 @@ - TEN_MINUTES - FIFTEEN_MINUTES - THIRTY_MINUTES - ONE_HOUR - TWO_HOURS + SecurityMonitoringRuleImpossibleTravelOptions: + description: Options on impossible travel rules. + properties: + baselineUserLocations: + $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations' + type: object + SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations: + description: 'If true, signals are suppressed for the first 24 hours. In that + time, Datadog learns the user''s regular + + access locations. This can be helpful to reduce noise and infer VPN usage + or credentialed API access.' + example: true + type: boolean SecurityMonitoringRuleKeepAlive: description: "Once a signal is generated, the signal will remain \u201Copen\u201D if a case is matched at least once within\nthis keep alive window." enum: - 0 @@ -5244,10 +5732,12 @@ properties: detectionMethod: $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' evaluationWindow: $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' + impossibleTravelOptions: + $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions' keepAlive: $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive' maxSignalDuration: $ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration' newValueOptions: @@ -5288,17 +5778,19 @@ - count - cardinality - sum - max - new_value + - geo_data type: string x-enum-varnames: - COUNT - CARDINALITY - SUM - MAX - NEW_VALUE + - GEO_DATA SecurityMonitoringRuleQueryCreate: description: Query for matching rule. properties: aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' @@ -5484,93 +5976,99 @@ type: object SecurityMonitoringSignal: description: Object description of a security signal. properties: attributes: - description: 'The object containing all signal attributes and their - - associated values.' - properties: - attributes: - additionalProperties: {} - description: A JSON object of attributes in the security signal. - example: - workflow: - first_seen: '2020-06-23T14:46:01.000Z' - last_seen: '2020-06-23T14:46:49.000Z' - rule: - id: 0f5-e0c-805 - name: 'Brute Force Attack Grouped By User ' - version: 12 - type: object - message: - description: The message in the security signal defined by the rule - that generated the signal. - example: Detect Account Take Over (ATO) through brute force attempts - type: string - 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 - timestamp: - description: The timestamp of the security signal. - example: '2019-01-02T09:42:36.320Z' - format: date-time - type: string - type: object + $ref: '#/components/schemas/SecurityMonitoringSignalAttributes' id: description: The unique ID of the security signal. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/SecurityMonitoringSignalType' type: object + SecurityMonitoringSignalAttributes: + description: 'The object containing all signal attributes and their + + associated values.' + properties: + attributes: + additionalProperties: {} + description: A JSON object of attributes in the security signal. + example: + workflow: + first_seen: '2020-06-23T14:46:01.000Z' + last_seen: '2020-06-23T14:46:49.000Z' + rule: + id: 0f5-e0c-805 + name: 'Brute Force Attack Grouped By User ' + version: 12 + type: object + message: + description: The message in the security signal defined by the rule that + generated the signal. + example: Detect Account Take Over (ATO) through brute force attempts + type: string + 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 + timestamp: + description: The timestamp of the security signal. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + type: object SecurityMonitoringSignalListRequest: description: The request for a security signal list. properties: filter: - description: Search filters for listing security signals. - properties: - from: - description: The minimum timestamp for requested security signals. - example: '2019-01-02T09:42:36.320Z' - format: date-time - type: string - query: - description: Search query for listing security signals. - example: security:attack status:high - type: string - to: - description: The maximum timestamp for requested security signals. - example: '2019-01-03T09:42:36.320Z' - format: date-time - type: string - type: object + $ref: '#/components/schemas/SecurityMonitoringSignalListRequestFilter' page: - description: The paging attributes for listing security signals. - properties: - cursor: - description: A list of results using the cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - limit: - default: 10 - description: The maximum number of security signals in the response. - example: 25 - format: int32 - maximum: 1000 - type: integer - type: object + $ref: '#/components/schemas/SecurityMonitoringSignalListRequestPage' sort: $ref: '#/components/schemas/SecurityMonitoringSignalsSort' type: object + SecurityMonitoringSignalListRequestFilter: + description: Search filters for listing security signals. + properties: + from: + description: The minimum timestamp for requested security signals. + example: '2019-01-02T09:42:36.320Z' + format: date-time + type: string + query: + description: Search query for listing security signals. + example: security:attack status:high + type: string + to: + description: The maximum timestamp for requested security signals. + example: '2019-01-03T09:42:36.320Z' + format: date-time + type: string + type: object + SecurityMonitoringSignalListRequestPage: + description: The paging attributes for listing security signals. + properties: + cursor: + description: A list of results using the cursor provided in the previous + query. + example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string + limit: + default: 10 + description: The maximum number of security signals in the response. + example: 25 + format: int32 + maximum: 1000 + type: integer + type: object SecurityMonitoringSignalType: default: signal description: The type of event. enum: - signal @@ -5587,36 +6085,42 @@ description: An array of security signals matching the request. items: $ref: '#/components/schemas/SecurityMonitoringSignal' type: array links: - description: Links attributes. - properties: - next: - description: 'The link for the next set of results. **Note**: The request - can also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - type: object + $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseLinks' meta: - description: Meta attributes. - properties: - page: - description: Paging attributes. - properties: - after: - description: 'The cursor used to get the next results, if any. To - make the next request, use the same + $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMeta' + type: object + SecurityMonitoringSignalsListResponseLinks: + description: Links attributes. + properties: + next: + description: 'The link for the next set of results. **Note**: The request + can also be made using the - parameters with the addition of the `page[cursor]`.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - type: string - type: object - type: object + POST endpoint.' + example: https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + type: string type: object + SecurityMonitoringSignalsListResponseMeta: + description: Meta attributes. + properties: + page: + $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage' + type: object + SecurityMonitoringSignalsListResponseMetaPage: + description: Paging attributes. + properties: + after: + description: 'The cursor used 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 SecurityMonitoringSignalsSort: description: The sort parameters used for querying security signals. enum: - timestamp - -timestamp @@ -5945,29 +6449,27 @@ description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: - dashboards_public_share: The ability to share dashboards externally. - dashboards_read: The ability to view dashboards. - dashboards_write: The ability to create and change dashboards. - events_read: The ability to read Events data. - incident_read: The ability to view incidents in Datadog. - incident_settings_write: The ability to configure Incidents settings. - incident_write: The ability to create, view, and manage incidents in Datadog. - metrics_read: The ability to view custom metrics. - security_monitoring_filters_read: The ability to read Security Filters. - security_monitoring_filters_write: The ability to create, edit and delete - Security Filters. - security_monitoring_rules_read: The ability to read Detection Rules. - security_monitoring_rules_write: The ability to create and edit Detection - Rules. - security_monitoring_signals_read: The ability to view Security Signals. - usage_read: The ability to view your organization's usage and usage attribution. - user_access_invite: The ability to invite other users to your organization. - user_access_manage: The ability to disable users, manage user roles, and - manage SAML-to-role mappings. + dashboards_public_share: Share dashboards externally. + dashboards_read: View dashboards. + dashboards_write: Create and change dashboards. + 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. + 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. + 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. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header @@ -6333,10 +6835,128 @@ tags: - Key Management x-codegen-request-body-name: body x-undo: type: idempotent + /api/v2/audit/events: + get: + description: 'List endpoint returns events that match a Audit Logs search query. + + [Results are paginated][1]. + + + Use this endpoint to see your latest Audit Logs events. + + + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + operationId: ListAuditLogs + parameters: + - description: Search query following Audit Logs syntax. + example: '@type:session @application_id:xxxx' + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: '2019-01-02T09:42:36.320Z' + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: '2019-01-03T09:42:36.320Z' + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: '#/components/schemas/AuditLogsSort' + - 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/AuditLogsEventsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get a list of Audit Logs events + tags: + - Audit + x-menu-order: 2 + x-undo: + type: safe + /api/v2/audit/events/search: + post: + description: 'List endpoint returns Audit Logs events that match an Audit search + query. + + [Results are paginated][1]. + + + Use this endpoint to build complex Audit Logs events filtering and search. + + + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + operationId: SearchAuditLogs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuditLogsSearchEventsRequest' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuditLogsEventsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Search Audit Logs events + tags: + - Audit + x-codegen-request-body-name: body + x-menu-order: 1 + x-undo: + type: safe /api/v2/authn_mappings: get: description: List all AuthN Mappings in the org. operationId: ListAuthNMappings parameters: @@ -7143,10 +7763,11 @@ description: Updates an incident. Provide only the attributes that should be updated as this request is a partial update. operationId: UpdateIncident parameters: - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: '#/components/parameters/IncidentIncludeQueryParameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/IncidentUpdateRequest' @@ -8815,11 +9436,11 @@ x-menu-order: 1 x-undo: type: safe /api/v2/roles: get: - description: Returns all roles, including their names and IDs. + description: Returns all roles, including their names and their unique identifiers. operationId: ListRoles parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' - description: 'Sort roles depending on the given field. Sort order is **ascending** @@ -9420,10 +10041,135 @@ \"{{ user.data.type }}\"\n }\n}" step: the "user" has the "role" x-menu-order: 10 x-undo: type: safe + /api/v2/rum/events: + get: + description: 'List endpoint returns events that match a RUM search query. + + [Results are paginated][1]. + + + Use this endpoint to see your latest RUM events. + + + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + operationId: ListRUMEvents + parameters: + - description: Search query following RUM syntax. + example: '@type:session @application_id:xxxx' + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: '2019-01-02T09:42:36.320Z' + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: '2019-01-03T09:42:36.320Z' + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: '#/components/schemas/RUMSort' + - 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/RUMEventsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get a list of RUM events + tags: + - RUM + x-menu-order: 2 + x-undo: + type: safe + /api/v2/rum/events/search: + post: + description: 'List endpoint returns RUM events that match a RUM search query. + + [Results are paginated][1]. + + + Use this endpoint to build complex RUM events filtering and search. + + + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + operationId: SearchRUMEvents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RUMSearchEventsRequest' + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMEventsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Search RUM events + tags: + - RUM + x-codegen-request-body-name: body + x-menu-order: 1 + x-undo: + type: safe /api/v2/security/cloud_workload/policy/download: get: description: 'The download endpoint generates a Cloud Workload Security policy file from your currently active @@ -11237,10 +11983,12 @@ description: Any Datadog deployment. subdomain: 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) is used to automatically map group of users to roles in Datadog using attributes sent from Identity Providers.' @@ -11300,9 +12048,11 @@ 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: The processes API allows you to query processes data for your organization. name: Processes +- description: Search 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/) they grant, and which users belong to them.