TrueSight Network Automation REST API – EnumerationListingService
The base URL for the API is:
https://serverName:portNumber/bca-networks/api
value mappings
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_delete_current_image_options
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_image_file_systems
Click here to expand...
| | | | |
|---|
| | Filter for action image file type matching to this device; when null, retrieves all available file systems | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Not found: No single matching accessible device found | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_image_sources
Click here to expand...
| | | | |
|---|
| | The applicable image sources for this realm when asking for only the applicable sources | | |
| | Whether to retrieve all action image sources or those sources currently applicable based on the realm and remote file servers | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Not found: No single matching accessible realm found | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_reboot_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_script_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_smart_merge_modes
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/action_statuses
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/available_substitution_parameters
Click here to expand...
| | | | |
|---|
substitutionParameterType | | The set of substitution parameters to be retrieved (container, device, deviceAgent, deviceAttribute, function, pod, or template); when null or not one of these recognized types, an empty list is returned | | string Enum: [ "container", "device", "deviceAgent", "deviceAttribute", "function", "pod", "template" ] |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/boolean_expression_operators
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/canned_actions
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_access_modes
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_adapter_action_classifications
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_adapter_capabilities_report_attributes
Click here to expand...
| | | | |
|---|
| | Selects which attributes are returned; when true, the attributes related to device types are returned; when false, the attributes related to custom actions are returned | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_adapter_states
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_adapter_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_categories
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_import_database_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_import_formats
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_import_matching_criteria_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_import_scope_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_inventory_report_attributes
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_security_context_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/device_transfer_modes
Click here to expand...
| | | | |
|---|
| | Filter for device transfer modes matching this device type | | |
| | Filter for device transfer modes matching this device agent | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Not found: No single matching device agent found or no matching the device type found | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/dynamic_field_components
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/emailed_report_formats
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/event_categories
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/event_severities
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/event_types
Click here to expand...
| | | | |
|---|
| | Retrieve only event types in this category (debug, device, external, job, system, or user); a null means to retrieve all event types | | string Enum: [ "debug", "device", "external", "job", "system", "user" ] |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/import_export_days_of_week
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/import_export_individual_result_statuses
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/import_export_repeat_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/incoming_syslog_message_severities
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/integer_operators
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_approval_modes
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_approval_type_methods
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_originator_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_reconciliation_statuses
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_states
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/job_summary_link_report_by_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/network_rights
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/policy_triggering_span_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/predefined_logging_property_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/quarantine_isolation_levels
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/rule_severities
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/script_types
Click here to expand...
| | | | |
|---|
| | Retrieve the script types that can be used in this context (complianceSummaryReport, configurationComparisonReport, configurationExportTask, differenceDetailsReport); a null means to retrieve all script types | | string Enum: [ "complianceSummaryReport", "configurationComparisonReport", "configurationExportTask", "differenceDetailsReport" ] |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/snmp_trap_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/snmp_v3_authentication_algorithms
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/snmp_v3_privileged_algorithms
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/snmp_versions
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/system_rights
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/time_based_policy_repeat_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized:Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred |