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
| Property | Description |
|---|---|
| Command type | Driver query |
| Required permission | User permission |
| License usage | Not counted |
| Parallel execution | Not supported |
| Distributed execution | Not 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
| Field | Type | Description |
|---|---|---|
| profile | string | Connect profile name |
| title | string | TAXII server title |
| description | string | TAXII server description |
| contact | string | TAXII server administrator contact |
| api_roots | array | List of API root URLs provided by the server |
| _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 |
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
-
Retrieve TAXII server general information
taxii-discovery profile="my-taxii"Retrieves the Discovery information of the TAXII server using the
my-taxiiconnect profile.