.generator/schemas/v2/openapi.yaml in datadog_api_client-2.10.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.11.0

- old
+ new

@@ -171,10 +171,17 @@ in: path name: service_id required: true schema: type: string + GCPSTSServiceAccountID: + description: Your GCP STS enabled service account's unique ID. + in: path + name: account_id + required: true + schema: + type: string IncidentAttachmentFilterQueryParameter: description: Specifies which types of attachments are included in the response. explode: false in: query name: filter[attachment_type] @@ -375,10 +382,17 @@ in: path name: role_id required: true schema: type: string + SchemaVersion: + description: The schema version desired in the response. + in: query + name: schema_version + required: false + schema: + $ref: '#/components/schemas/ServiceDefinitionSchemaVersions' SecurityFilterID: description: The ID of the security filter. in: path name: security_filter_id required: true @@ -2897,10 +2911,70 @@ example: 0.5 format: double type: number type: array type: object + DetailedFinding: + description: A single finding with with message and resource configuration. + properties: + attributes: + $ref: '#/components/schemas/DetailedFindingAttributes' + id: + $ref: '#/components/schemas/FindingID' + type: + $ref: '#/components/schemas/DetailedFindingType' + type: object + DetailedFindingAttributes: + description: The JSON:API attributes of the detailed finding. + properties: + evaluation: + $ref: '#/components/schemas/FindingEvaluation' + evaluation_changed_at: + $ref: '#/components/schemas/FindingEvaluationChangedAt' + message: + description: The remediation message for this finding. + example: '## Remediation + + + ### From the console + + + 1. Go to Storage Account + + 2. For each Storage Account, navigate to Data Protection + + 3. Select Set soft delete enabled and enter the number of days to retain + soft deleted data.' + type: string + mute: + $ref: '#/components/schemas/FindingMute' + resource: + $ref: '#/components/schemas/FindingResource' + resource_configuration: + description: The resource configuration for this finding. + type: object + resource_discovery_date: + $ref: '#/components/schemas/FindingResourceDiscoveryDate' + resource_type: + $ref: '#/components/schemas/FindingResourceType' + rule: + $ref: '#/components/schemas/FindingRule' + status: + $ref: '#/components/schemas/FindingStatus' + tags: + $ref: '#/components/schemas/FindingTags' + type: object + DetailedFindingType: + default: detailed_finding + description: The JSON:API type for findings that have the message and resource + configuration. + enum: + - detailed_finding + example: detailed_finding + type: string + x-enum-varnames: + - DETAILED_FINDING Event: description: The metadata associated with a request. properties: id: description: Event ID. @@ -3597,10 +3671,168 @@ description: The JSON:API data schema. items: $ref: '#/components/schemas/FastlyServiceResponse' type: array type: object + Finding: + description: A single finding without message and resource configuration. + properties: + attributes: + $ref: '#/components/schemas/FindingAttributes' + id: + $ref: '#/components/schemas/FindingID' + type: + $ref: '#/components/schemas/FindingType' + type: object + FindingAttributes: + description: The JSON:API attributes of the finding. + properties: + evaluation: + $ref: '#/components/schemas/FindingEvaluation' + evaluation_changed_at: + $ref: '#/components/schemas/FindingEvaluationChangedAt' + mute: + $ref: '#/components/schemas/FindingMute' + resource: + $ref: '#/components/schemas/FindingResource' + resource_discovery_date: + $ref: '#/components/schemas/FindingResourceDiscoveryDate' + resource_type: + $ref: '#/components/schemas/FindingResourceType' + rule: + $ref: '#/components/schemas/FindingRule' + status: + $ref: '#/components/schemas/FindingStatus' + tags: + $ref: '#/components/schemas/FindingTags' + type: object + FindingEvaluation: + description: The evaluation of the finding. + enum: + - pass + - fail + example: pass + type: string + x-enum-varnames: + - PASS + - FAIL + FindingEvaluationChangedAt: + description: The date on which the evaluation for this finding changed (Unix + ms). + example: 1678721573794 + format: int64 + minimum: 1 + type: integer + FindingID: + description: The unique ID for this finding. + example: AQAAAYbb1i0gijTHEQAAAABBWWJiMWkwZ0FBQ2FuNzBJVGZXZ3B3QUE + type: string + FindingMute: + additionalProperties: false + description: Information about the mute status of this finding. + properties: + description: + description: Additional information about the reason why this finding is + muted. + example: To be resolved later + type: string + expiration_date: + description: The end of the mute period. + example: 1778721573794 + format: int64 + type: integer + muted: + description: Whether this finding is muted. + example: true + type: boolean + reason: + $ref: '#/components/schemas/FindingMuteReason' + start_date: + description: The start of the mute period. + example: 1678721573794 + format: int64 + type: integer + uuid: + description: The ID of the user who muted this finding. + example: e51c9744-d158-11ec-ad23-da7ad0900002 + type: string + type: object + FindingMuteReason: + description: The reason why this finding is muted. + enum: + - ACCEPTED_RISK + - PENDING_FIX + - FALSE_POSITIVE + - OTHER + example: ACCEPTED_RISK + type: string + x-enum-varnames: + - ACCEPTED_RISK + - PENDING_FIX + - FALSE_POSITIVE + - OTHER + FindingResource: + description: The resource name of this finding. + example: my_resource_name + type: string + FindingResourceDiscoveryDate: + description: The date on which the resource was discovered (Unix ms). + example: 1678721573794 + format: int64 + minimum: 1 + type: integer + FindingResourceType: + description: The resource type of this finding. + example: azure_storage_account + type: string + FindingRule: + additionalProperties: false + description: The rule that triggered this finding. + properties: + id: + description: The ID of the rule that triggered this finding. + example: dv2-jzf-41i + type: string + name: + description: The name of the rule that triggered this finding. + example: Soft delete is enabled for Azure Storage + type: string + type: object + FindingStatus: + description: The status of the finding. + enum: + - critical + - high + - medium + - low + - info + example: critical + type: string + x-enum-varnames: + - CRITICAL + - HIGH + - MEDIUM + - LOW + - INFO + FindingTags: + description: The tags associated with this finding. + example: + - cloud_provider:aws + - myTag:myValue + items: + description: The list of tags. + type: string + type: array + FindingType: + default: finding + description: The JSON:API type for findings. + enum: + - finding + example: finding + type: string + x-enum-varnames: + - FINDING FormulaLimit: description: Message for specifying limits to the number of values returned by a query. properties: count: @@ -3702,10 +3934,154 @@ description: Name of scope. type: string nullable: true type: array type: object + GCPSTSDelegateAccount: + description: Datadog principal service account info. + properties: + attributes: + $ref: '#/components/schemas/GCPSTSDelegateAccountAttributes' + id: + description: The ID of the delegate service account. + example: ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com + type: string + type: + $ref: '#/components/schemas/GCPSTSDelegateAccountType' + type: object + GCPSTSDelegateAccountAttributes: + description: Your delegate account attributes. + properties: + delegate_account_email: + description: Your organization's Datadog principal email address. + example: ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com + type: string + type: object + GCPSTSDelegateAccountResponse: + description: Your delegate service account response data. + properties: + data: + $ref: '#/components/schemas/GCPSTSDelegateAccount' + type: object + GCPSTSDelegateAccountType: + default: gcp_sts_delegate + description: The type of account. + enum: + - gcp_sts_delegate + example: gcp_sts_delegate + type: string + x-enum-varnames: + - GCP_STS_DELEGATE + GCPSTSServiceAccount: + description: Info on your service account. + properties: + attributes: + $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + id: + description: Your service account's unique ID. + example: d291291f-12c2-22g4-j290-123456678897 + type: string + meta: + $ref: '#/components/schemas/GCPServiceAccountMeta' + type: + $ref: '#/components/schemas/GCPServiceAccountType' + type: object + GCPSTSServiceAccountAttributes: + description: Attributes associated with your service account. + properties: + automute: + description: Silence monitors for expected GCE instance shutdowns. + type: boolean + client_email: + description: Your service account email address. + example: datadog-service-account@test-project.iam.gserviceaccount.com + type: string + host_filters: + description: Your Host Filters. + items: + description: Host Filters + type: string + type: array + is_cspm_enabled: + description: When enabled, Datadog performs configuration checks across + your Google Cloud environment by continuously scanning every resource. + type: boolean + type: object + GCPSTSServiceAccountCreateRequest: + description: Data on your newly generated service account. + properties: + data: + $ref: '#/components/schemas/GCPSTSServiceAccountData' + type: object + GCPSTSServiceAccountData: + description: Additional metadata on your generated service account. + properties: + attributes: + $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + type: + $ref: '#/components/schemas/GCPServiceAccountType' + type: object + GCPSTSServiceAccountResponse: + description: The account creation response. + properties: + data: + $ref: '#/components/schemas/GCPSTSServiceAccount' + type: object + GCPSTSServiceAccountUpdateRequest: + description: Service account info. + properties: + data: + $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequestData' + type: object + GCPSTSServiceAccountUpdateRequestData: + description: Data on your service account. + properties: + attributes: + $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + id: + description: Your service account's unique ID. + example: d291291f-12c2-22g4-j290-123456678897 + type: string + type: + $ref: '#/components/schemas/GCPServiceAccountType' + type: object + GCPSTSServiceAccountsResponse: + description: Object containing all your STS enabled accounts. + properties: + data: + description: Array of GCP STS enabled service accounts. + items: + $ref: '#/components/schemas/GCPSTSServiceAccount' + type: array + type: object + GCPServiceAccountMeta: + description: Additional information related to your service account. + properties: + accessible_projects: + description: The current list of projects accessible from your service account. + items: + description: List of GCP projects. + type: string + type: array + type: object + GCPServiceAccountType: + default: gcp_service_account + description: The type of account. + enum: + - gcp_service_account + example: gcp_service_account + type: string + x-enum-varnames: + - GCP_SERVICE_ACCOUNT + GetFindingResponse: + description: The expected response schema when getting a finding. + properties: + data: + $ref: '#/components/schemas/DetailedFinding' + required: + - data + type: object GetTeamMembershipsSort: description: Specifies the order of returned team memberships enum: - manager_name - -manager_name @@ -4270,10 +4646,15 @@ - $ref: '#/components/schemas/User' type: object IncidentCreateAttributes: description: The incident's attributes for a create request. properties: + customer_impact_scope: + description: Required if `customer_impacted:"true"`. A summary of the impact + customers experienced during the incident. + example: Example customer impact scope + type: string customer_impacted: description: A flag indicating whether the incident caused customer impact. example: false type: boolean fields: @@ -5767,10 +6148,53 @@ description: Array of objects related to the application key. items: $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' type: array type: object + ListFindingsData: + description: Array of findings. + items: + $ref: '#/components/schemas/Finding' + type: array + ListFindingsMeta: + additionalProperties: false + description: Metadata for pagination. + properties: + page: + $ref: '#/components/schemas/ListFindingsPage' + snapshot_timestamp: + description: The point in time corresponding to the listed findings. + example: 1678721573794 + format: int64 + minimum: 1 + type: integer + type: object + ListFindingsPage: + additionalProperties: false + description: Pagination and findings count information. + properties: + cursor: + description: The cursor used to paginate requests. + example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0= + type: string + total_filtered_count: + description: The total count of findings after the filter has been applied. + example: 213 + format: int64 + type: integer + type: object + ListFindingsResponse: + description: The expected response schema when listing findings. + properties: + data: + $ref: '#/components/schemas/ListFindingsData' + meta: + $ref: '#/components/schemas/ListFindingsMeta' + required: + - data + - meta + type: object ListTeamsInclude: description: Included related resources optionally requested. enum: - team_links - user_team_permissions @@ -10810,16 +11234,18 @@ description: Reason a signal is archived. enum: - none - false_positive - testing_or_maintenance + - investigated_case_opened - other type: string x-enum-varnames: - NONE - FALSE_POSITIVE - TESTING_OR_MAINTENANCE + - INVESTIGATED_CASE_OPENED - OTHER SecurityMonitoringSignalAssigneeUpdateAttributes: description: Attributes describing the new assignee of a security signal. properties: assignee: @@ -12224,10 +12650,21 @@ oneOf: - $ref: '#/components/schemas/ServiceDefinitionV1' - $ref: '#/components/schemas/ServiceDefinitionV2' - $ref: '#/components/schemas/ServiceDefinitionV2Dot1' type: object + ServiceDefinitionSchemaVersions: + description: Schema versions + enum: + - v1 + - v2 + - v2.1 + type: string + x-enum-varnames: + - V1 + - V2 + - V2_1 ServiceDefinitionV1: deprecated: true description: Deprecated - Service definition V1 for providing additional service metadata and integrations. properties: @@ -13228,22 +13665,16 @@ description: Free-form markdown description/content for the team's homepage type: string handle: description: The team's identifier example: example-team - maxLength: 64 + maxLength: 195 type: string - link_count: - description: The number of links belonging to the team - format: int32 - maximum: 2147483647 - readOnly: true - type: integer name: description: The name of the team example: Example Team - maxLength: 64 + maxLength: 200 type: string required: - handle - name type: object @@ -13533,16 +13964,10 @@ handle: description: The team's identifier example: example-team maxLength: 64 type: string - link_count: - description: The number of links belonging to the team - format: int32 - maximum: 2147483647 - readOnly: true - type: integer name: description: The name of the team example: Example Team maxLength: 64 type: string @@ -14285,10 +14710,13 @@ description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: + 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. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. events_read: Read Events data. incident_read: View incidents in Datadog. incident_settings_write: Configure Incidents settings. @@ -16557,10 +16985,158 @@ - Incidents x-codegen-request-body-name: body 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/gcp/accounts: + get: + description: List all GCP STS-enabled service accounts configured in your Datadog + account. + operationId: ListGCPSTSAccounts + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSServiceAccountsResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List all GCP STS-enabled service accounts + tags: + - GCP Integration + post: + description: Create a new entry within Datadog for your STS enabled service + account. + operationId: CreateGCPSTSAccount + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSServiceAccountCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSServiceAccountResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a new entry for your service account + tags: + - GCP Integration + x-codegen-request-body-name: body + /api/v2/integration/gcp/accounts/{account_id}: + delete: + description: Delete an STS enabled GCP account from within Datadog. + operationId: DeleteGCPSTSAccount + parameters: + - $ref: '#/components/parameters/GCPSTSServiceAccountID' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete an STS enabled GCP Account + tags: + - GCP Integration + patch: + description: Update an STS enabled service account. + operationId: UpdateGCPSTSAccount + parameters: + - $ref: '#/components/parameters/GCPSTSServiceAccountID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSServiceAccountResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update STS Service Account + tags: + - GCP Integration + x-codegen-request-body-name: body + /api/v2/integration/gcp/sts_delegate: + get: + description: List your Datadog-GCP STS delegate account configured in your Datadog + account. + operationId: GetGCPSTSDelegate + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSDelegateAccountResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List delegate account + tags: + - GCP Integration + x-codegen-request-body-name: body + post: + description: Create a Datadog GCP principal. + operationId: MakeGCPSTSDelegate + requestBody: + content: + application/json: + schema: + example: {} + type: object + description: Create a delegate service account within Datadog. + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCPSTSDelegateAccountResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a Datadog GCP principal + tags: + - GCP Integration + x-codegen-request-body-name: body /api/v2/integration/opsgenie/services: get: description: Get a list of all services from the Datadog Opsgenie integration. operationId: ListOpsgenieServices responses: @@ -17424,12 +18000,12 @@ Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs. - Log events can be submitted up to 18 hours in the past and 2 hours in the - future. + Log events can be submitted with a timestamp that is up to 18 hours in the + past. The status codes answered by the HTTP API are: - 202: Accepted: the request has been accepted for processing @@ -18465,11 +19041,11 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too Many Requests - summary: Configure tags for multiple metrics + summary: Delete tags for multiple metrics tags: - Metrics x-codegen-request-body-name: body post: description: 'Create and define a list of queryable tag keys for a set of existing @@ -19180,10 +19756,206 @@ appKeyAuth: [] - AuthZ: [] summary: List permissions tags: - Roles + /api/v2/posture_management/findings: + get: + description: "Get a list of CSPM findings.\n\n### Filtering\n\nFilters can be + applied by appending query parameters to the URL.\n\n - Using a single filter: + `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n + \ - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, + `attribute_key` can be any of the filter keys described further below.\n\nQuery + parameters of type `integer` support comparison operators (`>`, `>=`, `<`, + `<=`). This is particularly useful when filtering by `evaluation_changed_at` + or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou + can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` + to filter for any non-AWS resources.\n\nThe operator must come after the equal + sign. For example, to filter with the `>=` operator, add the operator after + the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\n### Response\n\nThe + response includes an array of finding objects, pagination metadata, and a + count of items that match the query.\n\nEach finding object contains the following:\n\n- + The finding ID that can be used in a `GetFinding` request to retrieve the + full finding details.\n- Core attributes, including status, evaluation, high-level + resource details, muted state, and rule details.\n- `evaluation_changed_at` + and `resource_discovery_date` time stamps.\n- An array of associated tags.\n" + operationId: ListFindings + parameters: + - description: Limit the number of findings returned. Must be <= 1000. + example: 50 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + maximum: 1000 + minimum: 1 + type: integer + - description: Return findings for a given snapshot of time (Unix ms). + example: 1678721573794 + in: query + name: snapshot_timestamp + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: Return the next page of findings pointed to by the cursor. + example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0= + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Return findings that have these associated tags (repeatable). + example: filter[tags]=cloud_provider:aws&filter[tags]=aws_account:999999999999 + in: query + name: filter[tags] + required: false + schema: + type: string + - description: Return findings that have changed from pass to fail or vice versa + on a specified date (Unix ms) or date range (using comparison operators). + example: '>=1678721573794' + in: query + name: filter[evaluation_changed_at] + required: false + schema: + type: string + - description: Set to `true` to return findings that are muted. Set to `false` + to return unmuted findings. + in: query + name: filter[muted] + required: false + schema: + type: boolean + - description: Return findings for the specified rule ID. + in: query + name: filter[rule_id] + required: false + schema: + type: string + - description: Return findings for the specified rule. + in: query + name: filter[rule_name] + required: false + schema: + type: string + - description: Return only findings for the specified resource type. + in: query + name: filter[resource_type] + required: false + schema: + type: string + - description: Return findings that were found on a specified date (Unix ms) + or date range (using comparison operators). + example: '>=1678721573794' + in: query + name: filter[discovery_timestamp] + required: false + schema: + type: string + - description: Return only `pass` or `fail` findings. + example: pass + in: query + name: filter[evaluation] + required: false + schema: + $ref: '#/components/schemas/FindingEvaluation' + - description: Return only findings with the specified status. + example: critical + in: query + name: filter[status] + required: false + schema: + $ref: '#/components/schemas/FindingStatus' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListFindingsResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read + summary: List findings + tags: + - Security Monitoring + x-pagination: + cursorParam: page[cursor] + cursorPath: meta.page.cursor + limitParam: page[limit] + resultsPath: data + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/posture_management/findings/{finding_id}: + get: + description: Returns a single finding with message and resource configuration. + operationId: GetFinding + parameters: + - description: The ID of the finding. + in: path + name: finding_id + required: true + schema: + type: string + - description: Return the finding for a given snapshot of time (Unix ms). + example: 1678721573794 + in: query + name: snapshot_timestamp + required: false + schema: + format: int64 + minimum: 1 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetFindingResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read + summary: Get a finding + tags: + - Security Monitoring + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/processes: get: description: Get all processes for your organization. operationId: ListProcesses parameters: @@ -21772,10 +22544,11 @@ Catalog. operationId: ListServiceDefinitions parameters: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' + - $ref: '#/components/parameters/SchemaVersion' responses: '200': content: application/json: schema: @@ -21783,10 +22556,15 @@ description: OK '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get all service definitions tags: - Service Definition x-pagination: limitParam: page[size] @@ -21815,10 +22593,15 @@ $ref: '#/components/responses/ForbiddenResponse' '409': $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create or update service definition tags: - Service Definition x-codegen-request-body-name: body /api/v2/services/definitions/{service_name}: @@ -21836,18 +22619,24 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Delete a single service definition tags: - Service Definition get: description: Get a single service definition from the Datadog Service Catalog. operationId: GetServiceDefinition parameters: - $ref: '#/components/parameters/ServiceName' + - $ref: '#/components/parameters/SchemaVersion' responses: '200': content: application/json: schema: @@ -21861,10 +22650,15 @@ $ref: '#/components/responses/NotFoundResponse' '409': $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get a single service definition tags: - Service Definition /api/v2/services/{service_id}: delete: @@ -22094,10 +22888,11 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - teams_read + - teams_manage summary: Create a team tags: - Teams x-codegen-request-body-name: body /api/v2/team/{team_id}: @@ -22125,10 +22920,11 @@ security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - teams_read + - teams_manage summary: Remove a team tags: - Teams get: description: Get a single team using the team's `id`. @@ -22675,10 +23471,11 @@ tags: - Teams x-codegen-request-body-name: body /api/v2/teams: get: + deprecated: true description: Get all incident teams 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 teams. operationId: ListIncidentTeams parameters: @@ -22709,14 +23506,13 @@ - AuthZ: - incident_read summary: Get a list of all incident teams tags: - Incident Teams - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' post: + deprecated: true description: Creates a new incident team. operationId: CreateIncidentTeam requestBody: content: application/json: @@ -22748,15 +23544,14 @@ - incident_settings_write summary: Create a new incident team tags: - Incident Teams x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' /api/v2/teams/{team_id}: delete: + deprecated: true description: Deletes an existing incident team. operationId: DeleteIncidentTeam parameters: - $ref: '#/components/parameters/IncidentTeamIDPathParameter' responses: @@ -22778,14 +23573,13 @@ - AuthZ: - incident_settings_write summary: Delete an existing incident team tags: - Incident Teams - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' get: + deprecated: true description: 'Get details of an incident team. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams.' operationId: GetIncidentTeam @@ -22815,14 +23609,13 @@ - AuthZ: - incident_read summary: Get details of an incident team tags: - Incident Teams - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' patch: + deprecated: true description: Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. operationId: UpdateIncidentTeam parameters: - $ref: '#/components/parameters/IncidentTeamIDPathParameter' @@ -22857,13 +23650,11 @@ - incident_settings_write summary: Update an existing incident team tags: - Incident Teams x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' /api/v2/usage/application_security: get: description: 'Get hourly usage for application security . **Note:** hourly usage data for all products is now available in the [Get @@ -23005,11 +23796,11 @@ schema: type: string - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. Either start_month or start_date should be specified, but not both. (start_month cannot go beyond two months in the - past)' + past). Provide an `end_month` to view month-over-month cost.' in: query name: start_month required: false schema: format: date-time @@ -23023,11 +23814,11 @@ format: date-time type: string - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. Either start_month or start_date should be specified, but not both. (start_date cannot go beyond two months in the - past)' + past). Provide an `end_date` to view day-over-day cumulative cost.' in: query name: start_date required: false schema: format: date-time @@ -23188,10 +23979,18 @@ name: filter[include_descendants] required: false schema: default: false type: boolean + - description: Include breakdown of usage by subcategories where applicable + (for product family logs only). Defaults to false. + in: query + name: filter[include_breakdown] + required: false + schema: + default: false + type: boolean - description: 'Comma separated list of product family versions to use in the format `product_family:version`. For example, `infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested @@ -23842,10 +24641,16 @@ first 4000 characters are displayed.' name: Events - description: Configure your Datadog Fastly integration directly through the Datadog API. name: Fastly Integration +- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly + + through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).' + externalDocs: + url: https://docs.datadoghq.com/integrations/google_cloud_platform + name: GCP Integration - description: 'The IP allowlist API is used to manage the IP addresses that can access the Datadog API and web UI. It does not block access to intake APIs or public dashboards. @@ -23856,11 +24661,11 @@ contacting Datadog support.' name: IP Allowlist - description: Create, update, delete, and retrieve services which can be associated with incidents. name: Incident Services -- description: Create, update, delete and retrieve teams which can be associated with - incidents. +- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/) + to create, update, delete, and retrieve teams which can be associated with incidents. name: Incident Teams - description: Manage incident response. name: Incidents - description: 'Manage your Datadog API and application keys. You need an API key and