Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.36 KB

docs.md

File metadata and controls

33 lines (24 loc) · 2.36 KB

veracode-api-py docs

See the topics below for more information on how to use this library.

veracode-api-py provides two ways to access each method in the library. The library provides individual objects for key resource types (e.g. Applications, Users, Workspaces) on which indvidual methods can be called. Alternately, there is a single "API object" that lists all the methods in the library.

Scans, Findings, Applications and Policy

  • XML APIs - work with Veracode legacy XML APIs to access report data for individual scans and to perform static scans.
  • Healthcheck and Status - access information about the status of Veracode services.
  • Applications and Sandboxes - create, update, access, and delete application profiles and sandboxes.
  • Policy - create, update, access, and delete policy definitions.
  • Findings, Annotations, Summary Reports, and CWE and Category Metadata - retrieve findings and propose, accept, and reject mitigations. Get summary reports for applications. Get CWE and category metadata.
  • Collections - (EARLY ACCESS) create, update, access, and delete collections.
  • SCA Agent - access information about SCA workspaces, projects, issues, vulnerabilities, libraries, and licenses.
  • Dynamic Analysis - configure, schedule and start dynamic analyses (use with the Veracode Dynamic Analysis product).
  • DAST - configure, schedule, and run DAST Essentials scans (use with the Veracode DAST Essentials product).
  • Analytics - request and retrieve reports across your Veracode organization.

Administration

  • Users - create, update, access, and delete users.
  • Teams - create, update, access, and delete teams.
  • Business Units - create, update, access, and delete business units.
  • API Credentials - create, access, renew, and revoke API credentials.
  • Roles and Permissions - access system roles and permissions; create, update, access, and delete custom roles.
  • JIT Default Settings - create and update default Just-In-Time Provisioning settings.

API Object

You can use the library without importing individual methods by using the API() object.

  • API - use this object to access all methods in the veracode-api-py library.