PATCH

/findings/batchupdate

http://securityhub.{region}.amazonaws.com/findings/batchupdate

Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from <code>BatchUpdateFindings</code> do not affect the value of <code>UpdatedAt</code> for a finding. Administrator and member accounts can use <code>BatchUpdateFindings</code> to update the following finding fields and objects. <ul> <li> <code>Confidence</code> </li> <li> <code>Criticality</code> </li> <li> <code>Note</code> </li> <li> <code>RelatedFindings</code> </li> <li> <code>Severity</code> </li> <li> <code>Types</code> </li> <li> <code>UserDefinedFields</code> </li> <li> <code>VerificationState</code> </li> <li> <code>Workflow</code> </li> </ul> You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access">Configuring access to BatchUpdateFindings</a> in the Security Hub User Guide.

Access Token Required: API Key

Body Params

Noteobject

The updated note.

Typesarray

One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are as follows. <ul> <li> Software and Configuration Checks </li> <li> TTPs </li> <li> Effects </li> <li> Unusual Behaviors </li> <li> Sensitive Data Identifications </li> </ul>

Severityobject

Updates to the severity information for a finding.

Workflowobject

Used to update information about the investigation into the finding.

Confidenceinteger

The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

Criticalityinteger

The updated value for the level of importance assigned to the resources associated with the findings. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

RelatedFindingsarray

A list of findings that are related to the updated findings.

UserDefinedFieldsobject

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

VerificationStatestring

Indicates the veracity of a finding. The available values for <code>VerificationState</code> are as follows. <ul> <li> <code>UNKNOWN</code> – The default disposition of a security finding </li> <li> <code>TRUE_POSITIVE</code> – The security finding is confirmed </li> <li> <code>FALSE_POSITIVE</code> – The security finding was determined to be a false alarm </li> <li> <code>BENIGN_POSITIVE</code> – A special case of <code>TRUE_POSITIVE</code> where the finding doesn't pose any threat, is expected, or both </li> </ul>

FindingIdentifiersarrayrequired

The list of findings to update. <code>BatchUpdateFindings</code> can be used to update up to 100 findings at a time. For each finding, the list provides the finding identifier and the ARN of the finding provider.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://securityhub.{region}.amazonaws.com/findings/batchupdate' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}