taxii-discovery

Sends a Discovery request to a TAXII 2.x server to retrieve general server information including a list of API roots. Connects to the TAXII server endpoint configured in the connect profile to fetch server information.

Command properties

PropertyDescription
Command typeDriver query
Required permissionUser permission
License usageNot counted
Parallel executionNot supported
Distributed executionNot supported

Syntax

taxii-discovery [profile=profile_name]

Options

profile=profile_name
Name of the TAXII connect profile to use. You can specify multiple profiles separated by commas. If omitted, all available registered TAXII profiles are automatically selected.

Output fields

FieldTypeDescription
profilestringConnect profile name
titlestringTAXII server title
descriptionstringTAXII server description
contactstringTAXII server administrator contact
api_rootsarrayList of API root URLs provided by the server
_errorstringError message if an error occurs

Error codes

Parsing errors
Error codeMessageDescription
201800No available TAXII profile found.No available TAXII profile exists
201801Specify valid TAXII profile.The specified TAXII profile name is invalid

Description

Sends a request to the TAXII Discovery endpoint to retrieve the list of API roots provided by the server and the server's general information. If the profile option is omitted, all available registered TAXII-type connect profiles are queried, and one record is output for each profile. If an error occurs, the error message is recorded in the _error field of the corresponding record.

Examples

  1. Retrieve TAXII server general information

    taxii-discovery profile="my-taxii"
    

    Retrieves the Discovery information of the TAXII server using the my-taxii connect profile.