Axonius
The Axonius connector enables seamless integration with the Axonius platform, allowing for automated asset management and security policy enforcement.
Axonius is a cybersecurity asset management platform that provides comprehensive asset inventory, policy enforcement, and risk assessment. The Axonius Turbine Connector enables Swimlane users to automate asset data collection, streamline CSV exports, and conduct detailed investigations directly within the Swimlane platform. By integrating with Axonius, security teams can enhance visibility, maintain compliance, and accelerate incident response by leveraging real-time asset intelligence and vulnerability insights.
This Connector integrates Axonius API with Swimlane Turbine.
Prerequisites
To effectively utilize the Axonius connector for Turbine, ensure you have the following prerequisites:
- API Key Authentication with the following parameters:
- URL: The endpoint URL for the Axonius API.
- API Key: Your unique identifier to authenticate with the Axonius API.
- API Secret: A secret key paired with your API Key for enhanced security.
Capabilities
This Connector provides the following capabilities:
- Get Asset By ID
- Get Asset Investigation
- Get Assets
- Get Devices
- Get Global Search Entities
- Get Vulnerabilities
Notes
Configurations
API Key Authentication
Authenticates using an API Key
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
api-key | API key | string | Required |
api-secret | API Secret | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Export Assets to CSV
Exports specified asset types from Axonius into a CSV format, requiring path parameters and optional JSON body inputs.
Endpoint
- URL: api/v2/assets/{{asset_type}}/export_csv
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.asset_type | string | Required | Export assets for the selected asset type. |
internal_axon_ids | array | Optional | The internal Axon IDs of the assets to export. |
saved_query_id | string | Optional | The ID of the saved query to use for the export. |
saved_query_name | string | Optional | The name of the saved query to use for the export. |
fields | array | Optional | Parameter for Export Assets to CSV |
delimiter | string | Optional | The delimiter to use for the export. |
max_rows | number | Optional | Parameter for Export Assets to CSV |
split_by_field_values | string | Optional | The field to split the export by. |
should_split_by_asset_entities | boolean | Optional | Whether to split by asset entities in the export. |
should_split_complex_objects | boolean | Optional | Whether to split complex objects in the export. |
should_exclude_complex_fields | boolean | Optional | Whether to exclude complex fields from the export. |
include_parent_entities | boolean | Optional | Whether to include parent entities in the export. |
parent_entity_fields | array | Optional | The fields to include in the export for parent entities. |
Input Example
{"json_body":{"internal_axon_ids":["661a46e1ca9b40d07115601e9d1515c8","2a1d7cd447bb11427440b5f13c2c9d0b"],"saved_query_id":"string","saved_query_name":"string","fields":["specific_data.data.hostname","specific_data.data.last_seen"],"delimiter":"\\n","max_rows":1048500,"split_by_field_values":"string","should_split_by_asset_entities":false,"should_split_complex_objects":true,"should_exclude_complex_fields":false,"include_parent_entities":true,"parent_entity_fields":["specific_data.data.hostname","specific_data.data.last_seen"]},"path_parameters":{"asset_type":"vulnerability_instances"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
file | object | Output field: file |
file.file_name | string | Name of the resource |
file.file | string | Output field: file.file |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{},"file":{"file_name":"export_assets_to_csv.csv","file":"data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;base64,....."}}
Get Asset By ID
Retrieves a specific asset from Axonius using the asset type and internal Axon ID provided in path parameters.
Endpoint
- URL: api/v2/assets/{{asset_type}}/{{internal_axon_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.history | string | Optional | Date string of the historical snapshot to query against in YYYY-MM-DD format (e.g., 2023-10-15). |
parameters.return_empty_details | boolean | Optional | If set to true, will populate null values for _details fields that are missing values from specific adapters. _details fields include a non-aggregated list of values for every field returned, ordered by the adapter list of the asset. |
parameters.return_complex_fields_data | boolean | Optional | When true, returns complex fields table data. This may return a large amount of data due to the possibility of multiple nested objects. (e.g., specific_data.data.network_interfaces). |
path_parameters.asset_type | string | Required | The type of asset to retrieve. |
path_parameters.internal_axon_id | string | Required | The internal Axon ID of the asset to retrieve. |
Input Example
{"parameters":{"history":"2026-02-05","return_empty_details":true,"return_complex_fields_data":true},"path_parameters":{"asset_type":"device","internal_axon_id":"661a46e1ca9b40d07115601e9d1515c8"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
internal_axon_id | string | Unique identifier |
adapters | array | Output field: adapters |
adapters.accurate_for_datetime | string | Time value |
adapters.client_used | string | Output field: adapters.client_used |
adapters.data | object | Response data |
adapters.data.accurate_for_datetime | string | Response data |
adapters.data.adapter_properties | array | Response data |
adapters.data.asset_entity_info | string | Response data |
adapters.data.axon_id | string | Response data |
adapters.data.axonius_instance_name | string | Response data |
adapters.data.azure_ad_device_type | string | Response data |
adapters.data.azure_ad_registered | boolean | Response data |
adapters.data.bitlocker_key_is_stored | boolean | Response data |
adapters.data.category_display_name | string | Response data |
adapters.data.compliance_state | string | Response data |
adapters.data.device_category_display_name | string | Response data |
adapters.data.device_enrollment_type | string | Response data |
adapters.data.device_manufacturer | string | Response data |
adapters.data.device_model | string | Response data |
adapters.data.device_registration_state | string | Response data |
adapters.data.device_serial | string | Response data |
adapters.data.eas_activated | boolean | Response data |
adapters.data.email | string | Response data |
Output Example
{"internal_axon_id":"string","adapters":[{"accurate_for_datetime":"string","client_used":"string","data":{},"plugin_name":"Example Name","plugin_type":"string","plugin_unique_name":"Example Name","type":"string"}],"labels":[{"file_name":"Example Name","file":"string"}],"basic":{"complex_correlation_meta":{"internal_axon_id_history":123,"specific_data.data.hard_drives":123,"specific_data.data.network_interfaces":123},"complex_correlation_meta_details":{"internal_axon_id_history":[],"specific_data...
Get Asset Investigation
Retrieve detailed investigation data for a specified asset type and internal Axonius ID.
Endpoint
- URL: /api/v2/assets/{{asset_type}}/asset_investigation/{{internal_axon_id}}
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.asset_type | string | Required | Retrieve asset investigation data for the selected asset type. |
path_parameters.internal_axon_id | string | Required | Retrieve asset investigation data for the specified Internal Axon ID. |
event_types | array | Optional | Type of the resource |
search | object | Optional | Parameter for Get Asset Investigation |
search.search | string | Optional | Parameter for Get Asset Investigation |
search.show_only_exact_results | boolean | Optional | Result of the operation |
search.filter_by | array | Optional | Parameter for Get Asset Investigation |
adapter_connections | array | Optional | Parameter for Get Asset Investigation |
adapter_connections.plugin_name | string | Optional | Name of the resource |
adapter_connections.connection_ids | array | Optional | Unique identifier |
time_range | object | Optional | Parameter for Get Asset Investigation |
time_range.range | object | Optional | Parameter for Get Asset Investigation |
time_range.range.date_from | string | Optional | Parameter for Get Asset Investigation |
time_range.range.date_to | string | Optional | Parameter for Get Asset Investigation |
time_range.period | object | Optional | Parameter for Get Asset Investigation |
time_range.period.count | number | Optional | Count value |
time_range.period.unit | string | Optional | Parameter for Get Asset Investigation |
time_range.period.relative_type | string | Optional | Type of the resource |
fields | array | Optional | Parameter for Get Asset Investigation |
Input Example
{"json_body":{"event_types":["Added/Removed","Added/Removed"],"search":{"search":"exercitation","show_only_exact_results":false,"filter_by":["Value Removed","Value Removed"]},"adapter_connections":[{"plugin_name":"non fugiat","connection_ids":["magna dolor aliqua minim","labore dolore culpa enim"]},{"plugin_name":"proident in et Lorem Ut","connection_ids":["consequat reprehenderit amet e","occaecat"]}],"time_range":{"range":{"date_from":"1954-11-15T12:25:08.489Z","date_to":"1959-11-20T13:07:14.752Z"},"period":{"count":-41665942,"unit":"weeks","relative_type":"before"}},"fields":["irure non","deserunt reprehend"]},"path_parameters":{"asset_type":"device","internal_axon_id":"661a46e1ca9b40d07115601e9d1515c8"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
investigation_fields | array | Output field: investigation_fields |
investigation_fields.adapter_name | string | Name of the resource |
investigation_fields.field_title | string | Output field: investigation_fields.field_title |
investigation_fields.connection_id | string | Unique identifier |
investigation_fields.field_name | string | Name of the resource |
investigation_fields.asset_id | string | Unique identifier |
investigation_fields.added_values | array | Value for the parameter |
investigation_fields.added_values.file_name | string | Name of the resource |
investigation_fields.added_values.file | string | Value for the parameter |
investigation_fields.removed_values | array | Value for the parameter |
investigation_fields.event_type | string | Type of the resource |
investigation_fields.timestamp | string | Output field: investigation_fields.timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"investigation_fields":[{},{}]}}
Get Assets
Retrieves a list of assets from Axonius based on the specified asset type, requiring path parameter input.
Endpoint
- URL: api/v2/assets/{{asset_type}}
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.asset_type | string | Required | Retrieve assets for the selected asset type. |
include_metadata | boolean | Optional | Response data |
saved_query_id | string | Optional | Unique identifier |
saved_query_name | string | Optional | Name of the resource |
query | string | Optional | Parameter for Get Assets |
history | string | Optional | Parameter for Get Assets |
page | object | Optional | Parameter for Get Assets |
page.offset | number | Optional | Parameter for Get Assets |
page.limit | number | Optional | Parameter for Get Assets |
next_page | string | Optional | Parameter for Get Assets |
fields | array | Optional | Parameter for Get Assets |
fields_to_exclude | array | Optional | Parameter for Get Assets |
use_cache_entry | boolean | Optional | Parameter for Get Assets |
include_details | boolean | Optional | Parameter for Get Assets |
Input Example
{"json_body":{"include_metadata":true,"saved_query_id":"est cillum nulla","saved_query_name":"velit ullamco","query":"aliquip adipisicing ullamco veniam dolore","history":"2011-04-26","page":{"offset":30888559,"limit":1000},"next_page":"aliquip irure do Duis dolor","fields":["ea do veniam aute","cillum id occaecat"],"fields_to_exclude":["laboris ex","ut dolor"],"use_cache_entry":true,"include_details":true},"path_parameters":{"asset_type":"asset_type"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
assets | array | Output field: assets |
assets.internal_axon_id | string | Unique identifier |
assets.adapters | array | Output field: assets.adapters |
assets.adapter_list_length | number | Output field: assets.adapter_list_length |
assets.specific_data.data.last_seen | string | Response data |
assets.specific_data.data.name | string | Response data |
assets.specific_data.data.hostname | string | Response data |
assets.specific_data.data.os.type | string | Response data |
assets.specific_data.data.network_interfaces.ips | array | Response data |
meta | object | Output field: meta |
meta.cache_last_updated | string | Output field: meta.cache_last_updated |
meta.is_data_from_cache | boolean | Response data |
meta.page | object | Output field: meta.page |
meta.page.number | number | Output field: meta.page.number |
meta.page.size | number | Output field: meta.page.size |
meta.page.totalPages | number | Output field: meta.page.totalPages |
meta.page.totalResources | number | Output field: meta.page.totalResources |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"assets":[{},{},{}],"meta":{"cache_last_updated":"Fri, 17 Nov 2023 19:20:29 GMT","is_data_from_cache":true,"page":{}}}}
Get Assets Fields
Retrieve all available fields for a specified asset type in Axonius, utilizing the 'asset_type' path parameter.
Endpoint
- URL: api/v2/assets/{{asset_type}}/fields
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.search | string | Optional | Search term to filter by. The response will include all the fields that contain the search term. For example, if the search term is network, all fields that contain network will be returned. |
parameters.exclude_subfields | boolean | Optional | If set to true, the request will return all the fields except subfields. For example, the field specific_data.data.network_interfaces will be included in the response but specific_data.data.network_interfaces.ips_preferred and specific_data.data.network_interfaces.mac_preferred will be excluded. |
path_parameters.asset_type | string | Required | Retrieve assets for the selected asset type. |
Input Example
{"parameters":{"search":"eu amet enim sit","exclude_subfields":true},"path_parameters":{"asset_type":"device"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
agg | array | Output field: agg |
agg.filterable | boolean | Output field: agg.filterable |
agg.name | string | Name of the resource |
agg.restrictable | boolean | Output field: agg.restrictable |
agg.restricted | boolean | Output field: agg.restricted |
agg.title | string | Output field: agg.title |
agg.type | string | Type of the resource |
agg.adapter_prefix | string | Output field: agg.adapter_prefix |
agg.name_base | string | Name of the resource |
agg.is_complex | boolean | Output field: agg.is_complex |
agg.adapter_title | string | Output field: agg.adapter_title |
agg.adapter_name | string | Name of the resource |
agg.name_qual | string | Name of the resource |
agg.is_root | boolean | Output field: agg.is_root |
agg.is_list | boolean | Output field: agg.is_list |
agg.parent | string | Output field: agg.parent |
agg.is_agg | boolean | Output field: agg.is_agg |
agg.adapter_name_raw | string | Name of the resource |
agg.sub_fields | array | Output field: agg.sub_fields |
agg.sub_fields.name | string | Name of the resource |
agg.sub_fields.title | string | Output field: agg.sub_fields.title |
agg.sub_fields.type | string | Type of the resource |
agg.sub_fields.name_base | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"agg":[{}]}}
Get Devices
Retrieves a list of devices from Axonius based on the specified query parameters.
Endpoint
- URL: /api/devices
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.include_notes | boolean | Optional | Parameters for the Get Devices action |
parameters.should_split_complex_objects | boolean | Optional | Parameters for the Get Devices action |
parameters.source_component | string | Optional | Parameters for the Get Devices action |
parameters.filter_out_non_existing_fields | boolean | Optional | Parameters for the Get Devices action |
parameters.should_split_by_adapter | boolean | Optional | Parameters for the Get Devices action |
parameters.get_metadata | boolean | Optional | Whether to add metadata for the resource (the pagination offset). |
parameters.asset_excluded_adapters | string | Optional | Parameters for the Get Devices action |
parameters.include_selected_entities | boolean | Optional | Parameters for the Get Devices action |
parameters.asset_filters | string | Optional | Parameters for the Get Devices action |
parameters.cursor_id | string | Optional | Parameters for the Get Devices action |
parameters.include_parent_entities | boolean | Optional | Parameters for the Get Devices action |
parameters.page | object | Optional | Parameters for the Get Devices action |
parameters.page.limit | number | Optional | Parameters for the Get Devices action |
parameters.page.offset | number | Optional | Parameters for the Get Devices action |
parameters.should_exclude_complex_fields | boolean | Optional | Parameters for the Get Devices action |
parameters.max_field_items | number | Optional | Parameters for the Get Devices action |
parameters.wait_for_data | boolean | Optional | Parameters for the Get Devices action |
parameters.field_to_split_by | string | Optional | Parameters for the Get Devices action |
parameters.history | string | Optional | Historical date ISO formatted. |
parameters.search | string | Optional | A textual value to search. |
parameters.parent_entity_fields | array | Optional | Parameters for the Get Devices action |
parameters.filter | string | Optional | AQL string, representing data filter. |
parameters.excluded_adapters | string | Optional | Parameters for the Get Devices action |
parameters.frontend_sent_time | string | Optional | Parameters for the Get Devices action |
parameters.is_refresh | boolean | Optional | Parameters for the Get Devices action |
Input Example
{"parameters":{"include_notes":false,"should_split_complex_objects":true,"source_component":"null","filter_out_non_existing_fields":true,"should_split_by_adapter":false,"get_metadata":true,"asset_excluded_adapters":"asset excluded adapters","include_selected_entities":true,"asset_filters":"asset filters","cursor_id":"null","include_parent_entities":false,"page":{"limit":140,"offset":0},"should_exclude_complex_fields":false,"max_field_items":0,"wait_for_data":false,"field_to_split_by":"null","history":"2021-04-06T08:22:37Z","search":"search","parent_entity_fields":["null"],"filter":"null","excluded_adapters":"excluded adapters","frontend_sent_time":"2021-05-06T08:22:37Z","is_refresh":false,"file_name":"data","include_details":false,"use_heavy_fields_collection":true,"jit_device_count_calc_filter":"jit device count calc filter","query_id":"null","delimiter":"delimiter","sort":[1,-1],"expressions":"expressions","saved_query_id":"null","max_rows":1,"use_cache_entry":true,"null_for_non_exist":false,"use_cursor":false,"id":"ID","return_plain_data":false,"download_id":"null","complex_fields_preview_limit":1,"always_cached_query":false,"fields":{"additionalProp1":["string"],"additionalProp2":["string"],"additionalProp3":["string"]},"selected_entities":["list"],"field_filters":"field filters"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
data | array | Response data |
data.attributes | object | Response data |
data.attributes._document_meta | string | Response data |
data.attributes.adapter_details | array | Response data |
data.attributes.adapter_list_length | number | Response data |
data.attributes.adapter_list_length_details | array | Response data |
data.attributes.adapters | array | Response data |
data.attributes.adapters_data | array | Response data |
data.attributes.adapters_data_details | array | Response data |
data.attributes.id | string | Response data |
data.attributes.internal_axon_id | string | Response data |
data.attributes.internal_axon_id_details | array | Response data |
data.attributes.labels | array | Response data |
data.attributes.unique_adapter_names | array | Response data |
data.attributes.unique_adapter_names_details | array | Response data |
data.id | string | Response data |
data.type | string | Response data |
meta | object | Output field: meta |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Tue, 19 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"meta":{}}}
Get Global Search Entities
Retrieve details of all assets associated with a specified global search term in Axonius.
Endpoint
- URL: api/v2/global_search
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.search | string | Required | The term used in the global search to filter and retrieve relevant assets. |
parameters.offset | number | Optional | The number of rows to skip from the beginning of the result set. |
parameters.limit | number | Optional | The number of rows to return from the result set. |
Input Example
{"parameters":{"search":"eu amet enim sit","offset":0,"limit":1000}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
assets | array | Output field: assets |
assets._id | string | Unique identifier |
assets.entity_type | string | Type of the resource |
assets.internal_axon_id | string | Unique identifier |
assets.name | string | Name of the resource |
assets.values_by_field | object | Value for the parameter |
assets.values_by_field.specific_data.data.hostname | array | Response data |
assets.values_by_field.specific_data.data.name | array | Response data |
type | string | Type of the resource |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"assets":[{},{},{}],"type":"list_value_schema"}}
Get Vulnerabilities
Retrieves a list of vulnerabilities from Axonius based on the specified query parameters.
Endpoint
- URL: /api/vulnerabilities
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.include_notes | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.should_split_complex_objects | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.source_component | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.filter_out_non_existing_fields | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.should_split_by_adapter | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.get_metadata | boolean | Optional | Whether to add metadata for the resource (the pagination offset). |
parameters.asset_excluded_adapters | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.include_selected_entities | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.asset_filters | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.cursor_id | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.include_parent_entities | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.page | object | Optional | Parameters for the Get Vulnerabilities action |
parameters.page.limit | number | Optional | Parameters for the Get Vulnerabilities action |
parameters.page.offset | number | Optional | Parameters for the Get Vulnerabilities action |
parameters.should_exclude_complex_fields | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.max_field_items | number | Optional | Parameters for the Get Vulnerabilities action |
parameters.wait_for_data | boolean | Optional | Parameters for the Get Vulnerabilities action |
parameters.field_to_split_by | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.history | string | Optional | Historical date ISO formatted. |
parameters.search | string | Optional | A textual value to search. |
parameters.parent_entity_fields | array | Optional | Parameters for the Get Vulnerabilities action |
parameters.filter | string | Optional | AQL string, representing data filter. |
parameters.excluded_adapters | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.frontend_sent_time | string | Optional | Parameters for the Get Vulnerabilities action |
parameters.is_refresh | boolean | Optional | Parameters for the Get Vulnerabilities action |
Input Example
{"parameters":{"include_notes":false,"should_split_complex_objects":true,"source_component":"null","filter_out_non_existing_fields":true,"should_split_by_adapter":false,"get_metadata":true,"asset_excluded_adapters":"asset excluded adapters","include_selected_entities":true,"asset_filters":"asset filters","cursor_id":"null","include_parent_entities":false,"page":{"limit":140,"offset":0},"should_exclude_complex_fields":false,"max_field_items":0,"wait_for_data":false,"field_to_split_by":"null","history":"2021-04-06T08:22:37Z","search":"search","parent_entity_fields":["null"],"filter":"null","excluded_adapters":"excluded adapters","frontend_sent_time":"2021-05-06T08:22:37Z","is_refresh":false,"file_name":"data","include_details":false,"use_heavy_fields_collection":true,"jit_device_count_calc_filter":"jit device count calc filter","query_id":"null","delimiter":"delimiter","sort":[1,-1],"expressions":"expressions","saved_query_id":"null","max_rows":1,"use_cache_entry":true,"null_for_non_exist":false,"use_cursor":false,"id":"ID","return_plain_data":false,"download_id":"null","complex_fields_preview_limit":1,"always_cached_query":false,"fields":{"additionalProp1":["string"],"additionalProp2":["string"],"additionalProp3":["string"]},"selected_entities":["list"],"field_filters":"field filters"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
data | array | Response data |
data.attributes | object | Response data |
data.attributes._document_meta | string | Response data |
data.attributes.adapter_details | array | Response data |
data.attributes.adapter_list_length | number | Response data |
data.attributes.adapter_list_length_details | array | Response data |
data.attributes.adapters | array | Response data |
data.attributes.adapters_data | array | Response data |
data.attributes.adapters_data_details | array | Response data |
data.attributes.id | string | Response data |
data.attributes.internal_axon_id | string | Response data |
data.attributes.internal_axon_id_details | array | Response data |
data.attributes.labels | array | Response data |
data.attributes.unique_adapter_names | array | Response data |
data.attributes.unique_adapter_names_details | array | Response data |
data.id | string | Response data |
data.type | string | Response data |
meta | object | Output field: meta |
Output Example
{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Fri, 22 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"meta":{}}}
Response Headers
Header | Description | Example |
|---|---|---|
content-length | The length of the response body in bytes | 140 |
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Fri, 22 Dec 2023 20:37:23 GMT |