Skip to content

Managed Services Platform API Reference

The API provided with the Managed Services Platform (MSP) gives you the means to automate the delivery and the scheduling of your security assessments.

The Managed Services Platform Guide describes general aspects of the MSP product, and how to use its Web interface. This API Reference describes the Application Programming Interface to the MSP. This API is a RESTful interface; in other words, it provides a set of requests that are called via Web URLs.

In general, these requests automate actions that otherwise you would have to perform by using the Web interface to the Managed Services Platform. If your organization uses continuous integration (CI) as its development model, MSP API calls can merge the use of MSP into your integration and build process, minimizing the amount of hands-on management of risk assessment.

These are tasks you can accomplish with API calls:

  • Submit a request for security assessment (a scan) at the end of a release cycle; for example, once a month
  • Upload the files required to run that scan
  • Retrieve assessment reports after the scan has completed
  • Create and update customer records
  • Extend the term of a service
  • Update the information that accompanies a scheduled scan

Each Part in this Reference describes the request calls associated with a particular feature or resource of the Managed Services Platform.

  • Managed Services API General Notes
    To use the Managed Services API, knowing a little background information can help.
  • API Token Management
    You can generate or revoke a token through the Managed Services API once you've presented verifiable credentials. You can also retrieve a token's details or retrieve information for all tokens.
  • Services
    These API request calls manage current and available assessment services.
  • Products (Assessment Types)
    These API request calls manage current and available products (assessment types).
  • Targets
    These API request calls manage targets in the MSP.
  • Target Groups
    This API request call helps manage target groups in the MSP.
  • Scans
    Creating assessment scans is the goal of the Managed Services Platform.
  • Reports
    These API request calls manage reports that assessments have produced.
  • Managed Services and Integration Tools
    With the Managed Services API, you can integrate code analysis with an automated integration tool such as Jenkins®.