taxii-collections

Retrieves the list of collections and the metadata of each collection from a specific API root on a TAXII 2.x server. You can check read/write permissions and supported media types for each collection.

Command properties

Property	Description
Command type	Driver query
Required permission	User permission
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

taxii-collections profile=profile_name apiroot=api_root_name

Options

profile=profile_name: Name of the TAXII connect profile to use. You can specify multiple profiles separated by commas.
apiroot=api_root_name: Name of the TAXII API root from which to retrieve the collection list. Required.

Output fields

Field	Type	Description
profile	string	Connect profile name
id	string	Collection GUID
title	string	Collection title
description	string	Collection description
media_types	array	List of media types supported by the collection
can_read	boolean	Whether the collection is readable (`true`: readable)
can_write	boolean	Whether the collection is writable (`true`: writable)
_error	string	Error message if an error occurs

Error codes

Parsing errors

Error code	Message	Description
201800	No available TAXII profile found.	No available TAXII profile exists
201801	Specify valid TAXII profile.	The specified TAXII profile name is invalid
201802	Specify apiroot option	The `apiroot` option was not specified

Description

Retrieves the list of collections provided by a specific API root on the TAXII server. Each collection produces one record, and you can check the collection ID, title, and read/write permissions. Use the collection ID confirmed with this command when querying objects within a collection using the taxii-objects command.

Examples

Retrieve the collection list for an API root
```
taxii-collections profile="my-taxii" apiroot="taxii"
```
Retrieves the collection list for the taxii API root using the my-taxii connect profile.