Create or update an annotation

Creates or updates an individual annotation for the specified report. Annotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.

Just as reports, annotation needs to be uploaded with a unique ID that can later be used to identify the report as an alternative to the generated UUID. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001.

Sample cURL request:

curl --request PUT 'https://api.bitbucket.org/2.0/repositories/<username>/<reposity-name>/commit/<commit-hash>/reports/mySystem-001/annotations/mysystem-annotation001' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Security scan report",
    "annotation_type": "VULNERABILITY",
    "summary": "This line represents a security thread.",
    "severity": "HIGH",
    "path": "my-service/src/main/java/com/myCompany/mysystem/logic/Main.java",
    "line": 42
}'

Possible field values:

annotation_type: VULNERABILITY, CODE_SMELL, BUG result: PASSED, FAILED, IGNORED, SKIPPED severity: HIGH, MEDIUM, LOW, CRITICAL

Please refer to the Code Insights documentation for more information.

workspacestring required

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slugstring required

The repository.

commitstring required

The commit the report belongs to.

reportIdstring required

Either the uuid or external-id of the report.

annotationIdstring required

Either the uuid or external-id of the annotation.

Request body

typestring required

external_idstring

ID of the annotation provided by the annotation creator. It can be used to identify the annotation as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation. Needs to be unique.

uuidstring

The UUID that can be used to identify the annotation.

annotation_type'VULNERABILITY' | 'CODE_SMELL' | 'BUG'

The type of the report.

pathstring

The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository. If no path is provided, then it will appear in the overview modal on all pull requests where the tip of the branch is the given commit, regardless of which files were modified.

lineinteger

The line number that the annotation should belong to. If no line number is provided, then it will default to 0 and in a pull request it will appear at the top of the file specified by the path field.

summarystring

The message to display to users.

detailsstring

The details to show to users when clicking on the annotation.

result'PASSED' | 'FAILED' | 'SKIPPED' | 'IGNORED'

The state of the report. May be set to PENDING and later updated.

severity'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW'

The severity of the annotation.

linkstring uri

A URL linking to the annotation in an external tool.

created_onstring date-time

The timestamp when the report was created.

updated_onstring date-time

The timestamp when the report was updated.

Response

OK