API Documentation

tip

The Spectra Analyze API documentation is now also available as an Open API specification, accessible from the Help > API Docs item from the main menu. Authorizing the API docs using a valid appliance token makes it possible to send API requests directly from there.

The Spectra Analyze appliance provides a number of REST APIs that allow seamless integration with automated workflows.

In order to send requests and interact with the APIs, users need to authenticate to the appliance with their API tokens.

A prerequisite for receiving an API token is an existing, active user account on the appliance. Prior to using any of the APIs, users should request a token as described in the following section.

For additional workflows, such as scanning entire directories, see our SDK documentation and its cookbook.

📄️ How to Obtain a Token for API Authentication

Authentication tokens are mandatory for all interactions with the Spectra Analyze appliance APIs.

📄️ Licensing API

Spectra Analyze Licensing API for generating machine IDs, uploading licenses, and monitoring license status for appliance management.

📄️ Submissions API

Spectra Analyze Submissions API enables programmatic submission of files and URLs for static analysis and malware detection.

📄️ Processing Status API

Spectra Analyze Processing Status API monitors analysis progress for submitted files and URLs with real-time status updates.

📄️ Download API

Download samples from the appliance to local storage.

📄️ Reanalyze Local Samples API V1

Reanalyze one or more samples with selected services (V1).

📄️ Reanalyze Local Samples API V2

Reanalyze one or more samples with selected services (V2).

📄️ Delete API

Spectra Analyze Delete API enables removal of malware samples and associated analysis data from the appliance with bulk operation support.

📄️ Tags API

Create, delete or retrieve user tags for any sample on the appliance.

📄️ Extracted Files API

List and download files extracted from a local sample.

📄️ PDF Report API

Download a PDF report of the analysis results for any sample on the appliance.

📄️ Report Summary API

Retrieve a summary of the analysis report for local samples.

📄️ Full Report API

Retrieve a detailed analysis report for local samples.

📄️ Static Analysis Report API

Retrieve the Spectra Core (static) analysis results for a local sample.

📄️ Dynamic Analysis Report API

Create and download PDF or HTML reports for samples that have gone through dynamic analysis.

📄️ Classification Status API

Spectra Analyze Classification Status API retrieves threat classification, risk scores, and detection status for analyzed samples.

📄️ Set Classification API

Override the classification of a sample, either locally or in the Spectra Intelligence cloud.

📄️ YARA API

Retrieve YARA ruleset lists or their contents, create new rulesets, delete or update existing rulesets.

📄️ YARA Retro API

Allows users to initiate or stop a local retro scan, manage cloud retro scans and check the YARA retro status on the appliance.

📄️ YARA Repository Management API

Managing YARA repositories and rulesets, including repository creation, update, deletion, job scheduling, and ruleset publishing.

📄️ Advanced Search API

Search for samples available on the local Spectra Analyze instance and Spectra Intelligence using the Advanced Search capabilities.

📄️ Containers API

Get a list of all top-level containers from which the requested sample has been extracted during analysis.

📄️ Network Threat Intelligence API

Spectra Analyze Network Threat Intelligence API provides reputation data and threat analysis for URLs, domains, and IP addresses.

📄️ Redundant Status API

Check if the Spectra Analyze instance is a primary in the redundant cluster.

📄️ Timezone API

Spectra Analyze Timezone API for setting and querying system timezones to control appliance date and time display preferences.

📄️ Deprecated Endpoints

Spectra Analyze deprecated API endpoints with migration guidance for updated versions and alternative implementations.