.generator/schemas/v2/openapi.yaml in datadog_api_client-2.0.2 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.1.0

- old
+ new

@@ -1268,14 +1268,16 @@ type: array type: object ContentEncoding: description: HTTP header used to compress the media-type. enum: + - identity - gzip - deflate type: string x-enum-varnames: + - IDENTITY - GZIP - DEFLATE CostByOrg: description: Cost data. properties: @@ -1867,19 +1869,17 @@ type: string key: description: The API key. readOnly: true type: string - x-secret: true last4: description: The last four characters of the API key. example: abcd maxLength: 4 minLength: 4 readOnly: true type: string - x-secret: true modified_at: description: Date the API key was last modified. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -1911,19 +1911,17 @@ type: string key: description: The application key. readOnly: true type: string - x-secret: true last4: description: The last four characters of the application key. example: abcd maxLength: 4 minLength: 4 readOnly: true type: string - x-secret: true name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: @@ -4319,13 +4317,18 @@ MetricContentEncoding: default: deflate description: HTTP header used to compress the media-type. enum: - deflate + - zstd1 + - gzip + example: deflate type: string x-enum-varnames: - DEFLATE + - ZSTD1 + - GZIP MetricCustomAggregation: description: A time and space aggregation combination for use in query. example: space: sum time: sum @@ -5247,11 +5250,10 @@ example: abcd maxLength: 4 minLength: 4 readOnly: true type: string - x-secret: true modified_at: description: Date the API key was last modified. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -5286,11 +5288,10 @@ example: abcd maxLength: 4 minLength: 4 readOnly: true type: string - x-secret: true name: description: Name of the application key. example: Application Key for managing dashboards type: string scopes: @@ -5601,10 +5602,191 @@ links: $ref: '#/components/schemas/RUMResponseLinks' meta: $ref: '#/components/schemas/RUMResponseMetadata' type: object + RUMApplication: + description: RUM application. + properties: + attributes: + $ref: '#/components/schemas/RUMApplicationAttributes' + id: + description: RUM application ID. + example: abcd1234-0000-0000-abcd-1234abcd5678 + type: string + type: + $ref: '#/components/schemas/RUMApplicationType' + required: + - attributes + - id + - type + type: object + RUMApplicationAttributes: + description: RUM application attributes. + properties: + application_id: + description: ID of the RUM application. + example: abcd1234-0000-0000-abcd-1234abcd5678 + type: string + created_at: + description: Timestamp in ms of the creation date. + example: 1659479836169 + format: int64 + type: integer + created_by_handle: + description: Handle of the creator user. + example: john.doe + type: string + hash: + description: Client token of the RUM application. + example: abcd1234efgh5678ijkl90abcd1234efgh0 + type: string + name: + description: Name of the RUM application. + example: my_rum_application + type: string + org_id: + description: Org ID of the RUM application. + example: 999 + format: int32 + type: integer + type: + description: Type of the RUM application. Supported values are `browser`, + `ios`, `android`, `react-native`, `flutter`. + example: browser + type: string + updated_at: + description: Timestamp in ms of the last update date. + example: 1659479836169 + format: int64 + type: integer + updated_by_handle: + description: Handle of the updater user. + example: jane.doe + type: string + required: + - application_id + - created_at + - created_by_handle + - name + - org_id + - type + - updated_at + - updated_by_handle + type: object + RUMApplicationCreate: + description: RUM application creation. + properties: + attributes: + $ref: '#/components/schemas/RUMApplicationCreateAttributes' + type: + $ref: '#/components/schemas/RUMApplicationCreateType' + required: + - attributes + - type + type: object + RUMApplicationCreateAttributes: + description: RUM application creation attributes. + properties: + name: + description: Name of the RUM application. + example: my_new_rum_application + type: string + type: + description: Type of the RUM application. Supported values are `browser`, + `ios`, `android`, `react-native`, `flutter`. + example: browser + type: string + required: + - name + type: object + RUMApplicationCreateRequest: + description: RUM application creation request attributes. + properties: + data: + $ref: '#/components/schemas/RUMApplicationCreate' + required: + - data + type: object + RUMApplicationCreateType: + default: rum_application_create + description: RUM application creation type. + enum: + - rum_application_create + example: rum_application_create + type: string + x-enum-varnames: + - RUM_APPLICATION_CREATE + RUMApplicationResponse: + description: RUM application response. + properties: + data: + $ref: '#/components/schemas/RUMApplication' + type: object + RUMApplicationType: + default: rum_application + description: RUM application response type. + enum: + - rum_application + example: rum_application + type: string + x-enum-varnames: + - RUM_APPLICATION + RUMApplicationUpdate: + description: RUM application update. + properties: + attributes: + $ref: '#/components/schemas/RUMApplicationUpdateAttributes' + id: + description: RUM application ID. + example: abcd1234-0000-0000-abcd-1234abcd5678 + type: string + type: + $ref: '#/components/schemas/RUMApplicationUpdateType' + required: + - id + - type + type: object + RUMApplicationUpdateAttributes: + description: RUM application update attributes. + properties: + name: + description: Name of the RUM application. + example: updated_name_for_my_existing_rum_application + type: string + type: + description: Type of the RUM application. Supported values are `browser`, + `ios`, `android`, `react-native`, `flutter`. + example: browser + type: string + type: object + RUMApplicationUpdateRequest: + description: RUM application update request. + properties: + data: + $ref: '#/components/schemas/RUMApplicationUpdate' + required: + - data + type: object + RUMApplicationUpdateType: + default: rum_application_update + description: RUM application update type. + enum: + - rum_application_update + example: rum_application_update + type: string + x-enum-varnames: + - RUM_APPLICATION_UPDATE + RUMApplicationsResponse: + description: RUM applications response. + properties: + data: + description: RUM applications array response. + items: + $ref: '#/components/schemas/RUMApplication' + type: array + type: object RUMBucketResponse: description: Bucket values. properties: by: additionalProperties: @@ -6343,10 +6525,12 @@ $ref: '#/components/schemas/RoleUpdateAttributes' id: description: The unique identifier of the role. example: 00000000-0000-1111-0000-000000000000 type: string + relationships: + $ref: '#/components/schemas/RoleRelationships' type: $ref: '#/components/schemas/RolesType' required: - attributes - type @@ -8111,12 +8295,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all API keys tags: - Key Management - x-undo: - type: safe post: description: Create an API key. operationId: CreateAPIKey requestBody: content: @@ -8147,23 +8329,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create an API key tags: - Key Management x-codegen-request-body-name: body - x-given: - api_key: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"api_keys\"\n }\n}" - step: there is a valid "api_key" in the system - x-undo: - operationId: DeleteAPIKey - parameters: - - name: api_key_id - source: data.id - type: unsafe /api/v2/api_keys/{api_key_id}: delete: description: Delete an API key. operationId: DeleteAPIKey parameters: @@ -8186,12 +8355,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete an API key tags: - Key Management - x-undo: - type: idempotent get: description: Get an API key. operationId: GetAPIKey parameters: - $ref: '#/components/parameters/APIKeyId' @@ -8218,12 +8385,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get API key tags: - Key Management - x-undo: - type: safe patch: description: Update an API key. operationId: UpdateAPIKey parameters: - $ref: '#/components/parameters/APIKeyId' @@ -8262,12 +8427,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Edit an API key tags: - Key Management x-codegen-request-body-name: body - x-undo: - type: idempotent /api/v2/application_keys: get: description: List all application keys available for your org operationId: ListApplicationKeys parameters: @@ -8305,12 +8468,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all application keys tags: - Key Management - x-undo: - type: safe /api/v2/application_keys/{app_key_id}: delete: description: Delete an application key operationId: DeleteApplicationKey parameters: @@ -8334,12 +8495,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete an application key tags: - Key Management x-codegen-request-body-name: body - x-undo: - type: idempotent get: description: Get an application key for your org. operationId: GetApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -8372,12 +8531,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get an application key tags: - Key Management - x-undo: - type: safe patch: description: Edit an application key operationId: UpdateApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -8416,12 +8573,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Edit an application key 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]. @@ -8494,18 +8649,15 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a list of Audit Logs events tags: - Audit - x-menu-order: 2 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-undo: - type: safe /api/v2/audit/events/search: post: description: 'List endpoint returns Audit Logs events that match an Audit search query. @@ -8538,18 +8690,15 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Search Audit Logs events tags: - Audit x-codegen-request-body-name: body - x-menu-order: 1 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-undo: - type: safe /api/v2/authn_mappings: get: description: List all AuthN Mappings in the org. operationId: ListAuthNMappings parameters: @@ -8587,14 +8736,11 @@ appKeyAuth: [] - AuthZ: [] summary: List all AuthN Mappings tags: - AuthN Mappings - x-menu-order: 4 x-permission: OPEN() - x-undo: - type: safe post: description: Create an AuthN Mapping. operationId: CreateAuthNMapping requestBody: content: @@ -8636,29 +8782,11 @@ - user_access_manage summary: Create an AuthN Mapping tags: - AuthN Mappings x-codegen-request-body-name: body - x-given: - authn_mapping: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"attribute_key\": - \"{{ unique_lower_alnum }}\",\n \"attribute_value\": \"{{ unique - }}\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": - {\n \"id\": \"{{ role.data.id }}\",\n \"type\": - \"{{ role.data.type }}\"\n }\n }\n },\n \"type\": - \"authn_mappings\"\n }\n}" - step: there is a valid "authn_mapping" in the system - x-menu-order: 5 x-permission: OR(USER_ACCESS_MANAGE) - x-undo: - operationId: DeleteAuthNMapping - parameters: - - name: authn_mapping_id - source: data.id - type: unsafe /api/v2/authn_mappings/{authn_mapping_id}: delete: description: Delete an AuthN Mapping specified by AuthN Mapping UUID. operationId: DeleteAuthNMapping parameters: @@ -8686,14 +8814,11 @@ - AuthZ: - user_access_manage summary: Delete an AuthN Mapping tags: - AuthN Mappings - x-menu-order: 3 x-permission: OR(USER_ACCESS_MANAGE) - x-undo: - type: idempotent get: description: Get an AuthN Mapping specified by the AuthN Mapping UUID. operationId: GetAuthNMapping parameters: - $ref: '#/components/parameters/AuthNMappingID' @@ -8723,14 +8848,11 @@ appKeyAuth: [] - AuthZ: [] summary: Get an AuthN Mapping by UUID tags: - AuthN Mappings - x-menu-order: 1 x-permission: OPEN() - x-undo: - type: safe patch: description: Edit an AuthN Mapping. operationId: UpdateAuthNMapping parameters: - $ref: '#/components/parameters/AuthNMappingID' @@ -8786,14 +8908,11 @@ - user_access_manage summary: Edit an AuthN Mapping tags: - AuthN Mappings x-codegen-request-body-name: body - x-menu-order: 2 x-permission: OR(USER_ACCESS_MANAGE) - x-undo: - type: idempotent /api/v2/current_user/application_keys: get: description: List all application keys available for current user operationId: ListCurrentUserApplicationKeys parameters: @@ -8831,12 +8950,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all application keys owned by current user tags: - Key Management - x-undo: - type: safe post: description: Create an application key for current user operationId: CreateCurrentUserApplicationKey requestBody: content: @@ -8867,23 +8984,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create an application key for current user tags: - Key Management x-codegen-request-body-name: body - x-given: - application_key: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"application_keys\"\n }\n}" - step: there is a valid "application_key" in the system - x-undo: - operationId: DeleteCurrentUserApplicationKey - parameters: - - name: app_key_id - source: data.id - type: unsafe /api/v2/current_user/application_keys/{app_key_id}: delete: description: Delete an application key owned by current user operationId: DeleteCurrentUserApplicationKey parameters: @@ -8906,12 +9010,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete an application key owned by current user tags: - Key Management - x-undo: - type: idempotent get: description: Get an application key owned by current user operationId: GetCurrentUserApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -8937,12 +9039,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get one application key owned by current user tags: - Key Management - x-undo: - type: safe patch: description: Edit an application key owned by current user operationId: UpdateCurrentUserApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -8981,12 +9081,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Edit an application key owned by current user tags: - Key Management x-codegen-request-body-name: body - x-undo: - type: idempotent /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards: delete: description: Delete dashboards from an existing dashboard list. operationId: DeleteDashboardListItems parameters: @@ -9033,13 +9131,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete items from a dashboard list tags: - Dashboard Lists x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent get: description: "Fetch the dashboard list\u2019s dashboard definitions." operationId: GetDashboardListItems parameters: - description: ID of the dashboard list to get items from. @@ -9076,13 +9171,10 @@ - AuthZ: - dashboards_read summary: Get items of a Dashboard List tags: - Dashboard Lists - x-menu-order: 1 - x-undo: - type: safe post: description: Add dashboards to an existing dashboard list. operationId: CreateDashboardListItems parameters: - description: ID of the dashboard list to add items to. @@ -9128,30 +9220,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Add Items to a Dashboard List tags: - Dashboard Lists x-codegen-request-body-name: body - x-given: - dashboard_list_dashboard: - parameters: - - name: dashboard_list_id - source: dashboard_list.id - - name: body - value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ dashboard.id - }}\",\n \"type\": \"custom_timeboard\"\n }\n ]\n}" - step: the "dashboard_list" has the "dashboard" - dashboard_list_screenboard_dashboard: - parameters: - - name: dashboard_list_id - source: dashboard_list.id - - name: body - value: "{\n \"dashboards\": [\n {\n \"id\": \"{{ screenboard_dashboard.id - }}\",\n \"type\": \"custom_screenboard\"\n }\n ]\n}" - step: the "dashboard_list" has the "screenboard_dashboard" - x-menu-order: 2 - x-undo: - type: safe put: description: Update dashboards of an existing dashboard list. operationId: UpdateDashboardListItems parameters: - description: ID of the dashboard list to update items from. @@ -9197,13 +9269,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update items of a dashboard list tags: - 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). @@ -9273,18 +9342,15 @@ - 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: @@ -9312,22 +9378,24 @@ $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read 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: @@ -9364,12 +9432,10 @@ - Incidents x-pagination: limitParam: page[size] pageOffsetParam: page[offset] resultsPath: data - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' post: description: Create an incident. @@ -9405,24 +9471,10 @@ - incident_write summary: Create an incident tags: - Incidents x-codegen-request-body-name: body - x-given: - incident: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ - unique }}\",\n \"customer_impacted\": false\n },\n \"type\": - \"incidents\"\n }\n}" - step: there is a valid "incident" in the system - x-undo: - operationId: DeleteIncident - parameters: - - name: incident_id - source: data.id - type: unsafe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents/{incident_id}: delete: @@ -9449,12 +9501,10 @@ - AuthZ: - incident_write summary: Delete an existing incident tags: - Incidents - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' get: description: Get the details of an incident by `incident_id`. @@ -9485,12 +9535,10 @@ - AuthZ: - incident_read summary: Get the details of an incident tags: - Incidents - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' patch: description: Updates an incident. Provide only the attributes that should be @@ -9530,12 +9578,10 @@ - incident_write summary: Update an existing incident tags: - Incidents x-codegen-request-body-name: body - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/integration/opsgenie/services: get: @@ -9553,13 +9599,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all service objects tags: - Opsgenie Integration - x-menu-order: 1 - x-undo: - type: safe post: description: Create a new service object in the Opsgenie integration. operationId: CreateOpsgenieService requestBody: content: @@ -9585,26 +9628,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a new service object tags: - Opsgenie Integration x-codegen-request-body-name: body - x-given: - opsgenie_service: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n - \ \"region\": \"us\"\n },\n \"type\": \"opsgenie-service\"\n - \ }\n}" - step: there is a valid "opsgenie_service" in the system - x-menu-order: 2 - x-undo: - operationId: DeleteOpsgenieService - parameters: - - name: integration_service_id - source: data.id - type: unsafe /api/v2/integration/opsgenie/services/{integration_service_id}: delete: description: Delete a single service object in the Datadog Opsgenie integration. operationId: DeleteOpsgenieService parameters: @@ -9621,13 +9648,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete a single service object tags: - Opsgenie Integration - x-menu-order: 5 - x-undo: - type: idempotent get: description: Get a single service from the Datadog Opsgenie integration. operationId: GetOpsgenieService parameters: - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' @@ -9649,13 +9673,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a single service object tags: - Opsgenie Integration - x-menu-order: 3 - x-undo: - type: safe patch: description: Update a single service object in the Datadog Opsgenie integration. operationId: UpdateOpsgenieService parameters: - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' @@ -9685,13 +9706,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update a single service object tags: - Opsgenie Integration x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent /api/v2/logs: post: description: 'Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: @@ -9762,53 +9780,63 @@ examples: multi-json-messages: description: Pass multiple log objects at once. summary: Multi JSON Messages value: - - message: hello - - message: world + - ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345678 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello + service: payment + - ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345679 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] World + service: payment simple-json-message: description: Log attributes can be passed as `key:value` pairs in valid JSON messages. summary: Simple JSON Message value: - ddsource: agent - ddtags: env:prod,user:joe.doe - hostname: fa1e1e739d95 - message: hello world + ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345678 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello + World + service: payment schema: $ref: '#/components/schemas/HTTPLog' application/logplex-1: examples: multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages - value: 'hello + value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - world' + 2019-11-19T14:37:58,995 INFO [process.name][20081] World' simple-logplex-message: description: Submit log string. summary: Simple Logplex Message - value: hello world + value: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World schema: type: string text/plain: examples: multi-raw-message: description: Submit log string. summary: Multi Raw Messages - value: 'hello + value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - world + 2019-11-19T14:37:58,995 INFO [process.name][20081] World ' simple-raw-message: description: 'Submit log string. Log attributes can be passed as query parameters in the URL. This enables the addition of tags or the source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`.' summary: Simple Raw Message - value: hello world + value: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World schema: type: string description: Log to send (JSON format). required: true responses: @@ -9901,13 +9929,10 @@ description: The subdomain where the API is deployed. summary: Send logs tags: - Logs x-codegen-request-body-name: body - x-menu-order: 1 - x-undo: - type: safe /api/v2/logs/analytics/aggregate: post: description: The API endpoint to aggregate events into buckets and compute metrics and timeseries. operationId: AggregateLogs @@ -9932,13 +9957,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Aggregate events tags: - Logs x-codegen-request-body-name: body - x-menu-order: 1 - x-undo: - type: safe /api/v2/logs/config/archive-order: get: description: 'Get the current order of your archives. This endpoint takes no JSON arguments.' @@ -9963,13 +9985,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get archive order tags: - Logs Archives - x-menu-order: 9 - x-undo: - type: safe put: description: 'Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. @@ -10016,13 +10035,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update archive order tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 10 - x-undo: - type: safe /api/v2/logs/config/archives: get: description: Get the list of configured logs archives with their definitions. operationId: ListLogsArchives responses: @@ -10045,13 +10061,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get all archives tags: - Logs Archives - x-menu-order: 1 - x-undo: - type: safe post: description: Create an archive in your organization. operationId: CreateLogsArchive requestBody: content: @@ -10083,17 +10096,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create an archive tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 2 - x-undo: - operationId: DeleteLogsArchive - parameters: - - name: archive_id - source: data.id - type: unsafe /api/v2/logs/config/archives/{archive_id}: delete: description: Delete a given archive from your organization. operationId: DeleteLogsArchive parameters: @@ -10122,13 +10128,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete an archive tags: - Logs Archives - x-menu-order: 5 - x-undo: - type: idempotent get: description: Get a specific archive from your organization. operationId: GetLogsArchive parameters: - $ref: '#/components/parameters/ArchiveID' @@ -10164,13 +10167,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get an archive tags: - Logs Archives - x-menu-order: 3 - x-undo: - type: safe put: description: 'Update a given archive configuration. **Note**: Using this method updates your archive configuration by **replacing** @@ -10215,13 +10215,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update an archive tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: safe /api/v2/logs/config/archives/{archive_id}/readers: delete: description: Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) operationId: RemoveRoleFromArchive parameters: @@ -10257,13 +10254,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Revoke role from an archive tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 8 - x-undo: - type: idempotent get: description: Returns all read roles a given archive is restricted to. operationId: ListArchiveReadRoles parameters: - $ref: '#/components/parameters/ArchiveID' @@ -10300,13 +10294,10 @@ - AuthZ: [] summary: List read roles for an archive tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 6 - x-undo: - type: safe post: description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) operationId: AddReadRoleToArchive parameters: - $ref: '#/components/parameters/ArchiveID' @@ -10341,13 +10332,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Grant role to an archive tags: - Logs Archives x-codegen-request-body-name: body - x-menu-order: 7 - x-undo: - type: unsafe /api/v2/logs/config/metrics: get: description: Get the list of configured log-based metrics with their definitions. operationId: ListLogsMetrics responses: @@ -10366,13 +10354,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get all log-based metrics tags: - Logs Metrics - x-menu-order: 1 - x-undo: - type: safe post: description: 'Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful.' @@ -10401,26 +10386,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a log-based metric tags: - Logs Metrics x-codegen-request-body-name: body - x-given: - logs_metric: - parameters: - - name: body - value: "{\n \"data\": {\n \"id\": \"{{ unique }}\",\n \"attributes\": - {\n \"filter\": {\n \"query\": \"source:{{ unique }}\"\n - \ },\n \"compute\": {\n \"aggregation_type\": \"count\"\n - \ }\n },\n \"type\": \"logs_metrics\"\n }\n}" - step: there is a valid "logs_metric" in the system - x-menu-order: 2 - x-undo: - operationId: DeleteLogsMetric - parameters: - - name: metric_id - source: data.id - type: unsafe /api/v2/logs/config/metrics/{metric_id}: delete: description: Delete a specific log-based metric from your organization. operationId: DeleteLogsMetric parameters: @@ -10435,13 +10404,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete a log-based metric tags: - Logs Metrics - x-menu-order: 5 - x-undo: - type: idempotent get: description: Get a specific log-based metric from your organization. operationId: GetLogsMetric parameters: - $ref: '#/components/parameters/MetricID' @@ -10463,13 +10429,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get a log-based metric tags: - Logs Metrics - x-menu-order: 3 - x-undo: - type: safe patch: description: 'Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful.' @@ -10500,13 +10463,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update a log-based metric tags: - Logs Metrics x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent /api/v2/logs/events: get: description: 'List endpoint returns logs that match a log search query. [Results are paginated][1]. @@ -10597,18 +10557,15 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a list of logs tags: - Logs - x-menu-order: 3 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-undo: - type: safe /api/v2/logs/events/search: post: description: 'List endpoint returns logs that match a log search query. [Results are paginated][1]. @@ -10649,18 +10606,15 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Search logs tags: - Logs x-codegen-request-body-name: body - x-menu-order: 2 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-undo: - type: safe /api/v2/metrics: get: description: 'Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified).' @@ -10748,13 +10702,10 @@ - AuthZ: - metrics_read summary: List tag configurations tags: - Metrics - x-menu-order: 5 - x-undo: - type: safe /api/v2/metrics/config/bulk-tags: delete: description: 'Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. @@ -10805,13 +10756,10 @@ description: Too Many Requests summary: Configure tags for multiple metrics tags: - Metrics x-codegen-request-body-name: body - x-menu-order: 9 - x-undo: - type: idempotent post: description: 'Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. Use the Delete method @@ -10867,17 +10815,10 @@ description: Too Many Requests summary: Configure tags for multiple metrics tags: - Metrics x-codegen-request-body-name: body - x-menu-order: 8 - x-undo: - operationId: DeleteBulkTagsMetricsConfiguration - parameters: - - name: body - source: '' - type: unsafe /api/v2/metrics/{metric_name}/all-tags: get: description: View indexed tag key-value pairs for a given metric name. operationId: ListTagsByMetricName parameters: @@ -10918,13 +10859,10 @@ appKeyAuth: [] - AuthZ: [] summary: List tags by metric name tags: - Metrics - x-menu-order: 6 - x-undo: - type: safe /api/v2/metrics/{metric_name}/estimate: get: description: Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™. @@ -11016,16 +10954,13 @@ slack_support_channel: '#points-aggregation' staging_high_urgency: '@slack-points-aggr-stg-ops' staging_low_urgency: '@slack-points-aggr-stg-ops' team: points-aggregation team_escalation: '[Points Aggregation] Primary' - x-menu-order: 10 x-permission: operator: OPEN permissions: [] - x-undo: - type: safe /api/v2/metrics/{metric_name}/tags: delete: description: 'Deletes a metric''s tag configuration. Can only be used with application keys from users with the `Manage Tags for Metrics` permission.' @@ -11054,13 +10989,10 @@ $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests summary: Delete a tag configuration tags: - Metrics - x-menu-order: 4 - x-undo: - type: idempotent get: description: Returns the tag configuration for the given metric name. operationId: ListTagConfigurationByName parameters: - $ref: '#/components/parameters/MetricName' @@ -11095,13 +11027,10 @@ - AuthZ: - metrics_read summary: List tag configuration by name tags: - Metrics - x-menu-order: 2 - x-undo: - type: safe patch: description: 'Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric. @@ -11150,13 +11079,10 @@ description: Too Many Requests summary: Update a tag configuration tags: - Metrics x-codegen-request-body-name: body - x-menu-order: 3 - x-undo: - type: idempotent post: description: 'Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric or @@ -11208,28 +11134,10 @@ description: Too Many Requests summary: Create a tag configuration tags: - Metrics x-codegen-request-body-name: body - x-given: - metric_tag_configuration: - parameters: - - name: metric_name - value: '"{{ unique_alnum }}"' - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"tags\":[\"app\", - \"datacenter\", \"{{ unique_alnum }}\"],\n \"metric_type\":\"gauge\"\n - \ },\n \"type\": \"manage_tags\",\n \"id\": \"{{ unique_alnum - }}\"\n }\n}" - step: there is a valid "metric_tag_configuration" in the system - x-menu-order: 1 - x-undo: - operationId: DeleteTagConfiguration - parameters: - - name: metric_name - source: data.id - type: unsafe /api/v2/metrics/{metric_name}/volumes: get: description: 'View distinct metrics volumes for the given metric name. @@ -11274,13 +11182,10 @@ appKeyAuth: [] - AuthZ: [] summary: List distinct metric volumes by metric name tags: - Metrics - x-menu-order: 7 - x-undo: - type: safe /api/v2/permissions: get: description: Returns a list of all permissions, including name, description, and ID. operationId: ListPermissions @@ -11310,17 +11215,10 @@ appKeyAuth: [] - AuthZ: [] summary: List permissions tags: - Roles - x-given: - permission: - source: data[0] - step: there is a valid "permission" in the system - x-menu-order: 1 - x-undo: - type: safe /api/v2/processes: get: description: Get all processes for your organization. operationId: ListProcesses parameters: @@ -11407,18 +11305,15 @@ appKeyAuth: [] - AuthZ: [] summary: Get all processes tags: - Processes - x-menu-order: 1 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-undo: - type: safe /api/v2/roles: get: description: Returns all roles, including their names and their unique identifiers. operationId: ListRoles parameters: @@ -11462,13 +11357,10 @@ appKeyAuth: [] - AuthZ: [] summary: List roles tags: - Roles - x-menu-order: 1 - x-undo: - type: safe post: description: Create a new role for your organization. operationId: CreateRole requestBody: content: @@ -11504,24 +11396,10 @@ - user_access_manage summary: Create role tags: - Roles x-codegen-request-body-name: body - x-given: - role: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"roles\"\n }\n}" - step: there is a valid "role" in the system - x-menu-order: 2 - x-undo: - operationId: DeleteRole - parameters: - - name: role_id - source: data.id - type: unsafe /api/v2/roles/{role_id}: delete: description: Disables a role. operationId: DeleteRole parameters: @@ -11550,13 +11428,10 @@ - user_access_manage summary: Delete role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 5 - x-undo: - type: idempotent get: description: "Get a role in the organization specified by the role\u2019s `role_id`." operationId: GetRole parameters: - $ref: '#/components/parameters/RoleID' @@ -11587,13 +11462,10 @@ - AuthZ: [] summary: Get a role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 3 - x-undo: - type: safe patch: description: Edit a role. Can only be used with application keys belonging to administrators. operationId: UpdateRole parameters: @@ -11644,13 +11516,10 @@ - user_access_manage summary: Update a role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent /api/v2/roles/{role_id}/clone: post: description: Clone an existing role operationId: CloneRole parameters: @@ -11701,18 +11570,11 @@ - user_access_manage summary: Create a new role by cloning an existing role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 12 x-permission: OR(USER_ACCESS_MANAGE) - x-undo: - operationId: DeleteRole - parameters: - - name: role_id - source: data.id - type: unsafe /api/v2/roles/{role_id}/permissions: delete: description: Removes a permission from a role. operationId: RemovePermissionFromRole parameters: @@ -11757,13 +11619,10 @@ - user_access_manage summary: Revoke permission tags: - Roles x-codegen-request-body-name: body - x-menu-order: 8 - x-undo: - type: idempotent get: description: Returns a list of all permissions for a single role. operationId: ListRolePermissions parameters: - $ref: '#/components/parameters/RoleID' @@ -11794,13 +11653,10 @@ - AuthZ: [] summary: List permissions for a role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 6 - x-undo: - type: safe post: description: Adds a permission to a role. operationId: AddPermissionToRole parameters: - $ref: '#/components/parameters/RoleID' @@ -11844,22 +11700,10 @@ - user_access_manage summary: Grant permission to a role tags: - Roles x-codegen-request-body-name: body - x-given: - permission_role: - parameters: - - name: role_id - source: role.data.id - - name: body - value: "{\n \"data\": {\n \"id\": \"{{ permission.id }}\",\n \"type\": - \"{{ permission.type }}\"\n }\n}" - step: the "permission" is granted to the "role" - x-menu-order: 7 - x-undo: - type: safe /api/v2/roles/{role_id}/users: delete: description: Removes a user from a role. operationId: RemoveUserFromRole parameters: @@ -11904,13 +11748,10 @@ - user_access_manage summary: Remove a user from a role tags: - Roles x-codegen-request-body-name: body - x-menu-order: 11 - x-undo: - type: idempotent get: description: Gets all users of a role. operationId: ListRoleUsers parameters: - $ref: '#/components/parameters/RoleID' @@ -11960,13 +11801,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get all users of a role tags: - Roles - x-menu-order: 9 - x-undo: - type: safe post: description: Adds a user to a role. operationId: AddUserToRole parameters: - $ref: '#/components/parameters/RoleID' @@ -12010,22 +11848,10 @@ - user_access_manage summary: Add a user to a role tags: - Roles x-codegen-request-body-name: body - x-given: - permission_role: - parameters: - - name: role_id - source: role.data.id - - name: body - value: "{\n \"data\": {\n \"id\": \"{{ user.data.id }}\",\n \"type\": - \"{{ user.data.type }}\"\n }\n}" - step: the "user" has the "role" - x-menu-order: 10 - x-undo: - type: safe /api/v2/rum/analytics/aggregate: post: description: The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries. operationId: AggregateRUMEvents @@ -12054,13 +11880,136 @@ - AuthZ: [] summary: Aggregate RUM events tags: - RUM x-codegen-request-body-name: body - x-menu-order: 3 - x-undo: - type: safe + /api/v2/rum/applications: + get: + description: List all the RUM applications in your organization. + operationId: GetRUMApplications + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationsResponse' + description: OK + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List all the RUM applications + tags: + - RUM + post: + description: Create a new RUM application in your organization. + operationId: CreateRUMApplication + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a new RUM application + tags: + - RUM + x-codegen-request-body-name: body + /api/v2/rum/applications/{id}: + delete: + description: Delete an existing RUM application in your organization. + operationId: DeleteRUMApplication + parameters: + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No Content + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete a RUM application + tags: + - RUM + get: + description: Get the RUM application with given ID in your organization. + operationId: GetRUMApplication + parameters: + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationResponse' + description: OK + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get a RUM application + tags: + - RUM + patch: + description: Update the RUM application with given ID in your organization. + operationId: UpdateRUMApplication + parameters: + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RUMApplicationResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Unprocessable Entity. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update a RUM application + tags: + - RUM + x-codegen-request-body-name: body /api/v2/rum/events: get: description: 'List endpoint returns events that match a RUM search query. [Results are paginated][1]. @@ -12137,18 +12086,15 @@ appKeyAuth: [] - AuthZ: [] summary: Get a list of RUM events tags: - RUM - x-menu-order: 2 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-undo: - type: safe /api/v2/rum/events/search: post: description: 'List endpoint returns RUM events that match a RUM search query. [Results are paginated][1]. @@ -12184,18 +12130,15 @@ - AuthZ: [] summary: Search RUM events tags: - RUM x-codegen-request-body-name: body - x-menu-order: 1 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-undo: - type: safe /api/v2/saml_configurations/idp_metadata: post: description: 'Endpoint for uploading IdP metadata for SAML setup. @@ -12226,13 +12169,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Upload IdP metadata tags: - Organizations x-codegen-request-body-name: body - x-menu-order: 1 - x-undo: - type: idempotent /api/v2/security/cloud_workload/policy/download: get: description: 'The download endpoint generates a Cloud Workload Security policy file from your currently active @@ -12254,13 +12194,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get the latest Cloud Workload Security policy tags: - Cloud Workload Security - x-menu-order: 1 - x-undo: - type: safe /api/v2/security_monitoring/cloud_workload_security/agent_rules: get: description: Get the list of Agent rules. operationId: ListCloudWorkloadSecurityAgentRules responses: @@ -12275,13 +12212,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all Cloud Workload Security Agent rules tags: - Cloud Workload Security - x-menu-order: 3 - x-undo: - type: safe post: description: Create a new Agent rule with the given parameters. operationId: CreateCloudWorkloadSecurityAgentRule requestBody: content: @@ -12307,26 +12241,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a Cloud Workload Security Agent rule tags: - Cloud Workload Security x-codegen-request-body-name: body - x-given: - agent_rule: - parameters: - - name: body - value: "{\n \"data\": {\n \"type\": \"agent_rule\",\n \"attributes\": - {\n \"name\": \"{{ unique_lower_alnum }}\",\n \"description\": - \"My Agent rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n - \ \"enabled\": true\n }\n }\n}" - step: there is a valid "agent_rule" in the system - x-menu-order: 4 - x-undo: - operationId: DeleteCloudWorkloadSecurityAgentRule - parameters: - - name: agent_rule_id - source: data.id - type: unsafe /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}: delete: description: Delete a specific Agent rule. operationId: DeleteCloudWorkloadSecurityAgentRule parameters: @@ -12341,13 +12259,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete a Cloud Workload Security Agent rule tags: - Cloud Workload Security - x-menu-order: 6 - x-undo: - type: idempotent get: description: Get the details of a specific Agent rule. operationId: GetCloudWorkloadSecurityAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -12365,13 +12280,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a Cloud Workload Security Agent rule tags: - Cloud Workload Security - x-menu-order: 2 - x-undo: - type: safe patch: description: 'Update a specific Agent rule. Returns the Agent rule object when the request is successful.' operationId: UpdateCloudWorkloadSecurityAgentRule @@ -12403,13 +12315,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update a Cloud Workload Security Agent rule tags: - Cloud Workload Security x-codegen-request-body-name: body - x-menu-order: 5 - x-undo: - type: idempotent /api/v2/security_monitoring/configuration/security_filters: get: description: Get the list of configured security filters with their definitions. operationId: ListSecurityFilters responses: @@ -12429,12 +12338,10 @@ - AuthZ: - security_monitoring_filters_read summary: Get all security filters tags: - Security Monitoring - x-undo: - type: safe post: description: 'Create a security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) @@ -12470,27 +12377,10 @@ - security_monitoring_filters_write summary: Create a security filter tags: - Security Monitoring x-codegen-request-body-name: body - x-given: - security_filter: - parameters: - - name: body - value: "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": - {\n \"name\": \"{{ unique }}\",\n \"query\": \"service:{{ - unique_alnum }}\",\n \"exclusion_filters\":[\n {\n \"name\": - \"Exclude logs from staging\",\n \"query\": \"source:staging\"\n - \ }\n ],\n \"filtered_data_type\":\"logs\",\n \"is_enabled\": - true\n }\n }\n}" - step: there is a valid "security_filter" in the system - x-undo: - operationId: DeleteSecurityFilter - parameters: - - name: security_filter_id - source: data.id - type: unsafe /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}: delete: description: Delete a specific security filter. operationId: DeleteSecurityFilter parameters: @@ -12510,12 +12400,10 @@ - AuthZ: - security_monitoring_filters_write summary: Delete a security filter tags: - Security Monitoring - x-undo: - type: idempotent get: description: 'Get the details of a specific security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) @@ -12543,12 +12431,10 @@ - AuthZ: - security_monitoring_filters_read summary: Get a security filter tags: - Security Monitoring - x-undo: - type: safe patch: description: 'Update a specific security filter. Returns the security filter object when the request is successful.' operationId: UpdateSecurityFilter @@ -12585,12 +12471,10 @@ - security_monitoring_filters_write summary: Update a security filter tags: - Security Monitoring x-codegen-request-body-name: body - x-undo: - type: idempotent /api/v2/security_monitoring/rules: get: description: List rules. operationId: ListSecurityMonitoringRules parameters: @@ -12613,13 +12497,10 @@ - AuthZ: - security_monitoring_rules_read summary: List rules tags: - Security Monitoring - x-menu-order: 1 - x-undo: - type: safe post: description: Create a detection rule. operationId: CreateSecurityMonitoringRule requestBody: content: @@ -12647,30 +12528,10 @@ - security_monitoring_rules_write summary: Create a detection rule tags: - Security Monitoring x-codegen-request-body-name: body - x-given: - security_rule: - parameters: - - name: body - value: "{\n \"name\": \"{{ unique }}\",\n \"queries\": [{\n \"query\": - \"@test:true\",\n \"aggregation\": \"count\",\n \"groupByFields\": - [],\n \"distinctFields\": [],\n \"metric\": \"\"\n }],\n \"filters\": - [],\n \"cases\": [{\n \"name\": \"\",\n \"status\": \"info\",\n - \ \"condition\": \"a > 0\",\n \"notifications\": []\n }],\n \"options\": - {\n \"evaluationWindow\": 900,\n \"keepAlive\": 3600,\n \"maxSignalDuration\": - 86400\n },\n \"message\": \"Test rule\",\n \"tags\": [],\n \"isEnabled\": - true,\n \"type\": \"log_detection\"\n}" - step: there is a valid "security_rule" in the system - x-menu-order: 2 - x-undo: - operationId: DeleteSecurityMonitoringRule - parameters: - - name: rule_id - source: id - type: unsafe /api/v2/security_monitoring/rules/{rule_id}: delete: description: Delete an existing rule. Default rules cannot be deleted. operationId: DeleteSecurityMonitoringRule parameters: @@ -12690,13 +12551,10 @@ - AuthZ: - security_monitoring_rules_write summary: Delete an existing rule tags: - Security Monitoring - x-menu-order: 5 - x-undo: - type: idempotent get: description: Get a rule's details. operationId: GetSecurityMonitoringRule parameters: - $ref: '#/components/parameters/SecurityMonitoringRuleID' @@ -12717,13 +12575,10 @@ - AuthZ: - security_monitoring_rules_read summary: Get a rule's details tags: - Security Monitoring - x-menu-order: 3 - x-undo: - type: safe put: description: 'Update an existing rule. When updating `cases`, `queries` or `options`, the whole field must be included. For example, when modifying a query all queries must be @@ -12763,13 +12618,10 @@ - security_monitoring_rules_write summary: Update an existing rule tags: - Security Monitoring x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent /api/v2/security_monitoring/signals: get: description: 'The list endpoint returns security signals that match a search query. @@ -12844,18 +12696,15 @@ - AuthZ: - security_monitoring_signals_read summary: Get a quick list of security signals tags: - Security Monitoring - x-menu-order: 7 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-undo: - type: safe /api/v2/security_monitoring/signals/search: post: description: 'Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing @@ -12888,18 +12737,15 @@ - security_monitoring_signals_read summary: Get a list of security signals tags: - Security Monitoring x-codegen-request-body-name: body - x-menu-order: 6 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-undo: - type: safe /api/v2/security_monitoring/signals/{signal_id}/assignee: patch: description: Modify the triage assignee of a security signal. operationId: EditSecurityMonitoringSignalAssignee parameters: @@ -12936,21 +12782,14 @@ 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: @@ -12987,21 +12826,14 @@ 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: @@ -13038,21 +12870,14 @@ 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 @@ -13120,13 +12945,10 @@ - apiKeyAuth: [] summary: Submit metrics tags: - Metrics x-codegen-request-body-name: body - x-menu-order: 1 - x-undo: - type: safe /api/v2/service_accounts: post: description: Create a service account for your organization. operationId: CreateServiceAccount requestBody: @@ -13158,25 +12980,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a service account tags: - Users x-codegen-request-body-name: body - x-given: - service_account_user: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"email\": \"{{ - unique }}@datadoghq.com\",\n \"title\": \"user title\",\n \"service_account\": - true\n },\n \"type\": \"users\"\n }\n}" - step: there is a valid "service_account_user" in the system - x-menu-order: 1 - x-undo: - operationId: DisableUser - parameters: - - name: user_id - source: data.id - type: unsafe /api/v2/service_accounts/{service_account_id}/application_keys: get: description: List all application keys available for this service account. operationId: ListServiceAccountApplicationKeys parameters: @@ -13215,12 +13022,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: List application keys for this service account tags: - Service Accounts - x-undo: - type: safe post: description: Create an application key for this service account. operationId: CreateServiceAccountApplicationKey parameters: - $ref: '#/components/parameters/ServiceAccountID' @@ -13253,27 +13058,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Create an application key for this service account tags: - Service Accounts x-codegen-request-body-name: body - x-given: - service_account_application_key: - parameters: - - name: service_account_id - value: '"{{ service_account_user.data.id }}"' - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"application_keys\"\n }\n}" - step: there is a valid "service_account_application_key" for "service_account_user" - x-undo: - operationId: DeleteServiceAccountApplicationKey - parameters: - - name: app_key_id - source: data.id - - name: service_account_id - source: data.relationships.owned_by.data.id - type: unsafe /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}: delete: description: Delete an application key owned by this service account. operationId: DeleteServiceAccountApplicationKey parameters: @@ -13297,13 +13085,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete an application key for this service account tags: - Service Accounts - x-menu-order: 3 - x-undo: - type: idempotent get: description: Get an application key owned by this service account. operationId: GetServiceAccountApplicationKey parameters: - $ref: '#/components/parameters/ServiceAccountID' @@ -13330,13 +13115,10 @@ '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get one application key for this service account tags: - Service Accounts - x-menu-order: 1 - x-undo: - type: safe patch: description: Edit an application key owned by this service account. operationId: UpdateServiceAccountApplicationKey parameters: - $ref: '#/components/parameters/ServiceAccountID' @@ -13376,13 +13158,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Edit an application key for this service account tags: - Service Accounts x-codegen-request-body-name: body - x-menu-order: 2 - x-undo: - type: idempotent /api/v2/services: get: description: Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services. @@ -13415,12 +13194,10 @@ - AuthZ: - incident_read summary: Get a list of all incident services tags: - Incident Services - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' post: description: Creates a new incident service. @@ -13456,23 +13233,10 @@ - incident_settings_write summary: Create a new incident service tags: - Incident Services x-codegen-request-body-name: body - x-given: - service: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"services\"\n }\n}" - step: there is a valid "service" in the system - x-undo: - operationId: DeleteIncidentService - parameters: - - name: service_id - source: data.id - type: unsafe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/services/{service_id}: delete: @@ -13499,12 +13263,10 @@ - AuthZ: - incident_settings_write summary: Delete an existing incident service tags: - Incident Services - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' get: description: 'Get details of an incident service. If the `include[users]` query @@ -13538,12 +13300,10 @@ - AuthZ: - incident_read summary: Get details of an incident service tags: - Incident Services - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' patch: description: Updates an existing incident service. Only provide the attributes @@ -13582,12 +13342,10 @@ - incident_settings_write summary: Update an existing incident service tags: - Incident Services x-codegen-request-body-name: body - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/teams: get: @@ -13623,12 +13381,10 @@ - AuthZ: - incident_read summary: Get a list of all incident teams tags: - Incident Teams - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' post: description: Creates a new incident team. @@ -13664,23 +13420,10 @@ - incident_settings_write summary: Create a new incident team tags: - Incident Teams x-codegen-request-body-name: body - x-given: - team: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ - unique }}\"\n },\n \"type\": \"teams\"\n }\n}" - step: there is a valid "team" in the system - x-undo: - operationId: DeleteIncidentTeam - parameters: - - name: team_id - source: data.id - type: unsafe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/teams/{team_id}: delete: @@ -13707,12 +13450,10 @@ - AuthZ: - incident_settings_write summary: Delete an existing incident team tags: - Incident Teams - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' get: description: 'Get details of an incident team. If the `include[users]` query @@ -13746,12 +13487,10 @@ - AuthZ: - incident_read summary: Get details of an incident team tags: - Incident Teams - x-undo: - type: safe x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' patch: description: Updates an existing incident team. Only provide the attributes @@ -13790,12 +13529,10 @@ - incident_settings_write summary: Update an existing incident team tags: - Incident Teams x-codegen-request-body-name: body - x-undo: - type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/usage/application_security: get: @@ -13854,13 +13591,10 @@ - AuthZ: - usage_read summary: Get hourly usage for application security tags: - Usage Metering - 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 month becomes available no later than the 16th of the following month. operationId: GetCostByOrg @@ -13912,13 +13646,10 @@ - AuthZ: - usage_read summary: Get cost across multi-org account tags: - Usage Metering - x-menu-order: 5 - x-undo: - type: safe /api/v2/usage/estimated_cost: get: 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. @@ -13999,13 +13730,10 @@ - AuthZ: - usage_read 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: @@ -14117,13 +13845,10 @@ - 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. **Note:** hourly usage data for all products is now available in the [Get @@ -14179,13 +13904,10 @@ - AuthZ: - usage_read summary: Get hourly usage for lambda traced invocations tags: - Usage Metering - x-menu-order: 36 - x-undo: - type: safe /api/v2/usage/observability_pipelines: get: description: 'Get hourly usage for observability pipelines. **Note:** hourly usage data for all products is now available in the [Get @@ -14241,13 +13963,10 @@ - AuthZ: - usage_read summary: Get hourly usage for observability pipelines tags: - Usage Metering - x-menu-order: 38 - x-undo: - type: safe /api/v2/user_invitations: post: description: Sends emails to one or more users inviting them to join the organization. operationId: SendInvitations requestBody: @@ -14284,22 +14003,10 @@ - user_access_invite summary: Send invitation emails tags: - Users x-codegen-request-body-name: body - x-given: - user_invitation: - parameters: - - name: body - value: "{\n \"data\": [\n {\n \"relationships\": {\"user\": {\"data\": - {\n \"id\": \"{{ user.data.id }}\",\n \"type\": \"{{ user.data.type - }}\"\n }}},\n \"type\": \"user_invitations\"\n }\n ]\n}" - source: data[0] - step: the "user" has a "user_invitation" - x-menu-order: 8 - x-undo: - type: safe /api/v2/user_invitations/{user_invitation_uuid}: get: description: Returns a single user invitation by its UUID. operationId: GetInvitation parameters: @@ -14338,13 +14045,10 @@ - user_access_invite summary: Get a user invitation tags: - Users x-codegen-request-body-name: body - x-menu-order: 9 - x-undo: - type: safe /api/v2/users: get: description: 'Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.' @@ -14417,13 +14121,10 @@ - AuthZ: [] summary: List all users tags: - Users x-codegen-request-body-name: body - x-menu-order: 1 - x-undo: - type: safe post: description: Create a user for your organization. operationId: CreateUser requestBody: content: @@ -14459,25 +14160,10 @@ - user_access_invite summary: Create a user tags: - Users x-codegen-request-body-name: body - x-given: - user: - parameters: - - name: body - value: "{\n \"data\": {\n \"attributes\": {\n \"email\": \"{{ - unique }}@datadoghq.com\",\n \"title\": \"user title\"\n },\n - \ \"type\": \"users\"\n }\n}" - step: there is a valid "user" in the system - x-menu-order: 2 - x-undo: - operationId: DisableUser - parameters: - - name: user_id - source: data.id - type: unsafe /api/v2/users/{user_id}: delete: description: 'Disable a user. Can only be used with an application key belonging to an administrator user.' @@ -14508,13 +14194,10 @@ - user_access_manage summary: Disable a user tags: - Users x-codegen-request-body-name: body - x-menu-order: 5 - x-undo: - type: idempotent get: description: "Get a user in the organization specified by the user\u2019s `user_id`." operationId: GetUser parameters: - $ref: '#/components/parameters/UserID' @@ -14545,13 +14228,10 @@ - AuthZ: [] summary: Get user details tags: - Users x-codegen-request-body-name: body - x-menu-order: 3 - x-undo: - type: safe patch: description: 'Edit a user. Can only be used with an application key belonging to an administrator user.' operationId: UpdateUser @@ -14603,13 +14283,10 @@ - user_access_manage summary: Update a user tags: - Users x-codegen-request-body-name: body - x-menu-order: 4 - x-undo: - type: idempotent /api/v2/users/{user_id}/orgs: get: description: 'Get a user organization. Returns the user information and all organizations @@ -14644,13 +14321,10 @@ - AuthZ: [] summary: Get a user organization tags: - Users x-codegen-request-body-name: body - x-menu-order: 6 - x-undo: - type: safe /api/v2/users/{user_id}/permissions: get: description: "Get a user permission set. Returns a list of the user\u2019s permissions\ngranted by the associated user's roles." operationId: ListUserPermissions @@ -14683,12 +14357,9 @@ - AuthZ: [] summary: Get a user permissions tags: - Users x-codegen-request-body-name: body - x-menu-order: 7 - x-undo: - type: safe security: - apiKeyAuth: [] appKeyAuth: [] servers: - url: https://{subdomain}.{site}