Skip to main content

Annotations REST API

You can use the Annotations API to annotate findings, including adding comments and proposing, accepting, and rejecting mitigations. This API applies to findings from a Static Analysis or Dynamic Analysis.

Permissions​

Before you can use all endpoints of this API, you must have one of the following accounts with the required roles:

  • A UI user account with the following roles:

    • Reviewer or Security Lead: to add comments or propose mitigations.
    • Mitigation Approver: to approve or reject mitigation proposals.

  • An API user account with the following roles:

    • Results API: to add comments or propose mitigations.
    • Mitigation API: to approve or reject mitigation proposals.

Authentication​

This API requires secure authentication to Veracode.

Annotations API specification​

The Annotations API specification is available from SwaggerHub.

Last updated on