About Spectra Assure Portal API

The Spectra Assure Portal API helps you automate common actions and use the Portal Projects features more efficiently.

Spectra Assure Portal API is designed to help you:

• Speed up workflows in your development and DevOps teams
• Integrate with other software supply chain security tools
• Build your own solutions around Spectra Assure Portal functionalities

With the Spectra Assure Portal API, you can:

• Upload a package version, analyze it, and create a diff against a previously scanned version
• Export analysis reports for a package version in all supported formats
• Show the analysis status and download the package version artifact

• Create, edit, and delete projects and packages
• Update package version metadata and release status
• Retrieve information about groups in your Portal organization

• Manage approval status for package versions
• Reanalyze package versions to synchronize them with updated configuration or engine
• Export the RL-SAFE archive for a package version

Read the full API reference docs for a detailed overview of all supported API features.

Supported Portal features

The Portal API only supports the Portal Projects features. Working with the File Stream through the API is not supported.

Get started with the Portal API

• Request a Portal account if you don't already have one.

• In your Portal account, create a Personal Access Token or ask an administrator to create it for you.

• Download the OpenAPI definition (formerly called "Swagger") for the Spectra Assure Portal API either as a YAML or a JSON file.

  • OpenAPI as YAML

  • OpenAPI as JSON

  Then you can import the OpenAPI file into tools like Postman and Insomnia to start sending requests.

  Some API tools may warn you about formatting errors when importing the OpenAPI files. That is because our documentation uses custom OpenAPI extensions. Those warnings are safe to ignore.

Spectra Assure Portal SDK

ReversingLabs provides an official Python SDK (software development kit) for the Spectra Assure Portal. You can use it to integrate the Portal and interact with it in your own applications. The SDK provides access to operations supported by the Portal API.

You can install the SDK library directly from PyPI as spectra-assure-sdk.

For usage instructions and examples, refer to the documentation in the SDK GitHub repository.

Learn more

• Browse the documentation on this website. Use the navigation sidebar to discover content by type and topic, or look up specific keywords in the search bar.

• Learn how to work with other ReversingLabs products in the official documentation.

• Access the ReversingLabs Content Library for a wealth of learning resources about our products and technology.