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

- old
+ new

@@ -357,11 +357,11 @@ default: 0 example: 0 format: int64 type: integer PageSize: - description: Size for a given page. The maximum allowed value is 5000. + description: Size for a given page. The maximum allowed value is 100. in: query name: page[size] required: false schema: default: 10 @@ -475,10 +475,35 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Conflict + FindingsBadRequestResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Bad Request: The server cannot process the request due to invalid + syntax in the request.' + FindingsForbiddenResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Forbidden: Access denied' + FindingsNotFoundResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Not Found: The requested finding cannot be found.' + FindingsTooManyRequestsResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Too many requests: The rate limit set by the API has been exceeded.' ForbiddenResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' @@ -1313,10 +1338,43 @@ - MEDIAN - LATEST - EARLIEST - MOST_FREQUENT - DELTA + CIAppCIError: + description: Contains information of the CI error. + nullable: true + properties: + domain: + $ref: '#/components/schemas/CIAppCIErrorDomain' + message: + description: Error message. + maxLength: 5000 + nullable: true + type: string + stack: + description: The stack trace of the reported errors. + nullable: true + type: string + type: + description: Short description of the error type. + maxLength: 100 + nullable: true + type: string + type: object + CIAppCIErrorDomain: + description: Error category used to differentiate between issues related to + the developer or provider environments. + enum: + - provider + - user + - unknown + type: string + x-enum-varnames: + - PROVIDER + - USER + - UNKNOWN CIAppCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: $ref: '#/components/schemas/CIAppAggregationFunction' @@ -1349,10 +1407,56 @@ additionalProperties: $ref: '#/components/schemas/CIAppAggregateBucketValue' description: A map of the metric name to value for regular compute, or a list of values for a timeseries. type: object + CIAppCreatePipelineEventRequest: + description: Request object. + properties: + data: + $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData' + type: object + CIAppCreatePipelineEventRequestAttributes: + description: Attributes of the pipeline event to create. + properties: + env: + description: The Datadog environment. + type: string + resource: + $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource' + service: + description: If the CI provider is SaaS, use this to differentiate between + instances. + type: string + required: + - resource + type: object + CIAppCreatePipelineEventRequestAttributesResource: + description: Details of the CI pipeline event. + example: Details TBD + oneOf: + - $ref: '#/components/schemas/CIAppPipelineEventPipeline' + - $ref: '#/components/schemas/CIAppPipelineEventStage' + - $ref: '#/components/schemas/CIAppPipelineEventJob' + - $ref: '#/components/schemas/CIAppPipelineEventStep' + CIAppCreatePipelineEventRequestData: + description: Data of the pipeline event to create. + properties: + attributes: + $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributes' + type: + $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataType' + type: object + CIAppCreatePipelineEventRequestDataType: + default: cipipeline_resource_request + description: Type of the event. + enum: + - cipipeline_resource_request + example: cipipeline_resource_request + type: string + x-enum-varnames: + - CIPIPELINE_RESOURCE_REQUEST CIAppEventAttributes: description: JSON object containing all event attributes and their associated values. properties: attributes: @@ -1375,10 +1479,81 @@ tags: $ref: '#/components/schemas/TagsEventAttribute' timestamp: $ref: '#/components/schemas/TimestampEventAttribute' type: object + CIAppGitInfo: + description: 'If pipelines are triggered due to actions to a Git repository, + then all payloads must contain this. + + Note that either `tag` or `branch` has to be provided, but not both.' + nullable: true + properties: + author_email: + description: The commit author email. + example: author@example.com + format: email + type: string + author_name: + description: The commit author name. + example: John Doe + nullable: true + type: string + author_time: + description: The commit author timestamp in RFC3339 format. + example: '2023-05-31T15:30:00Z' + nullable: true + type: string + branch: + description: The branch name (if a tag use the tag parameter). + example: feature-1 + nullable: true + type: string + commit_time: + description: The commit timestamp in RFC3339 format. + example: '2023-05-31T15:30:00Z' + nullable: true + type: string + committer_email: + description: The committer email. + example: committer@example.com + format: email + nullable: true + type: string + committer_name: + description: The committer name. + nullable: true + type: string + default_branch: + description: The Git repository's default branch. + example: main + nullable: true + type: string + message: + description: The commit message. + example: Instrumenting tests with CI Visibility. + nullable: true + type: string + repository_url: + description: The URL of the repository. + example: https://github.com/username/repository + type: string + sha: + description: The git commit SHA. + example: da39a3ee5e6b4b0d3255bfef95601890afd80709 + pattern: ^[a-fA-F0-9]{40}$ + type: string + tag: + description: The tag name (if a branch use the branch parameter). + example: v1.0.0 + nullable: true + type: string + required: + - repository_url + - sha + - author_email + type: object CIAppGroupByHistogram: description: 'Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.' properties: @@ -1434,10 +1609,35 @@ format: double type: number CIAppGroupByTotalString: description: A string to use as the key value for the total bucket. type: string + CIAppHostInfo: + description: Contains information of the host running the pipeline, stage, job, + or step. + nullable: true + properties: + hostname: + description: FQDN of the host. + example: www.example.com + type: string + labels: + description: A list of labels used to select or identify the node. + example: + - ubuntu-18.04 + - n2.large + items: + type: string + type: array + name: + description: Name for the host. + type: string + workspace: + description: The path where the code is checked out. + example: /home/workspace/code/my-repo + type: string + type: object CIAppPipelineEvent: description: Object description of a pipeline event after being processed and stored by Datadog. properties: attributes: @@ -1447,18 +1647,505 @@ example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/CIAppPipelineEventTypeName' type: object + CIAppPipelineEventJob: + description: Details of a CI job. + properties: + dependencies: + description: A list of job IDs that this job depends on. + example: + - f7e6a006-a029-46c3-b0cc-742c9d7d363b + - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe + items: + description: A list of job IDs. + type: string + nullable: true + type: array + end: + description: Time when the job run finished. The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + error: + $ref: '#/components/schemas/CIAppCIError' + git: + $ref: '#/components/schemas/CIAppGitInfo' + id: + description: The UUID for the job. It has to be unique within each pipeline + execution. + example: c865bad4-de82-44b8-ade7-2c987528eb54 + type: string + level: + $ref: '#/components/schemas/CIAppPipelineEventJobLevel' + metrics: + $ref: '#/components/schemas/CIAppPipelineEventMetrics' + name: + description: The name for the job. + example: test + type: string + node: + $ref: '#/components/schemas/CIAppHostInfo' + parameters: + $ref: '#/components/schemas/CIAppPipelineEventParameters' + pipeline_name: + description: The parent pipeline name. + example: Build + type: string + pipeline_unique_id: + description: The parent pipeline UUID. + example: 76b572af-a078-42b2-a08a-cc28f98b944f + type: string + queue_time: + description: The queue time in milliseconds, if applicable. + example: 1004 + format: int64 + minimum: 0 + nullable: true + type: integer + stage_id: + description: The parent stage UUID (if applicable). + nullable: true + type: string + stage_name: + description: The parent stage name (if applicable). + nullable: true + type: string + start: + description: Time when the job run instance started (it should not include + any queue time). The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + status: + $ref: '#/components/schemas/CIAppPipelineEventJobStatus' + tags: + $ref: '#/components/schemas/CIAppPipelineEventTags' + url: + description: The URL to look at the job in the CI provider UI. + example: https://ci-platform.com/job/your-job-name/build/123 + type: string + required: + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status + - url + - git + type: object + CIAppPipelineEventJobLevel: + default: job + description: Used to distinguish between pipelines, stages, jobs, and steps. + enum: + - job + example: job + type: string + x-enum-varnames: + - JOB + CIAppPipelineEventJobStatus: + description: The final status of the job. + enum: + - success + - error + - canceled + - skipped + example: success + type: string + x-enum-varnames: + - SUCCESS + - ERROR + - CANCELED + - SKIPPED + CIAppPipelineEventMetrics: + description: A list of user-defined metrics. The metrics must follow the `key:value` + pattern and the value must be numeric. + example: + - bundle_size:370 + - build_time:50021 + items: + description: Metrics in the form of `key:value`. The value needs to be numeric. + type: string + nullable: true + type: array + CIAppPipelineEventParameters: + additionalProperties: + type: string + description: A map of key-value parameters or environment variables that were + defined for the pipeline. + example: + LOG_LEVEL: debug + nullable: true + type: object + CIAppPipelineEventParentPipeline: + description: If the pipeline is triggered as child of another pipeline, this + should contain the details of the parent pipeline. + nullable: true + properties: + id: + description: UUID of a pipeline. + example: 93bfeb70-af47-424d-908a-948d3f08e37f + type: string + url: + description: The URL to look at the pipeline in the CI provider UI. + example: https://ci-platform.com/pipelines/123456789 + type: string + required: + - id + type: object + CIAppPipelineEventPipeline: + description: Details of the top level pipeline, build, or workflow of your CI. + properties: + end: + description: Time when the pipeline run finished. The time format must be + RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + error: + $ref: '#/components/schemas/CIAppCIError' + git: + $ref: '#/components/schemas/CIAppGitInfo' + is_manual: + description: Whether or not the pipeline was triggered manually by the user. + example: false + nullable: true + type: boolean + is_resumed: + description: Whether or not the pipeline was resumed after being blocked. + example: false + nullable: true + type: boolean + level: + $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel' + metrics: + $ref: '#/components/schemas/CIAppPipelineEventMetrics' + name: + description: Name of the pipeline. All pipeline runs for the builds should + have the same name. + example: Deploy to AWS + type: string + node: + $ref: '#/components/schemas/CIAppHostInfo' + parameters: + $ref: '#/components/schemas/CIAppPipelineEventParameters' + parent_pipeline: + $ref: '#/components/schemas/CIAppPipelineEventParentPipeline' + partial_retry: + description: 'Whether or not the pipeline was a partial retry of a previous + attempt. A partial retry is one + + which only runs a subset of the original jobs.' + example: false + type: boolean + pipeline_id: + description: 'Any ID used in the provider to identify the pipeline run even + if it is not unique across retries. + + If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` + can be set to the same value.' + example: '#023' + type: string + previous_attempt: + $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline' + queue_time: + description: The queue time in milliseconds, if applicable. + example: 1004 + format: int64 + minimum: 0 + nullable: true + type: integer + start: + description: Time when the pipeline run started (it should not include any + queue time). The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + status: + $ref: '#/components/schemas/CIAppPipelineEventPipelineStatus' + tags: + $ref: '#/components/schemas/CIAppPipelineEventTags' + unique_id: + description: 'UUID of the pipeline run. The ID has to be unique across retries + and pipelines, + + including partial retries.' + example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a + type: string + url: + description: The URL to look at the pipeline in the CI provider UI. + example: https://my-ci-provider.example/pipelines/my-pipeline/run/1 + type: string + required: + - level + - unique_id + - name + - url + - start + - end + - status + - partial_retry + - git + type: object + CIAppPipelineEventPipelineLevel: + default: pipeline + description: Used to distinguish between pipelines, stages, jobs, and steps. + enum: + - pipeline + example: pipeline + type: string + x-enum-varnames: + - PIPELINE + CIAppPipelineEventPipelineStatus: + description: The final status of the pipeline. + enum: + - success + - error + - canceled + - skipped + - blocked + example: success + type: string + x-enum-varnames: + - SUCCESS + - ERROR + - CANCELED + - SKIPPED + - BLOCKED + CIAppPipelineEventPreviousPipeline: + description: If the pipeline is a retry, this should contain the details of + the previous attempt. + nullable: true + properties: + id: + description: UUID of a pipeline. + example: 93bfeb70-af47-424d-908a-948d3f08e37f + type: string + url: + description: The URL to look at the pipeline in the CI provider UI. + example: https://ci-platform.com/pipelines/123456789 + type: string + required: + - id + type: object + CIAppPipelineEventStage: + description: Details of a CI stage. + properties: + dependencies: + description: A list of stage IDs that this stage depends on. + example: + - f7e6a006-a029-46c3-b0cc-742c9d7d363b + - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe + items: + description: A list of stage IDs. + type: string + nullable: true + type: array + end: + description: Time when the stage run finished. The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + error: + $ref: '#/components/schemas/CIAppCIError' + git: + $ref: '#/components/schemas/CIAppGitInfo' + id: + description: UUID for the stage. It has to be unique at least in the pipeline + scope. + example: 562bdbbb-7cab-48c8-851c-b24ca14628bf + type: string + level: + $ref: '#/components/schemas/CIAppPipelineEventStageLevel' + metrics: + $ref: '#/components/schemas/CIAppPipelineEventMetrics' + name: + description: The name for the stage. + example: build + type: string + node: + $ref: '#/components/schemas/CIAppHostInfo' + parameters: + $ref: '#/components/schemas/CIAppPipelineEventParameters' + pipeline_name: + description: The parent pipeline name. + example: Build + type: string + pipeline_unique_id: + description: The parent pipeline UUID. + example: 76b572af-a078-42b2-a08a-cc28f98b944f + type: string + queue_time: + description: The queue time in milliseconds, if applicable. + example: 1004 + format: int64 + minimum: 0 + nullable: true + type: integer + start: + description: Time when the stage run started (it should not include any + queue time). The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + status: + $ref: '#/components/schemas/CIAppPipelineEventStageStatus' + tags: + $ref: '#/components/schemas/CIAppPipelineEventTags' + required: + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status + - git + type: object + CIAppPipelineEventStageLevel: + default: stage + description: Used to distinguish between pipelines, stages, jobs and steps. + enum: + - stage + example: stage + type: string + x-enum-varnames: + - STAGE + CIAppPipelineEventStageStatus: + description: The final status of the stage. + enum: + - success + - error + - canceled + - skipped + example: success + type: string + x-enum-varnames: + - SUCCESS + - ERROR + - CANCELED + - SKIPPED + CIAppPipelineEventStep: + description: Details of a CI step. + properties: + end: + description: Time when the step run finished. The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + error: + $ref: '#/components/schemas/CIAppCIError' + git: + $ref: '#/components/schemas/CIAppGitInfo' + id: + description: UUID for the step. It has to be unique within each pipeline + execution. + example: c2d517a8-4f3a-4b41-b4ae-69df0c864c79 + type: string + job_id: + description: The parent job UUID (if applicable). + nullable: true + type: string + job_name: + description: The parent job name (if applicable). + nullable: true + type: string + level: + $ref: '#/components/schemas/CIAppPipelineEventStepLevel' + metrics: + $ref: '#/components/schemas/CIAppPipelineEventMetrics' + name: + description: The name for the step. + example: test-server + type: string + node: + $ref: '#/components/schemas/CIAppHostInfo' + parameters: + $ref: '#/components/schemas/CIAppPipelineEventParameters' + pipeline_name: + description: The parent pipeline name. + example: Build + type: string + pipeline_unique_id: + description: The parent pipeline UUID. + example: 76b572af-a078-42b2-a08a-cc28f98b944f + type: string + stage_id: + description: The parent stage UUID (if applicable). + nullable: true + type: string + stage_name: + description: The parent stage name (if applicable). + nullable: true + type: string + start: + description: Time when the step run started. The time format must be RFC3339. + example: '2023-05-31T15:30:00Z' + format: date-time + type: string + status: + $ref: '#/components/schemas/CIAppPipelineEventStepStatus' + tags: + $ref: '#/components/schemas/CIAppPipelineEventTags' + url: + description: The URL to look at the step in the CI provider UI. + nullable: true + type: string + required: + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status + - git + type: object + CIAppPipelineEventStepLevel: + default: step + description: Used to distinguish between pipelines, stages, jobs and steps. + enum: + - step + example: step + type: string + x-enum-varnames: + - STEP + CIAppPipelineEventStepStatus: + description: The final status of the step. + enum: + - success + - error + example: success + type: string + x-enum-varnames: + - SUCCESS + - ERROR + CIAppPipelineEventTags: + description: A list of user-defined tags. The tags must follow the `key:value` + pattern. + example: + - team:backend + - type:deployment + items: + description: Tags in the form of `key:value`. + type: string + nullable: true + type: array CIAppPipelineEventTypeName: description: Type of the event. enum: - cipipeline example: cipipeline type: string x-enum-varnames: - - cipipeline + - CIPIPELINE CIAppPipelineEventsRequest: description: The request for a pipelines search. properties: filter: $ref: '#/components/schemas/CIAppPipelinesQueryFilter' @@ -1727,11 +2414,11 @@ enum: - citest example: citest type: string x-enum-varnames: - - citest + - CITEST CIAppTestEventsRequest: description: The request for a tests search. properties: filter: $ref: '#/components/schemas/CIAppTestsQueryFilter' @@ -3672,11 +4359,11 @@ items: $ref: '#/components/schemas/FastlyServiceResponse' type: array type: object Finding: - description: A single finding without message and resource configuration. + description: A single finding without the message and resource configuration. properties: attributes: $ref: '#/components/schemas/FindingAttributes' id: $ref: '#/components/schemas/FindingID' @@ -3730,47 +4417,53 @@ additionalProperties: false description: Information about the mute status of this finding. properties: description: description: Additional information about the reason why this finding is - muted. + muted or unmuted. example: To be resolved later type: string expiration_date: - description: The end of the mute period. + description: The expiration date of the mute or unmute action (Unix ms). example: 1778721573794 format: int64 type: integer muted: - description: Whether this finding is muted. + description: Whether this finding is muted or unmuted. 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. + description: The ID of the user who muted or unmuted this finding. example: e51c9744-d158-11ec-ad23-da7ad0900002 type: string type: object FindingMuteReason: - description: The reason why this finding is muted. + description: The reason why this finding is muted or unmuted. enum: - - ACCEPTED_RISK - PENDING_FIX - FALSE_POSITIVE + - ACCEPTED_RISK + - NO_PENDING_FIX + - HUMAN_ERROR + - NO_LONGER_ACCEPTED_RISK - OTHER example: ACCEPTED_RISK type: string x-enum-varnames: - - ACCEPTED_RISK - PENDING_FIX - FALSE_POSITIVE + - ACCEPTED_RISK + - NO_PENDING_FIX + - HUMAN_ERROR + - NO_LONGER_ACCEPTED_RISK - OTHER FindingResource: description: The resource name of this finding. example: my_resource_name type: string @@ -4132,10 +4825,35 @@ items: description: A single tag that applies to a single response value. example: env:production type: string type: array + HTTPCIAppError: + description: List of errors. + properties: + detail: + description: Error message. + example: Malformed payload + type: string + status: + description: Error code. + example: '400' + type: string + title: + description: Error title. + example: Bad Request + type: string + type: object + HTTPCIAppErrors: + description: Errors occurred. + properties: + errors: + description: Structured errors. + items: + $ref: '#/components/schemas/HTTPCIAppError' + type: array + type: object HTTPLog: description: Structured log message. items: $ref: '#/components/schemas/HTTPLogItem' type: array @@ -6095,10 +6813,38 @@ items: description: An empty error list. type: string type: array type: object + JSONAPIErrorItem: + description: API error response body + properties: + detail: + description: A human-readable explanation specific to this occurrence of + the error. + example: Missing required attribute in body + type: string + status: + description: Status code of the response. + example: '400' + type: string + title: + description: Short human-readable summary of the error. + example: Bad Request + type: string + type: object + JSONAPIErrorResponse: + description: API error response. + properties: + errors: + description: A list of errors. + items: + $ref: '#/components/schemas/JSONAPIErrorItem' + type: array + required: + - errors + type: object JiraIntegrationMetadata: description: Incident integration metadata for the Jira integration. properties: issues: description: Array of Jira issues in this integration metadata. @@ -8469,10 +9215,143 @@ type: string type: description: The monitor type. type: string type: object + MuteFindingRequest: + description: The new mute finding request. + properties: + data: + $ref: '#/components/schemas/MuteFindingRequestData' + required: + - data + type: object + MuteFindingRequestAttributes: + additionalProperties: false + description: The mute properties to be updated. + properties: + mute: + $ref: '#/components/schemas/MuteFindingRequestProperties' + required: + - mute + type: object + MuteFindingRequestData: + description: Data object containing the new mute properties of the finding. + properties: + attributes: + $ref: '#/components/schemas/MuteFindingRequestAttributes' + id: + $ref: '#/components/schemas/FindingID' + type: + $ref: '#/components/schemas/FindingType' + required: + - id + - type + - attributes + type: object + MuteFindingRequestProperties: + additionalProperties: false + description: Object containing the new mute properties of the finding. + properties: + description: + description: Additional information about the reason why this finding is + muted or unmuted. This field has a maximum limit of 280 characters. + example: To be resolved later + type: string + expiration_date: + description: 'The expiration date of the mute or unmute action (Unix ms). + It must be set to a value greater than the current timestamp. + + If this field is not provided, the finding will be muted or unmuted indefinitely, + which is equivalent to setting the expiration date to 9999999999999. + + ' + example: 1778721573794 + format: int64 + type: integer + muted: + description: Whether this finding is muted or unmuted. + example: true + type: boolean + reason: + $ref: '#/components/schemas/FindingMuteReason' + required: + - muted + - reason + type: object + MuteFindingResponse: + description: The expected response schema. + properties: + data: + $ref: '#/components/schemas/MuteFindingResponseData' + required: + - data + type: object + MuteFindingResponseAttributes: + 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/MuteFindingResponseProperties' + 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 + MuteFindingResponseData: + description: Data object containing the updated finding. + properties: + attributes: + $ref: '#/components/schemas/MuteFindingResponseAttributes' + id: + $ref: '#/components/schemas/FindingID' + type: + $ref: '#/components/schemas/FindingType' + type: object + MuteFindingResponseProperties: + additionalProperties: false + description: Information about the mute status of this finding. + properties: + description: + description: 'Additional information about the reason why this finding is + muted or unmuted. + + This attribute will not be included in the response if the description + is not provided in the request body. + + ' + example: To be resolved later + type: string + expiration_date: + description: 'The expiration date of the mute or unmute action. + + If the expiration date is not provided in the request body, this attribute + will not be included in the response and the finding will be muted or + unmuted indefinitely. + + ' + example: 1778721573794 + format: int64 + type: integer + muted: + description: Whether this finding is muted or unmuted. + example: true + type: boolean + reason: + $ref: '#/components/schemas/FindingMuteReason' + type: object NullableRelationshipToUser: description: Relationship to user. properties: data: $ref: '#/components/schemas/NullableRelationshipToUserData' @@ -13611,11 +14490,11 @@ nullable: true 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 @@ -13626,11 +14505,11 @@ format: date-time type: string name: description: The name of the team example: Example Team - maxLength: 64 + maxLength: 200 type: string summary: description: A brief summary of the team, derived from the `description` maxLength: 120 nullable: true @@ -13962,16 +14841,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 name: description: The name of the team example: Example Team - maxLength: 64 + maxLength: 200 type: string required: - handle - name type: object @@ -14719,20 +15598,34 @@ dashboards_write: Create and change dashboards. events_read: Read Events data. incident_read: View incidents in Datadog. incident_settings_write: Configure Incidents settings. incident_write: Create, view, and manage incidents in Datadog. + metric_tags_write: Create and edit tag configurations for custom metrics. metrics_read: View custom metrics. monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. + org_management: Edit organization configurations, including authentication + and certain security preferences. 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_findings_write: Mute CSPM Findings. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. + synthetics_default_settings_read: View the default settings for Synthetic + Monitoring. + synthetics_default_settings_write: Create and edit default settings for + Synthetic Monitoring. + teams_manage: Manage Teams. Create, delete, rename, and edit the metadata + of all Teams. To control Team membership across all Teams, use the User + Access Manage permission. + teams_read: Read Teams data. View Team names, metadata, and which users + are on each Team. timeseries_query: Query Timeseries data. 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. @@ -15542,10 +16435,84 @@ summary: Edit an AuthN Mapping tags: - AuthN Mappings x-codegen-request-body-name: body x-permission: OR(USER_ACCESS_MANAGE) + /api/v2/ci/pipeline: + post: + description: 'Send your pipeline event to your Datadog platform over HTTP. For + details about how pipeline executions are modeled and what execution types + we support, see the [guide](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). + + + This API endpoint is in private beta.' + operationId: CreateCIAppPipelineEvent + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CIAppCreatePipelineEventRequest' + required: true + responses: + '202': + content: + application/json: + schema: + type: object + description: Request accepted for processing + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Unauthorized + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Forbidden + '408': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Request Timeout + '413': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Payload Too Large + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Too Many Requests + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Internal Server Error + '503': + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPCIAppErrors' + description: Service Unavailable + summary: Send pipeline event + tags: + - CI Visibility Pipelines + x-codegen-request-body-name: body /api/v2/ci/pipelines/analytics/aggregate: post: description: The API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. operationId: AggregateCIAppPipelineEvents @@ -15573,11 +16540,11 @@ - CI Visibility Pipelines x-codegen-request-body-name: body /api/v2/ci/pipelines/events: get: description: 'List endpoint returns CI Visibility pipeline events that match - a log search query. + a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest pipeline events.' @@ -15652,11 +16619,11 @@ limitParam: page[limit] resultsPath: data /api/v2/ci/pipelines/events/search: post: description: 'List endpoint returns CI Visibility pipeline events that match - a log search query. + a [log search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' @@ -15717,12 +16684,12 @@ tags: - CI Visibility Tests x-codegen-request-body-name: body /api/v2/ci/tests/events: get: - description: 'List endpoint returns CI Visibility test events that match a log - search query. + description: 'List endpoint returns CI Visibility test events that match a [log + search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest test events.' @@ -15796,12 +16763,12 @@ cursorPath: meta.page.after limitParam: page[limit] resultsPath: data /api/v2/ci/tests/events/search: post: - description: 'List endpoint returns CI Visibility test events that match a log - search query. + description: 'List endpoint returns CI Visibility test events that match a [log + search query](https://docs.datadoghq.com/logs/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' @@ -16270,11 +17237,11 @@ x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-unstable: '**Note**: This endpoint is in private beta. + x-unstable: '**Note**: This endpoint is in beta. For access, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/events/search: post: description: 'List endpoint returns events that match an events search query. @@ -16315,11 +17282,11 @@ x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-unstable: '**Note**: This endpoint is in private beta. + x-unstable: '**Note**: This endpoint is in beta. For access, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents: get: description: Get all incidents for the user's organization. @@ -19769,17 +20736,20 @@ `<=`). 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" + the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery + parameters must be only among the documented ones and with values of correct + types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) + are not allowed.\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 @@ -19875,21 +20845,17 @@ application/json: schema: $ref: '#/components/schemas/ListFindingsResponse' description: OK '400': - content: - application/json: - schema: - $ref: '#/components/schemas/APIErrorResponse' - description: Bad Request + $ref: '#/components/responses/FindingsBadRequestResponse' '403': - $ref: '#/components/responses/ForbiddenResponse' + $ref: '#/components/responses/FindingsForbiddenResponse' '404': - $ref: '#/components/responses/NotFoundResponse' + $ref: '#/components/responses/FindingsNotFoundResponse' '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: '#/components/responses/FindingsTooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - security_monitoring_findings_read @@ -19930,29 +20896,94 @@ application/json: schema: $ref: '#/components/schemas/GetFindingResponse' description: OK '400': + $ref: '#/components/responses/FindingsBadRequestResponse' + '403': + $ref: '#/components/responses/FindingsForbiddenResponse' + '404': + $ref: '#/components/responses/FindingsNotFoundResponse' + '429': + $ref: '#/components/responses/FindingsTooManyRequestsResponse' + 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/).' + patch: + description: 'Mute or unmute a specific finding. + + The API returns the updated finding object when the request is successful.' + operationId: UpdateFinding + parameters: + - description: The ID of the finding. + in: path + name: finding_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MuteFindingRequest' + description: 'To mute or unmute a finding, the request body should include + at least two attributes: `muted` and `reason`. The allowed reasons depend + on whether the finding is being muted or unmuted: + + - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`. + + - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`, + `OTHER`. + + ' + required: true + responses: + '200': content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: Bad Request + $ref: '#/components/schemas/MuteFindingResponse' + description: OK + '400': + $ref: '#/components/responses/FindingsBadRequestResponse' '403': - $ref: '#/components/responses/ForbiddenResponse' + $ref: '#/components/responses/FindingsForbiddenResponse' '404': - $ref: '#/components/responses/NotFoundResponse' + $ref: '#/components/responses/FindingsNotFoundResponse' + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Resource Conflict: The finding has already been muted or unmuted + within the last 60 seconds.' + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: 'Invalid Request: The server understands the request syntax + but cannot process it due to invalid data.' '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: '#/components/responses/FindingsTooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - - security_monitoring_findings_read - summary: Get a finding + - security_monitoring_findings_write + summary: Mute or unmute a finding tags: - Security Monitoring + 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/processes: get: @@ -21971,10 +23002,12 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error + '404': + $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete Scanning Group tags: - Sensitive Data Scanner @@ -22015,10 +23048,12 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error + '404': + $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Update Scanning Group tags: - Sensitive Data Scanner @@ -22097,10 +23132,12 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error + '404': + $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Delete Scanning Rule tags: - Sensitive Data Scanner @@ -22140,10 +23177,12 @@ content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error + '404': + $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Update Scanning Rule tags: - Sensitive Data Scanner @@ -24609,10 +25648,11 @@ is used to automatically map group of users to roles in Datadog using attributes sent from Identity Providers.' name: AuthN Mappings -- description: Search or aggregate your CI Visibility pipeline events over HTTP. +- description: Search or aggregate your CI Visibility pipeline events and send them + to your Datadog site over HTTP. name: CI Visibility Pipelines - description: Search or aggregate your CI Visibility test events over HTTP. name: CI Visibility Tests - description: Workload activity security rules for generating events using the Datadog security Agent.