Search API
The Search API provides powerful search capabilities for threat intelligence entities in the ThreatWinds platform. It allows you to search for entities using simple or advanced queries, retrieve entity details, and explore relationships between entities.
Overview
ThreatWinds Search API allows you to:
| Feature | Description |
|---|---|
| Simple Search | Search for threat intelligence entities using simple queries |
| Advanced Search | Perform complex searches with filters and aggregations |
| History Search | Search in the entity history |
| Entity Lookup | Retrieve detailed information about specific entities |
| Entity Relations | View relationships between entities |
| Comments | Access comments associated with entities |
| Entity Types | Browse a comprehensive list of entity types |
Authentication
Like all ThreatWinds APIs, the Search API requires authentication. You can authenticate using either:
| Authentication Method | Description |
|---|---|
| Authorization Header | Include a bearer token in the Authorization header |
| API Key and Secret | Include your API key and secret in the request headers |
For more details on authentication, see the Authentication section.
API Endpoints
The base URL for the Search API is:
https://apis.threatwinds.com/api/search/v1
For detailed information about each endpoint, please refer to the specific documentation pages.
Error Response Headers
All error responses include the following custom headers:
| Header | Description |
|---|---|
| x-error | Human-readable error message describing what went wrong |
| x-error-id | Unique MD5 hash identifier for error tracking and support |
Error Codes
| Status Code | Description | Possible Cause |
|---|---|---|
| 200 | OK | Request successful with results |
| 400 | Bad Request | Invalid query parameters, malformed JSON, or validation error |
| 401 | Unauthorized | Missing or invalid authentication credentials |
| 404 | Not Found | Entity not found, no search results, comments not found, or relations not found |
| 500 | Internal Server Error | OpenSearch operation failure or server-side error |