.generator/schemas/v2/openapi.yaml in datadog_api_client-2.22.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.24.0

- old
+ new

@@ -371,10 +371,18 @@ in: path name: integration_service_id required: true schema: type: string + OrgConfigName: + description: The name of an Org Config. + in: path + name: org_config_name + required: true + schema: + example: monitor_timezone + type: string PageNumber: description: Specific page number to return. in: query name: page[number] required: false @@ -3959,10 +3967,72 @@ complianceRuleOptions: $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' required: - complianceRuleOptions type: object + CloudConfigurationRulePayload: + description: The payload of a cloud configuration rule. + properties: + cases: + description: 'Description of generated findings and signals (severity and + channels to be notified in case of a signal). Must contain exactly one + item. + + ' + items: + $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate' + type: array + complianceSignalOptions: + $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + filters: + description: Additional queries to filter matched events before they are + processed. + items: + $ref: '#/components/schemas/SecurityMonitoringFilter' + type: array + isEnabled: + description: Whether the rule is enabled. + example: true + type: boolean + message: + description: Message in markdown format for generated findings and signals. + example: '#Description + + Explanation of the rule. + + + #Remediation + + How to fix the security issue. + + ' + type: string + name: + description: The name of the rule. + example: My security monitoring rule. + type: string + options: + $ref: '#/components/schemas/CloudConfigurationRuleOptions' + tags: + description: Tags for generated findings and signals. + example: + - env:prod + - team:security + items: + description: Tag. + type: string + type: array + type: + $ref: '#/components/schemas/CloudConfigurationRuleType' + required: + - name + - isEnabled + - options + - complianceSignalOptions + - cases + - message + type: object CloudConfigurationRuleType: description: The rule type. enum: - cloud_configuration type: string @@ -4103,10 +4173,15 @@ type: boolean expression: description: The SECL expression of the Agent rule. example: exec.file.name == \"sh\" type: string + filters: + description: The platforms the Agent rule is supported on. + items: + type: string + type: array name: description: The name of the Agent rule. example: my_agent_rule type: string required: @@ -6148,11 +6223,11 @@ description: Environment name that was impacted by the incident. example: staging type: string finished_at: description: Unix timestamp in nanoseconds when the incident finished. It - should not be older than 3 hours. + should not be older than 1 hour. example: 1693491984000000000 format: int64 type: integer git: $ref: '#/components/schemas/DORAGitInfo' @@ -7325,14 +7400,19 @@ facet: description: The facet by which to split groups. example: '@error.type' type: string limit: - description: The maximum number of groups to return. + default: 10 + description: 'The maximum buckets to return for this group by. Note: at + most 10000 buckets are allowed. + + If grouping by multiple facets, the product of limits must not exceed + 10000.' example: 10 format: int32 - maximum: 2147483647 + maximum: 10000 type: integer sort: $ref: '#/components/schemas/EventsGroupBySort' required: - facet @@ -10485,10 +10565,62 @@ type: string project_key: description: Jira project key type: string type: object + ListAPIsResponse: + description: Response for `ListAPIs`. + properties: + data: + description: List of API items. + items: + $ref: '#/components/schemas/ListAPIsResponseData' + type: array + meta: + $ref: '#/components/schemas/ListAPIsResponseMeta' + type: object + ListAPIsResponseData: + description: Data envelope for `ListAPIsResponse`. + properties: + attributes: + $ref: '#/components/schemas/ListAPIsResponseDataAttributes' + id: + $ref: '#/components/schemas/ApiID' + type: object + ListAPIsResponseDataAttributes: + description: Attributes for `ListAPIsResponseData`. + properties: + name: + description: API name. + example: Payments API + type: string + type: object + ListAPIsResponseMeta: + description: Metadata for `ListAPIsResponse`. + properties: + pagination: + $ref: '#/components/schemas/ListAPIsResponseMetaPagination' + type: object + ListAPIsResponseMetaPagination: + description: Pagination metadata information for `ListAPIsResponse`. + properties: + limit: + description: Number of items in the current page. + example: 20 + format: int64 + type: integer + offset: + description: Offset for pagination. + example: 0 + format: int64 + type: integer + total_count: + description: Total number of items. + example: 35 + format: int64 + type: integer + type: object ListApplicationKeysResponse: description: Response for a list of application keys. properties: data: description: Array of application keys. @@ -11734,19 +11866,21 @@ x-enum-varnames: - ASCENDING - DESCENDING LogsStorageTier: default: indexes - description: Specifies storage type as indexes or online-archives + description: Specifies storage type as indexes, online-archives or flex enum: - indexes - online-archives + - flex example: indexes type: string x-enum-varnames: - INDEXES - ONLINE_ARCHIVES + - FLEX LogsWarning: description: A warning message indicating something that went wrong with the query properties: code: @@ -13699,10 +13833,108 @@ $ref: '#/components/schemas/OpsgenieServiceResponseData' type: array required: - data type: object + OrgConfigGetResponse: + description: A response with a single Org Config. + properties: + data: + $ref: '#/components/schemas/OrgConfigRead' + required: + - data + type: object + OrgConfigListResponse: + description: A response with multiple Org Configs. + properties: + data: + description: An array of Org Configs. + items: + $ref: '#/components/schemas/OrgConfigRead' + type: array + required: + - data + type: object + OrgConfigRead: + description: A single Org Config. + properties: + attributes: + $ref: '#/components/schemas/OrgConfigReadAttributes' + id: + description: A unique identifier for an Org Config. + example: abcd1234 + type: string + type: + $ref: '#/components/schemas/OrgConfigType' + required: + - id + - type + - attributes + type: object + OrgConfigReadAttributes: + description: Readable attributes of an Org Config. + properties: + description: + description: The description of an Org Config. + example: Frobulate the turbo encabulator manifold + type: string + modified_at: + description: The timestamp of the last Org Config update (if any). + format: date-time + nullable: true + type: string + name: + description: The machine-friendly name of an Org Config. + example: monitor_timezone + type: string + value: + description: The value of an Org Config. + value_type: + description: The type of an Org Config value. + example: bool + type: string + required: + - name + - description + - value_type + - value + type: object + OrgConfigType: + description: Data type of an Org Config. + enum: + - org_configs + example: org_configs + type: string + x-enum-varnames: + - ORG_CONFIGS + OrgConfigWrite: + description: An Org Config write operation. + properties: + attributes: + $ref: '#/components/schemas/OrgConfigWriteAttributes' + type: + $ref: '#/components/schemas/OrgConfigType' + required: + - type + - attributes + type: object + OrgConfigWriteAttributes: + description: Writable attributes of an Org Config. + properties: + value: + description: The value of an Org Config. + required: + - value + type: object + OrgConfigWriteRequest: + description: A request to update an Org Config. + properties: + data: + $ref: '#/components/schemas/OrgConfigWrite' + required: + - data + type: object Organization: description: Organization object. properties: attributes: $ref: '#/components/schemas/OrganizationAttributes' @@ -16172,16 +16404,22 @@ data: $ref: '#/components/schemas/RetentionFilterCreateData' required: - data type: object - RetentionFilterResponse: + RetentionFilterCreateResponse: description: The retention filters definition. properties: data: $ref: '#/components/schemas/RetentionFilter' type: object + RetentionFilterResponse: + description: The retention filters definition. + properties: + data: + $ref: '#/components/schemas/RetentionFilterAll' + type: object RetentionFilterType: default: spans-sampling-processor description: The type of retention filter. The value should always be spans-sampling-processor. enum: - spans-sampling-processor @@ -17392,10 +17630,51 @@ - MAX - NEW_VALUE - GEO_DATA - EVENT_COUNT - NONE + SecurityMonitoringRuleQueryPayload: + description: Payload to test a rule query with the expected result. + properties: + expectedResult: + description: Expected result of the test. + example: true + type: boolean + index: + description: Index of the query under test. + example: 0 + format: int64 + minimum: 0 + type: integer + payload: + $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayloadData' + type: object + SecurityMonitoringRuleQueryPayloadData: + additionalProperties: {} + description: Payload used to test the rule query. + properties: + ddsource: + description: Source of the payload. + example: nginx + type: string + ddtags: + description: Tags associated with your data. + example: env:staging,version:5.1 + type: string + hostname: + description: The name of the originating host of the log. + example: i-012345678 + type: string + message: + description: The message of the payload. + example: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World + type: string + service: + description: The name of the application or service generating the data. + example: payment + type: string + type: object SecurityMonitoringRuleResponse: description: Create a new rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse' @@ -17413,10 +17692,40 @@ - INFO - LOW - MEDIUM - HIGH - CRITICAL + SecurityMonitoringRuleTestPayload: + description: Test a rule. + oneOf: + - $ref: '#/components/schemas/SecurityMonitoringStandardRuleTestPayload' + SecurityMonitoringRuleTestRequest: + description: Test the rule queries of a rule (rule property is ignored when + applied to an existing rule) + properties: + rule: + $ref: '#/components/schemas/SecurityMonitoringRuleTestPayload' + ruleQueryPayloads: + description: Data payloads used to test rules query with the expected result. + items: + $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayload' + type: array + type: object + SecurityMonitoringRuleTestResponse: + description: Result of the test of the rule queries. + properties: + results: + description: 'Assert results are returned in the same order as the rule + query payloads. + + For each payload, it returns True if the result matched the expected result, + + False otherwise.' + items: + type: boolean + type: array + type: object SecurityMonitoringRuleThirdPartyOptions: description: Options on third party rules. properties: defaultNotifications: description: Notification targets for the logs that do not correspond to @@ -17463,10 +17772,17 @@ - LOG_DETECTION - INFRASTRUCTURE_CONFIGURATION - WORKLOAD_SECURITY - CLOUD_CONFIGURATION - APPLICATION_SECURITY + SecurityMonitoringRuleTypeTest: + description: The rule type. + enum: + - log_detection + type: string + x-enum-varnames: + - LOG_DETECTION SecurityMonitoringRuleUpdatePayload: description: Update an existing rule. properties: cases: description: Cases for generating signals. @@ -17508,12 +17824,12 @@ items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third party rules. Only available - for third party rules. + description: Cases for generating signals from third-party rules. Only available + for third-party rules. example: [] items: $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase' type: array version: @@ -17521,10 +17837,16 @@ example: 1 format: int32 maximum: 2147483647 type: integer type: object + SecurityMonitoringRuleValidatePayload: + description: Validate a rule. + oneOf: + - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload' + - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload' + - $ref: '#/components/schemas/CloudConfigurationRulePayload' SecurityMonitoringSignal: description: Object description of a security signal. properties: attributes: $ref: '#/components/schemas/SecurityMonitoringSignalAttributes' @@ -17773,10 +18095,70 @@ - queries - options - cases - message type: object + SecurityMonitoringSignalRulePayload: + description: The payload of a signal correlation rule. + properties: + cases: + description: Cases for generating signals. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + type: array + filters: + description: Additional queries to filter matched events before they are + processed. This field is deprecated for log detection, signal correlation, + and workload security rules. + items: + $ref: '#/components/schemas/SecurityMonitoringFilter' + type: array + hasExtendedTitle: + description: Whether the notifications include the triggering group-by values + in their title. + example: true + type: boolean + isEnabled: + description: Whether the rule is enabled. + example: true + type: boolean + message: + description: Message for generated signals. + example: '' + type: string + name: + description: The name of the rule. + example: My security monitoring rule. + type: string + options: + $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + queries: + description: Queries for selecting signals which are part of the rule. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery' + type: array + tags: + description: Tags for generated signals. + example: + - env:prod + - team:security + items: + description: Tag. + type: string + type: array + type: + $ref: '#/components/schemas/SecurityMonitoringSignalRuleType' + required: + - name + - isEnabled + - queries + - options + - cases + - message + type: object SecurityMonitoringSignalRuleQuery: description: Query for matching rule on signals. properties: aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' @@ -18147,12 +18529,12 @@ items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third party rules. Only available - for third party rules. + description: Cases for generating signals from third-party rules. Only available + for third-party rules. example: [] items: $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' type: array type: @@ -18163,10 +18545,77 @@ - queries - options - cases - message type: object + SecurityMonitoringStandardRulePayload: + description: The payload of a rule. + properties: + cases: + description: Cases for generating signals. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + type: array + filters: + description: Additional queries to filter matched events before they are + processed. This field is deprecated for log detection, signal correlation, + and workload security rules. + items: + $ref: '#/components/schemas/SecurityMonitoringFilter' + type: array + hasExtendedTitle: + description: Whether the notifications include the triggering group-by values + in their title. + example: true + type: boolean + isEnabled: + description: Whether the rule is enabled. + example: true + type: boolean + message: + description: Message for generated signals. + example: '' + type: string + name: + description: The name of the rule. + example: My security monitoring rule. + type: string + options: + $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + queries: + description: Queries for selecting logs which are part of the rule. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + type: array + tags: + description: Tags for generated signals. + example: + - env:prod + - team:security + items: + description: Tag. + type: string + type: array + thirdPartyCases: + description: Cases for generating signals from third-party rules. Only available + for third-party rules. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + type: array + type: + $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate' + required: + - name + - isEnabled + - queries + - options + - cases + - message + type: object SecurityMonitoringStandardRuleQuery: description: Query for matching rule. properties: aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' @@ -18229,10 +18678,18 @@ type: integer creationAuthorId: description: User ID of the user who created the rule. format: int64 type: integer + defaultTags: + description: Default Tags for default rules (included in tags) + example: + - security:attacks + items: + description: Default Tag. + type: string + type: array deprecationDate: description: When the rule will be deprecated, timestamp in milliseconds. format: int64 type: integer filters: @@ -18276,12 +18733,12 @@ items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third party rules. Only available - for third party rules. + description: Cases for generating signals from third-party rules. Only available + for third-party rules. example: [] items: $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase' type: array type: @@ -18292,10 +18749,77 @@ type: integer version: description: The version of the rule. format: int64 type: integer + SecurityMonitoringStandardRuleTestPayload: + description: The payload of a rule to test + properties: + cases: + description: Cases for generating signals. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + type: array + filters: + description: Additional queries to filter matched events before they are + processed. This field is deprecated for log detection, signal correlation, + and workload security rules. + items: + $ref: '#/components/schemas/SecurityMonitoringFilter' + type: array + hasExtendedTitle: + description: Whether the notifications include the triggering group-by values + in their title. + example: true + type: boolean + isEnabled: + description: Whether the rule is enabled. + example: true + type: boolean + message: + description: Message for generated signals. + example: '' + type: string + name: + description: The name of the rule. + example: My security monitoring rule. + type: string + options: + $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + queries: + description: Queries for selecting logs which are part of the rule. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + type: array + tags: + description: Tags for generated signals. + example: + - env:prod + - team:security + items: + description: Tag. + type: string + type: array + thirdPartyCases: + description: Cases for generating signals from third-party rules. Only available + for third-party rules. + example: [] + items: + $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + type: array + type: + $ref: '#/components/schemas/SecurityMonitoringRuleTypeTest' + required: + - name + - isEnabled + - queries + - options + - cases + - message + type: object SecurityMonitoringSuppression: description: The suppression rule's properties. properties: attributes: $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes' @@ -22464,10 +22988,11 @@ type: object UserTeamIncluded: description: Included resources related to the team membership oneOf: - $ref: '#/components/schemas/User' + - $ref: '#/components/schemas/Team' UserTeamPermission: description: A user's permissions for a given team properties: attributes: $ref: '#/components/schemas/UserTeamPermissionAttributes' @@ -22713,35 +23238,52 @@ description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: + apm_api_catalog_read: View API catalog and API definitions. + apm_api_catalog_write: Add, modify, and delete API catalog definitions. + apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. - cases_read: Read all cases data. - cases_write: Create, update and delete cases data. + cases_read: View Cases. + cases_write: Create and update cases. ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. + cloud_cost_management_read: View Cloud Cost pages. This does not restrict + access to the cloud cost data source in dashboards and notebooks. + cloud_cost_management_write: Configure cloud cost accounts and global + customizations. + continuous_profiler_pgo_read: Read and query Continuous Profiler data + for Profile-Guided Optimization (PGO). create_webhooks: Create webhooks integrations. dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. + data_scanner_read: View Data Scanner configurations. + data_scanner_write: Edit Data Scanner configurations. events_read: Read Events data. + hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. monitors_downtime: Set downtimes to suppress alerts from any monitor in - an organization. Mute and unmute hosts. The ability to write monitors + an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit and delete individual monitors. + org_management: Edit org configurations, including authentication and + certain security preferences such as configuring SAML, renaming an org, + configuring allowed login methods, creating child orgs, subscribing + & unsubscribing from apps in the marketplace, and enabling & disabling + Remote Configuration for the entire organization. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View CSPM Findings. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. @@ -22772,10 +23314,13 @@ 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, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. + workflows_read: View workflows. + workflows_run: Run workflows. + workflows_write: Create, edit, and delete workflows. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header @@ -22968,10 +23513,67 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Edit an API key tags: - Key Management x-codegen-request-body-name: body + /api/v2/apicatalog/api: + get: + description: List APIs and their IDs. + operationId: ListAPIs + parameters: + - description: Filter APIs by name + in: query + name: query + required: false + schema: + example: payments + type: string + - description: Number of items per page. + in: query + name: page[limit] + required: false + schema: + default: 20 + format: int64 + minimum: 1 + type: integer + - description: Offset for pagination. + in: query + name: page[offset] + required: false + schema: + default: 0 + format: int64 + minimum: 0 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListAPIsResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List APIs + tags: + - API Management + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/apicatalog/api/{id}: delete: description: Delete a specific API by ID. operationId: DeleteOpenAPI parameters: @@ -23114,15 +23716,14 @@ /api/v2/apicatalog/openapi: post: description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html) specification given. - It supports version `2.0`, `3.0` and `3.1` of the specification. A specific - extension section, `x-datadog`, + See the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/) + for additional - let you specify the `teamHandle` for your team responsible for the API in - Datadog. + information about the possible metadata. It returns the created API ID. ' operationId: CreateOpenAPI @@ -23319,11 +23920,11 @@ responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterResponse' + $ref: '#/components/schemas/RetentionFilterCreateResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' @@ -23738,18 +24339,13 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: List all AuthN Mappings tags: - AuthN Mappings - x-permission: OPEN() post: description: Create an AuthN Mapping. operationId: CreateAuthNMapping requestBody: content: @@ -23782,20 +24378,14 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage summary: Create an AuthN Mapping tags: - AuthN Mappings x-codegen-request-body-name: body - x-permission: OR(USER_ACCESS_MANAGE) /api/v2/authn_mappings/{authn_mapping_id}: delete: description: Delete an AuthN Mapping specified by AuthN Mapping UUID. operationId: DeleteAuthNMapping parameters: @@ -23823,11 +24413,10 @@ - AuthZ: - user_access_manage summary: Delete an AuthN Mapping tags: - AuthN Mappings - x-permission: OR(USER_ACCESS_MANAGE) get: description: Get an AuthN Mapping specified by the AuthN Mapping UUID. operationId: GetAuthNMapping parameters: - $ref: '#/components/parameters/AuthNMappingID' @@ -23857,11 +24446,10 @@ appKeyAuth: [] - AuthZ: [] summary: Get an AuthN Mapping by UUID tags: - AuthN Mappings - x-permission: OPEN() patch: description: Edit an AuthN Mapping. operationId: UpdateAuthNMapping parameters: - $ref: '#/components/parameters/AuthNMappingID' @@ -23917,18 +24505,17 @@ - user_access_manage summary: Edit an AuthN Mapping tags: - AuthN Mappings x-codegen-request-body-name: body - x-permission: OR(USER_ACCESS_MANAGE) /api/v2/cases: get: description: Search cases. operationId: SearchCases parameters: - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' + - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/CaseSortableFieldParameter' - description: Search query in: query name: filter required: false @@ -23957,21 +24544,16 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read summary: Search cases tags: - Case Management x-pagination: limitParam: page[size] - pageOffsetParam: page[offset] + pageParam: page[number] resultsPath: data post: description: Create a Case operationId: CreateCase requestBody: @@ -23996,15 +24578,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Create a case tags: - Case Management /api/v2/cases/projects: get: @@ -24025,15 +24602,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read summary: Get all projects tags: - Case Management post: description: Create a project. @@ -24060,15 +24632,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Create a project tags: - Case Management /api/v2/cases/projects/{project_id}: delete: @@ -24087,15 +24654,10 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: API error response '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Remove a project tags: - Case Management get: description: Get the details of a project by `project_id`. @@ -24117,15 +24679,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read summary: Get the details of a project tags: - Case Management /api/v2/cases/{case_id}: get: @@ -24148,15 +24705,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read summary: Get the details of a case tags: - Case Management /api/v2/cases/{case_id}/archive: post: @@ -24186,15 +24738,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Archive case tags: - Case Management /api/v2/cases/{case_id}/assign: post: @@ -24224,15 +24771,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Assign case tags: - Case Management /api/v2/cases/{case_id}/priority: post: @@ -24262,15 +24804,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Update case priority tags: - Case Management /api/v2/cases/{case_id}/status: post: @@ -24300,15 +24837,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Update case status tags: - Case Management /api/v2/cases/{case_id}/unarchive: post: @@ -24338,15 +24870,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Unarchive case tags: - Case Management /api/v2/cases/{case_id}/unassign: post: @@ -24376,15 +24903,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write summary: Unassign case tags: - Case Management /api/v2/ci/pipeline: post: @@ -24954,17 +25476,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Cloud Cost Management AWS CUR configs tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_READ post: description: Create a Cloud Cost Management account for an AWS CUR config. operationId: CreateCostAWSCURConfig requestBody: content: @@ -24991,17 +25514,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create Cloud Cost Management AWS CUR config tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE /api/v2/cost/aws_cur_config/{cloud_account_id}: delete: description: Archive a Cloud Cost Management Account. operationId: DeleteCostAWSCURConfig parameters: @@ -25021,17 +25545,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Cloud Cost Management AWS CUR config tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE patch: description: Update the status of an AWS CUR config (active/archived). operationId: UpdateCostAWSCURConfig parameters: - $ref: '#/components/parameters/CloudAccountID' @@ -25054,17 +25579,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update Cloud Cost Management AWS CUR config tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE /api/v2/cost/aws_related_accounts: get: description: List the AWS accounts in an organization by calling 'organizations:ListAccounts' from the specified management account. operationId: ListAWSRelatedAccounts @@ -25095,17 +25621,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List related AWS accounts tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_READ /api/v2/cost/azure_uc_config: get: description: List the Azure configs. operationId: ListCostAzureUCConfigs responses: @@ -25121,17 +25648,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Cloud Cost Management Azure configs tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_READ post: description: Create a Cloud Cost Management account for an Azure config. operationId: CreateCostAzureUCConfigs requestBody: content: @@ -25158,17 +25686,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create Cloud Cost Management Azure configs tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE /api/v2/cost/azure_uc_config/{cloud_account_id}: delete: description: Archive a Cloud Cost Management Account. operationId: DeleteCostAzureUCConfig parameters: @@ -25188,17 +25717,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Cloud Cost Management Azure config tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE patch: description: Update the status of an Azure config (active/archived). operationId: UpdateCostAzureUCConfigs parameters: - $ref: '#/components/parameters/CloudAccountID' @@ -25227,17 +25757,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update Cloud Cost Management Azure config tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_WRITE /api/v2/cost/enabled: get: description: Get the Cloud Cost Management activity. operationId: GetCloudCostActivity responses: @@ -25253,17 +25784,18 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Cloud Cost Enabled tags: - Cloud Cost Management - x-permission: - operator: OR - permissions: - - CLOUD_COST_MANAGEMENT_READ /api/v2/cost_by_tag/active_billing_dimensions: get: description: Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month. operationId: GetActiveBillingDimensions @@ -25312,11 +25844,12 @@ is\nset in the response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month, end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n - \ cursor := response.metadata.pagination.next_record_id\nEND\n```" + \ cursor := response.metadata.pagination.next_record_id\nEND\n```\n\nThis + endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)." operationId: GetMonthlyCostAttribution parameters: - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month.' in: query @@ -25833,13 +26366,13 @@ - apiKeyAuth: [] summary: Send a deployment event for DORA Metrics tags: - DORA Metrics x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in private beta. + x-unstable: '**Note**: This endpoint is in public beta. - If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).' + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/dora/incident: post: description: 'Use this API endpoint to provide data about incidents for DORA metrics. @@ -25883,13 +26416,13 @@ - apiKeyAuth: [] summary: Send an incident event for DORA Metrics tags: - DORA Metrics x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in private beta. + x-unstable: '**Note**: This endpoint is in public beta. - If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).' + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/downtime: get: description: Get all scheduled downtimes. operationId: ListDowntimes parameters: @@ -26237,15 +26770,10 @@ $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-pagination: @@ -27591,14 +28119,10 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update resource in Confluent account tags: - Confluent Cloud x-codegen-request-body-name: body - x-permission: - operator: OR - permissions: - - STANDARD /api/v2/integrations/fastly/accounts: get: description: List Fastly accounts. operationId: ListFastlyAccounts responses: @@ -28003,10 +28527,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Get IP Allowlist tags: - IP Allowlist patch: description: Edit the entries in the IP allowlist, and enable or disable it. @@ -28030,10 +28559,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Update IP Allowlist tags: - IP Allowlist x-codegen-request-body-name: body /api/v2/logs: @@ -28310,14 +28844,10 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get archive order tags: - Logs Archives put: description: 'Update the order of your archives. Since logs are processed sequentially, @@ -28386,14 +28916,10 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get all archives tags: - Logs Archives post: description: Create an archive in your organization. @@ -28492,14 +29018,10 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Not found '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get an archive tags: - Logs Archives put: description: 'Update a given archive configuration. @@ -28618,14 +29140,10 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: Not found '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: List read roles for an archive tags: - Logs Archives x-codegen-request-body-name: body post: @@ -28808,14 +29326,10 @@ description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get all log-based metrics tags: - Logs Metrics post: description: 'Create a metric based on your ingested logs in your organization. @@ -28883,14 +29397,10 @@ $ref: '#/components/responses/NotAuthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Get a log-based metric tags: - Logs Metrics patch: description: 'Update a specific log-based metric from your organization. @@ -29353,15 +29863,10 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read summary: List active tags and aggregations tags: - Metrics /api/v2/metrics/{metric_name}/all-tags: get: @@ -29537,14 +30042,10 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: Tag Configuration Cardinality Estimator tags: - Metrics /api/v2/metrics/{metric_name}/tags: delete: @@ -29772,14 +30273,10 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] summary: List distinct metric volumes by metric name tags: - Metrics /api/v2/monitor/policy: get: @@ -30018,10 +30515,100 @@ x-codegen-request-body-name: body x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data + /api/v2/org_configs: + get: + description: Returns all Org Configs (name, description, and value). + operationId: ListOrgConfigs + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgConfigListResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List Org Configs + tags: + - Organizations + /api/v2/org_configs/{org_config_name}: + get: + description: Return the name, description, and value of a specific Org Config. + operationId: GetOrgConfig + parameters: + - $ref: '#/components/parameters/OrgConfigName' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgConfigGetResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get a specific Org Config value + tags: + - Organizations + patch: + description: Update the value of a specific Org Config. + operationId: UpdateOrgConfig + parameters: + - $ref: '#/components/parameters/OrgConfigName' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrgConfigWriteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrgConfigGetResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Update a specific Org Config + tags: + - Organizations /api/v2/permissions: get: description: Returns a list of all permissions, including name, description, and ID. operationId: ListPermissions @@ -30671,11 +31258,11 @@ $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all CSM Threats Agent rules tags: - - Cloud Workload Security + - CSM Threats post: description: Create a new Cloud Security Management Threats Agent rule with the given parameters. operationId: CreateCSMThreatsAgentRule requestBody: @@ -30700,11 +31287,11 @@ $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a CSM Threats Agent rule tags: - - Cloud Workload Security + - CSM Threats x-codegen-request-body-name: body /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}: delete: description: Delete a specific Cloud Security Management Threats Agent rule. operationId: DeleteCSMThreatsAgentRule @@ -30719,11 +31306,11 @@ $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete a CSM Threats Agent rule tags: - - Cloud Workload Security + - CSM Threats get: description: Get the details of a specific Cloud Security Management Threats Agent rule. operationId: GetCSMThreatsAgentRule parameters: @@ -30741,11 +31328,11 @@ $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a CSM Threats Agent rule tags: - - Cloud Workload Security + - CSM Threats patch: description: 'Update a specific Cloud Security Management Threats Agent rule. Returns the Agent rule object when the request is successful.' operationId: UpdateCSMThreatsAgentRule @@ -30775,11 +31362,11 @@ $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Update a CSM Threats Agent rule tags: - - Cloud Workload Security + - CSM Threats x-codegen-request-body-name: body /api/v2/remote_config/products/cws/policy/download: get: description: 'The download endpoint generates a CSM Threats policy file from your currently active @@ -30801,11 +31388,11 @@ $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get the latest CSM Threats policy tags: - - Cloud Workload Security + - CSM Threats /api/v2/restriction_policy/{resource_id}: delete: description: Deletes the restriction policy associated with a specified resource. operationId: DeleteRestrictionPolicy parameters: @@ -30855,16 +31442,16 @@ #### Supported resources Restriction policies can be applied to the following resources: - - Connections: `connection` - - Dashboards: `dashboard` - Notebooks: `notebook` + - Powerpacks: `powerpack` + - Security Rules: `security-rule` - Service Level Objectives: `slo` @@ -30872,16 +31459,16 @@ Resource Type | Supported Relations -------------------------|-------------------------- - Connections | `viewer`, `editor`, `resolver` - Dashboards | `viewer`, `editor` Notebooks | `viewer`, `editor` + Powerpacks | `viewer`, `editor` + Security Rules | `viewer`, `editor` Service Level Objectives | `viewer`, `editor`' operationId: UpdateRestrictionPolicy parameters: @@ -31179,11 +31766,10 @@ - user_access_manage summary: Create a new role by cloning an existing role tags: - Roles x-codegen-request-body-name: body - x-permission: OR(USER_ACCESS_MANAGE) /api/v2/roles/{role_id}/permissions: delete: description: Removes a permission from a role. operationId: RemovePermissionFromRole parameters: @@ -32086,11 +32672,11 @@ $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get the latest Cloud Workload Security policy tags: - - Cloud Workload Security + - CSM Threats /api/v2/security_monitoring/cloud_workload_security/agent_rules: get: description: Get the list of Agent rules. operationId: ListCloudWorkloadSecurityAgentRules responses: @@ -32104,11 +32690,11 @@ $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get all Cloud Workload Security Agent rules tags: - - Cloud Workload Security + - CSM Threats post: description: Create a new Agent rule with the given parameters. operationId: CreateCloudWorkloadSecurityAgentRule requestBody: content: @@ -32132,11 +32718,11 @@ $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Create a Cloud Workload Security Agent rule tags: - - Cloud Workload Security + - CSM Threats x-codegen-request-body-name: body /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}: delete: description: Delete a specific Agent rule. operationId: DeleteCloudWorkloadSecurityAgentRule @@ -32151,11 +32737,11 @@ $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete a Cloud Workload Security Agent rule tags: - - Cloud Workload Security + - CSM Threats get: description: Get the details of a specific Agent rule. operationId: GetCloudWorkloadSecurityAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -32172,11 +32758,11 @@ $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Get a Cloud Workload Security Agent rule tags: - - Cloud Workload Security + - CSM Threats patch: description: 'Update a specific Agent rule. Returns the Agent rule object when the request is successful.' operationId: UpdateCloudWorkloadSecurityAgentRule @@ -32206,11 +32792,11 @@ $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Update a Cloud Workload Security Agent rule tags: - - Cloud Workload Security + - CSM Threats x-codegen-request-body-name: body /api/v2/security_monitoring/configuration/security_filters: get: description: Get the list of configured security filters with their definitions. operationId: ListSecurityFilters @@ -32564,19 +33150,55 @@ - security_monitoring_rules_write summary: Create a detection rule tags: - Security Monitoring x-codegen-request-body-name: body + /api/v2/security_monitoring/rules/test: + post: + description: Test a rule. + operationId: TestSecurityMonitoringRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/ConcurrentModificationResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write + summary: Test a rule + tags: + - Security Monitoring + x-codegen-request-body-name: body /api/v2/security_monitoring/rules/validation: post: description: Validate a detection rule. operationId: ValidateSecurityMonitoringRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload' + $ref: '#/components/schemas/SecurityMonitoringRuleValidatePayload' required: true responses: '204': description: OK '400': @@ -32646,11 +33268,14 @@ the whole field must be included. For example, when modifying a query all queries must be included. - Default rules can only be updated to be enabled and to change notifications.' + Default rules can only be updated to be enabled, to change notifications, + or to update + + the tags (default tags cannot be removed).' operationId: UpdateSecurityMonitoringRule parameters: - $ref: '#/components/parameters/SecurityMonitoringRuleID' requestBody: content: @@ -32682,10 +33307,48 @@ - security_monitoring_rules_write summary: Update an existing rule tags: - Security Monitoring x-codegen-request-body-name: body + /api/v2/security_monitoring/rules/{rule_id}/test: + post: + description: Test an existing rule. + operationId: TestExistingSecurityMonitoringRule + parameters: + - $ref: '#/components/parameters/SecurityMonitoringRuleID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/ConcurrentModificationResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write + summary: Test an existing rule + tags: + - Security Monitoring + x-codegen-request-body-name: body /api/v2/security_monitoring/signals: get: description: 'The list endpoint returns security signals that match a search query. @@ -34068,10 +34731,15 @@ $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Aggregate spans tags: - Spans x-codegen-request-body-name: body /api/v2/spans/events: @@ -34149,10 +34817,15 @@ $ref: '#/components/responses/SpansForbiddenResponse' '422': $ref: '#/components/responses/SpansUnprocessableEntityResponse' '429': $ref: '#/components/responses/SpansTooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Get a list of spans tags: - Spans x-pagination: cursorParam: page[cursor] @@ -34192,10 +34865,15 @@ $ref: '#/components/responses/SpansForbiddenResponse' '422': $ref: '#/components/responses/SpansUnprocessableEntityResponse' '429': $ref: '#/components/responses/SpansTooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Search spans tags: - Spans x-codegen-request-body-name: body x-pagination: @@ -35212,11 +35890,14 @@ **Note:** This endpoint has been deprecated. Please use the new endpoint [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account) - instead.' + instead. + + + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' operationId: GetCostByOrg parameters: - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month.' in: query @@ -35272,11 +35953,14 @@ Estimated cost data is only available for the current month and previous month and is delayed by up to 72 hours from when it was incurred. - To access historical costs prior to this, use the `/historical_cost` endpoint.' + To access historical costs prior to this, use the `/historical_cost` endpoint. + + + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' operationId: GetEstimatedCostByOrg parameters: - description: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`. @@ -35357,11 +36041,14 @@ /api/v2/usage/historical_cost: get: description: 'Get historical cost across multi-org and single root-org accounts. Cost data for a given month becomes available no later than the 16th of the - following month.' + following month. + + + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' operationId: GetHistoricalCostByOrg parameters: - description: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`. @@ -35669,11 +36356,12 @@ description: 'Get projected cost across multi-org and single root-org accounts. Projected cost data is only available for the current month and becomes available around the 12th of the month. - This endpoint requires the usage_read authorization scope.' + + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' operationId: GetProjectedCost parameters: - description: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`. @@ -36223,14 +36911,10 @@ name: Case Management - description: The Cloud Cost Management API allows you to set up, edit, and delete Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management page](https://docs.datadoghq.com/cloud_cost_management/) for more information. name: Cloud Cost Management -- description: Workload activity security rules for generating events using the Datadog - security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/) - for more information. - name: Cloud Workload Security - description: Manage your Datadog Cloudflare integration directly through the Datadog API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/) for more information. name: Cloudflare Integration - description: Manage your Datadog Confluent Cloud integration accounts and account @@ -36499,11 +37183,9 @@ - description: 'The usage metering API allows you to get hourly, daily, and monthly usage across multiple facets of Datadog. This API is available to all Pro and Enterprise customers. - - Usage is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). **Note**: Usage data is delayed by up to 72 hours from when it was incurred. It is retained for 15 months.