Spectra Analyze API Documentation — REST Endpoints & Authentication

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.

📄️ API Tokens

Generate API tokens for Spectra Analyze REST API authentication. Covers token creation via Authentication API and Administration panel.

📄️ Licensing API

Generate machine IDs, upload license files, and check license status on Spectra Analyze appliances using the Licensing API endpoints.

📄️ Submissions API

Submit files and URLs to Spectra Analyze via REST API. POST /api/submit/file/ and /api/submit/url/ endpoints with tags, metadata, and analysis options.

📄️ Processing Status API

Check analysis status for submitted files on Spectra Analyze. POST /api/samples/status/ returns processed or not_found status for hash queries.

📄️ Download API

Download analyzed samples from Spectra Analyze to local storage. GET /api/samples/{hash}/download/ returns password-protected ZIP files.

📄️ Reanalyze API V1

Reanalyze existing samples on Spectra Analyze with Spectra Core, Spectra Intelligence, or dynamic analysis services using V1 endpoints.

📄️ Reanalyze API V2

Reanalyze multiple samples on Spectra Analyze with independently selectable services including Spectra Core, Cloud Sandbox, Cuckoo, Joe, and VMRay.

📄️ Delete API

Delete samples and analysis data from Spectra Analyze. DELETE /api/samples/{hash}/ removes files, metadata, and extracted children.

📄️ Tags API

Add, remove, and list user tags for samples on Spectra Analyze. GET/POST/DELETE /api/samples/{hash}/usertags/ for custom sample organization.

📄️ Extracted Files API

List and download files extracted by Spectra Core from analyzed samples on Spectra Analyze.

📄️ PDF Report API

Create, check status, and download PDF analysis reports for samples on Spectra Analyze via three-step API workflow.

📄️ Report Summary API

Retrieve analysis report summaries for samples on Spectra Analyze. POST /api/samples/v2/list/ returns classification, risk, and metadata.

📄️ Full Report API

Get complete analysis reports for samples on Spectra Analyze. POST /api/samples/v2/list/details/ returns static, dynamic, and cloud results.

📄️ Static Analysis Report API

Retrieve Spectra Core static analysis reports for samples on Spectra Analyze. GET /api/v2/samples/{hash}/ticore/ endpoint with field selection.

📄️ Dynamic Analysis Report API

Generate and download PDF or HTML reports for samples analyzed in ReversingLabs Cloud Sandbox via Spectra Analyze API.

📄️ Classification Status API

Retrieve threat classification, risk score, and detection status for samples in Spectra Analyze, with optional Spectra Intelligence fallback for unknown samples.

📄️ Set Classification API

Override sample classifications on Spectra Analyze or Spectra Intelligence. POST /api/samples/{hash}/setclassification/ for local or cloud overrides.

📄️ YARA API

Manage YARA rulesets on Spectra Analyze: list, create, update, and delete rulesets. GET/POST/DELETE /api/yara/v2/rulesets/ endpoints.

📄️ YARA Retro API

Start, stop, and monitor YARA retroactive hunts on Spectra Analyze for local and cloud retro scans via API endpoints.

📄️ YARA Repository Management API

Manage YARA repositories on Spectra Analyze: create, update, delete repositories, schedule sync jobs, and publish rulesets via API.

📄️ Advanced Search API

Search samples on Spectra Analyze and Spectra Intelligence using field queries, pagination, and sorting. POST /api/samples/v3/search/ endpoint reference.

📄️ Containers API

Retrieve top-level container files from which requested samples were extracted during Spectra Analyze static analysis, supporting bulk hash lookups.

📄️ Network Threat Intelligence API

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

📄️ Redundant Status API

Check whether a Spectra Analyze instance is the primary node in a redundant cluster using the cluster_primary endpoint.

📄️ Timezone API

Set and query system timezone on Spectra Analyze appliances to control date and time display preferences via API.

📄️ Deprecated Endpoints

Spectra Analyze deprecated API endpoints including Advanced Search V2 and Classification V1, with migration guidance for current endpoint versions.