Get Objects
Fetch STIX objects from a specific collection with optional filtering and pagination.
Authorizations
Encode your credentials in the format taxii2:<YOUR_API_KEY> using Base64 and include them in the Authorization header. An API key is required for all requests.
Some tools require a username and password separately. Use taxii2 as the username and your API key as the password. The client will automatically encode this as taxii2:<YOUR_API_KEY> and convert to Base64.
If using Try It: Use the username/password method for HTTP Basic Authorization.
Headers
Media type used for content negotiation. Use application/taxii+json;version=2.1 for TAXII requests.
Standard method required by the TAXII specification. Use in production environments.
Path Parameters
ID of the collection to query. Use one of the available collection IDs.
Query Parameters
Media type used for content negotiation. Use application/taxii+json;version=2.1 for TAXII requests.
Specific to Pulsedive's implementation. Best for testing and debugging, manual API exploration, and simple curl commands. For production deployments, use HTTP Accept Header.
Indicates whether to format returned JSON results.
For pretty-printed output, set to 1. For compact output, set to 0.
0, 1 Maximum number of results to return per page.
Used with Next Token pagination.
x <= 1000Token that indicates the next set of results to retrieve. Should match the next token provided in the previous response.
Used with Next Token Pagination.
Timestamp filter. Returns only objects added after the specified time. UTC (YYYY-MM-DDTHH:MM:SS.MMMZ) or Pulsedive (YYYY-MM-DD HH:MM:SS) format.
Used with Time-Based Pagination.
Filter by STIX object type(s). Supports comma-separated list for multiple types.
For available STIX Domain Object types, see the STIX specification.
To learn more, visit Filtering.
"indicator"
Filter by STIX object version(s). Supports comma-separated list for multiple versions.
Accepts keywords (first, last, all) or timestamps in STIX (YYYY-MM-DDTHH:MM:SS.MMMZ) or Pulsedive (YYYY-MM-DD HH:MM:SS) format. Pulsedive doesn't maintain object version history, so first, last, and all will return the latest object version.
To learn more, visit Filtering.
Response
Successful request. Returns object information in JSON format.
Indicates whether additional results are available. Use the next field to retrieve them. Used with pagination.
false
Pagination token for retrieving the next set of results. Only present when more is true. Used with pagination.
"2018-01-01 00:00:00|1000"
Array of STIX 2.1 objects. The first two objects are always system objects, followed by query results:
-
identity: Identifies the Pulsedive organization. Conforms to the STIX 2.1 specification for the STIX Identity Domain Object. -
extension-definition: Defines Pulsedive custom extended properties for the STIX Indicator Domain Object. -
Query results: STIX objects that conform to the STIX 2.1 specification.
For indicators:
- STIX Indicator Domain Object, plus Pulsedive extended properties defined in the
extension-definitionobject.
For threats, the appropriate object:
- STIX Indicator Domain Object, plus Pulsedive extended properties defined in the
- Pulsedive Indicator Extension
- Extended STIX Indicator Properties