taxii-api-root

Retrieves general information about a specific API root on a TAXII 2.x server. Fetches API root metadata such as supported TAXII versions and maximum content length.

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-api-root 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 to query. Required.

Output fields

Field	Type	Description
profile	string	Connect profile name
title	string	API root title
description	string	API root description
versions	array	List of TAXII versions supported by the API root
max_content_length	long	Maximum content size allowed by the API root (bytes)
_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

Sends a request to a specific API root endpoint on the TAXII server to retrieve its metadata. Both the profile and apiroot options are required. If an error occurs, the error message is recorded in the _error field of the corresponding record.

Examples

Retrieve TAXII API root information
```
taxii-api-root profile="my-taxii" apiroot="taxii"
```
Retrieves information about the taxii API root using the my-taxii connect profile.