Nipyapi
  • NiPyApi
    • Features
    • Quick Start
    • Background and Documentation
    • NiFi Version Support
    • Python Support
  • Installation
    • Requirements
    • Stable Release
    • Virtual Environment (Recommended)
    • Development Installation
    • From Source Archive
    • Verify Installation
    • Next Steps
    • Dependencies
    • Runtime Dependencies
    • Optional Dependencies
    • Dependency Management
  • Command-Line Interface
    • Installation
    • Configuration
      • Environment Variables
      • User Profiles File
    • Profile Selection
    • Discovering Commands
    • Available Modules
    • Output Formatting
    • Log Level Control
    • Usage Examples
    • Error Handling
      • Error Field Convention
    • Cross-References
  • CI Operations
    • Overview
      • Error Field Convention
    • Quick Start
    • Available Operations
      • ensure_registry
      • deploy_flow
      • start_flow
      • stop_flow
      • get_status
      • configure_params
      • configure_inherited_params
      • change_flow_version
      • commit_flow
      • detach_flow
      • get_flow_diff
      • get_flow_versions
      • revert_flow
      • cleanup
      • list_flows
      • purge_flowfiles
      • upload_asset
      • resolve_git_ref
    • Environment Variable Reference
      • Connection
      • Registry
      • Flow Operations
      • Cleanup
    • Complete Workflow Example
      • Shell Script
      • GitHub Actions
      • GitLab CI
    • Python Usage
    • Cross-References
  • Environment Profiles with NiPyAPI
    • Quick Start
    • Why Use Profiles?
    • Configuration Structure
    • Profile Switching Behavior
    • Path Resolution
    • Built-in Profiles
      • single-user (Recommended for Development)
      • secure-ldap
      • secure-mtls
      • secure-oidc
      • bearer-token (Simplest Configuration)
      • cli-properties
      • env (Environment-Only Configuration)
    • Environment Variable Overrides
    • Creating Custom Profiles
    • GitHub Flow Registry Client
    • Integration with Examples
    • CLI Profile Selection
    • Profile API Reference
    • Cross-References
  • Security with NiPyAPI
    • Development vs Production Security
      • Development Environment Security
      • Production Environment Security
    • Certificate Generation and Management
    • Prerequisites
    • Environment variables
    • Registry vs NiFi Authentication Requirements
    • Authentication Methods
      • Single-user (basic auth)
      • Secure LDAP (basic auth over TLS)
      • Secure mTLS (client certificate)
        • Browser Certificate Import (mTLS Web UI Access)
      • OpenID Connect (OIDC)
    • Quick connection checks
    • NiFi Registry Client SSL Configuration
      • Implicit Trust (Shared Root CA)
      • Explicit SSL Context Services
      • NiPyAPI Testing Implementation
    • Security Module Organization
      • nipyapi.security - Taking Security Actions
      • nipyapi.profiles - Configuration Management
      • nipyapi.utils - Supporting Utilities
  • Working with NiFi Extensions
    • Key Concepts
    • Extension Management
      • Listing Installed Extensions
      • Uploading Extensions
      • Getting NAR Details
      • Finding a NAR by Coordinate
      • Downloading Extensions
      • Deleting Extensions
    • Python Processor Initialization
      • Initialization States
      • Checking Initialization Status
      • Waiting for Initialization
      • Initialization Timeline
    • Virtual Environment Caching
      • Caching Behavior
      • Cache Location
    • Processor Bundle Version Management
      • Listing Available Versions
      • Creating Processors with Specific Versions
      • Changing Processor Version
      • Multi-Version Conflicts
      • Python Processor Bundle Versioning
    • NAR Lifecycle with Active Components
      • Deletion Protection
      • Force Deletion and Orphaned Components
      • Recovering Orphaned Components
    • API Reference
      • Extensions Module Functions
      • CI Module Functions
    • Testing with Generated NARs
    • Troubleshooting
      • Processor Stuck in “Initializing”
      • Dependency Download Failed
      • “Missing Processor” Error
      • Cannot Delete NAR
      • Python Code Compilation Errors
      • Processor Type Not Recognized
      • NAR Installation Timeout
  • Migration Guide
    • Upgrading from NiPyAPI 0.x/NiFi 1.x to NiPyAPI 1.x/NiFi 2.x
    • Version Overview
    • Understanding Migration Scope
    • Major Changes Summary
      • Breaking Changes - Action Required
      • Removed Features
      • NEW: Profile Management System
      • Enhanced Development Workflow
      • Updated APIs
      • Enhanced Features
      • Understanding the Profiles System
    • Breaking Changes
      • Authentication and Configuration
      • API Changes
      • Configuration Changes
      • New Authentication Methods
    • Migration Steps
      • 1. Update Dependencies
      • 2. Choose Your Profiles Strategy
      • 3. Test Your Profile Configuration
      • 4. Update Your Application Code
      • 5. Update Testing Environment
      • 6. Remove Templates Usage
      • 7. Update Configuration and Ports
    • Common Migration Issues
    • Quick Migration Checklist
    • Testing Your Migration
  • API Reference
    • Client Architecture
      • Client Layers
      • Generated API Structure
        • Example Usage
      • Callback Functions
      • Error Handling
      • Model Cross-References
    • Core Client Modules
      • Ci
        • change_flow_version()
        • cleanup()
        • commit_flow()
        • configure_inherited_params()
        • configure_params()
        • delete_nar()
        • deploy_flow()
        • detach_flow()
        • ensure_registry()
        • export_flow_definition()
        • export_parameters()
        • get_flow_diff()
        • get_flow_versions()
        • get_status()
        • import_flow_definition()
        • list_flows()
        • list_nars()
        • list_registry_flows()
        • purge_flowfiles()
        • resolve_git_ref()
        • revert_flow()
        • start_flow()
        • stop_flow()
        • upload_asset()
        • upload_nar()
        • verify_config()
      • Canvas
        • FlowSubgraph
        • clear_controller_state()
        • clear_processor_state()
        • create_connection()
        • create_controller()
        • create_funnel()
        • create_port()
        • create_process_group()
        • create_processor()
        • create_remote_process_group()
        • delete_connection()
        • delete_controller()
        • delete_funnel()
        • delete_port()
        • delete_process_group()
        • delete_processor()
        • delete_remote_process_group()
        • get_bulletin_board()
        • get_bulletins()
        • get_component_connections()
        • get_connection()
        • get_controller()
        • get_controller_service_docs()
        • get_controller_state()
        • get_controller_type()
        • get_flow()
        • get_flow_components()
        • get_flowfile_content()
        • get_flowfile_details()
        • get_funnel()
        • get_pg_parents_ids()
        • get_port()
        • get_process_group()
        • get_process_group_status()
        • get_processor()
        • get_processor_docs()
        • get_processor_state()
        • get_processor_type()
        • get_remote_process_group()
        • get_root_pg_id()
        • list_all_by_kind()
        • list_all_connections()
        • list_all_controller_types()
        • list_all_controllers()
        • list_all_funnels()
        • list_all_input_ports()
        • list_all_output_ports()
        • list_all_process_groups()
        • list_all_processor_types()
        • list_all_processors()
        • list_all_remote_process_groups()
        • list_flowfiles()
        • list_invalid_processors()
        • list_sensitive_processors()
        • peek_flowfiles()
        • prepare_controller_config()
        • prepare_processor_config()
        • purge_connection()
        • purge_process_group()
        • recurse_flow()
        • schedule_all_controllers()
        • schedule_components()
        • schedule_controller()
        • schedule_port()
        • schedule_process_group()
        • schedule_processor()
        • set_remote_process_group_transmission()
        • update_connection()
        • update_controller()
        • update_process_group()
        • update_processor()
        • verify_controller()
        • verify_processor()
      • Versioning
        • create_flow()
        • create_flow_version()
        • create_registry_bucket()
        • create_registry_client()
        • delete_registry_bucket()
        • delete_registry_client()
        • deploy_flow_version()
        • deploy_git_registry_flow()
        • ensure_registry_bucket()
        • ensure_registry_client()
        • export_flow_version()
        • export_process_group_definition()
        • get_flow_in_bucket()
        • get_flow_version()
        • get_git_registry_bucket()
        • get_git_registry_flow()
        • get_latest_flow_ver()
        • get_local_modifications()
        • get_registry_bucket()
        • get_registry_client()
        • get_version_info()
        • import_flow_version()
        • import_process_group_definition()
        • list_flow_versions()
        • list_flows_in_bucket()
        • list_git_registry_buckets()
        • list_git_registry_flow_versions()
        • list_git_registry_flows()
        • list_registry_buckets()
        • list_registry_client_types()
        • list_registry_clients()
        • save_flow_ver()
        • save_git_flow_ver()
        • update_flow_ver()
        • update_registry_client()
      • Security
        • add_user_group_to_access_policy()
        • add_user_to_access_policy()
        • bootstrap_security_policies()
        • create_access_policy()
        • create_service_user()
        • create_service_user_group()
        • create_ssl_context_controller_service()
        • ensure_ssl_context()
        • get_access_policy_for_resource()
        • get_service_access_status()
        • get_service_user()
        • get_service_user_group()
        • list_service_user_groups()
        • list_service_users()
        • remove_service_user()
        • remove_service_user_group()
        • reset_service_connections()
        • service_login()
        • service_login_oidc()
        • service_logout()
        • set_service_auth_token()
        • set_service_ssl_context()
        • set_shared_ca_cert()
        • set_ssl_warning_suppression()
        • update_access_policy()
      • Parameters
        • assign_context_to_process_group()
        • create_parameter_context()
        • delete_asset()
        • delete_parameter_context()
        • delete_parameter_from_context()
        • get_parameter_context()
        • get_parameter_context_hierarchy()
        • get_parameter_ownership_map()
        • list_all_parameter_contexts()
        • list_assets()
        • list_orphaned_contexts()
        • prepare_parameter()
        • prepare_parameter_with_asset()
        • remove_context_from_process_group()
        • rename_parameter_context()
        • update_parameter_context()
        • update_parameter_in_context()
        • upload_asset()
        • upsert_parameter_to_context()
      • Profiles
        • current()
        • get_default_profile_name()
        • list_profiles()
        • load_profiles_from_file()
        • resolve_profile_config()
        • show()
        • switch()
      • Layout
        • above()
        • align_pg_grid()
        • below()
        • clear_flow_bends()
        • find_flow_spine()
        • fork()
        • get_canvas_bounds()
        • get_pg_grid_position()
        • get_position()
        • get_side_branches()
        • grid_position()
        • left_of()
        • move_component()
        • move_funnel()
        • move_label()
        • move_port()
        • move_process_group()
        • move_processor()
        • new_flow()
        • right_of()
        • snap_position()
        • snap_to_grid()
        • suggest_bend_position()
        • suggest_empty_position()
        • suggest_flow_layout()
        • suggest_pg_position()
        • transpose_flow()
      • System
        • get_cluster()
        • get_nifi_version_info()
        • get_node()
        • get_registry_version_info()
        • get_system_diagnostics()
      • Bulletins
        • clear_all_bulletins()
        • clear_controller_service_bulletins()
        • clear_flow_analysis_rule_bulletins()
        • clear_input_port_bulletins()
        • clear_output_port_bulletins()
        • clear_parameter_provider_bulletins()
        • clear_process_group_bulletins()
        • clear_processor_bulletins()
        • clear_registry_client_bulletins()
        • clear_remote_process_group_bulletins()
        • clear_reporting_task_bulletins()
        • get_bulletin_board()
        • get_bulletins()
      • Extensions
        • change_processor_bundle_version()
        • delete_nar()
        • download_nar()
        • get_nar()
        • get_nar_by_coordinate()
        • get_nar_details()
        • get_processor_bundle_versions()
        • get_processor_init_status()
        • get_processor_type_version()
        • list_nars()
        • upload_nar()
        • wait_for_processor_init()
      • Utils
        • bypass_slash_encoding()
        • check_version()
        • dump()
        • enforce_min_ver()
        • exception_handler()
        • extract_oidc_user_identity()
        • filter_obj()
        • format_timestamp()
        • fs_read()
        • fs_write()
        • getenv()
        • getenv_bool()
        • infer_object_label_from_class()
        • is_endpoint_up()
        • is_uuid()
        • load()
        • parse_bool()
        • resolve_entity()
        • resolve_relative_paths()
        • resolve_schedule_state()
        • set_endpoint()
        • validate_parameters_versioning_support()
        • wait_to_complete()
      • Config
    • NiFi APIs
      • AccessApi
        • AccessApi.__init__()
        • AccessApi.create_access_token()
        • AccessApi.create_access_token_with_http_info()
        • AccessApi.log_out()
        • AccessApi.log_out_complete()
        • AccessApi.log_out_complete_with_http_info()
        • AccessApi.log_out_with_http_info()
      • AuthenticationApi
        • AuthenticationApi.__init__()
        • AuthenticationApi.get_authentication_configuration()
        • AuthenticationApi.get_authentication_configuration_with_http_info()
      • ConnectionsApi
        • ConnectionsApi.__init__()
        • ConnectionsApi.delete_connection()
        • ConnectionsApi.delete_connection_with_http_info()
        • ConnectionsApi.get_connection()
        • ConnectionsApi.get_connection_with_http_info()
        • ConnectionsApi.update_connection()
        • ConnectionsApi.update_connection_with_http_info()
      • ControllerApi
        • ControllerApi.__init__()
        • ControllerApi.analyze_flow_analysis_rule_configuration()
        • ControllerApi.analyze_flow_analysis_rule_configuration_with_http_info()
        • ControllerApi.analyze_flow_registry_client_configuration()
        • ControllerApi.analyze_flow_registry_client_configuration_with_http_info()
        • ControllerApi.clear_flow_analysis_rule_bulletins()
        • ControllerApi.clear_flow_analysis_rule_bulletins_with_http_info()
        • ControllerApi.clear_parameter_provider_bulletins()
        • ControllerApi.clear_parameter_provider_bulletins_with_http_info()
        • ControllerApi.clear_registry_client_bulletins()
        • ControllerApi.clear_registry_client_bulletins_with_http_info()
        • ControllerApi.clear_state()
        • ControllerApi.clear_state_with_http_info()
        • ControllerApi.create_bulletin()
        • ControllerApi.create_bulletin_with_http_info()
        • ControllerApi.create_controller_service()
        • ControllerApi.create_controller_service_with_http_info()
        • ControllerApi.create_flow_analysis_rule()
        • ControllerApi.create_flow_analysis_rule_with_http_info()
        • ControllerApi.create_flow_registry_client()
        • ControllerApi.create_flow_registry_client_with_http_info()
        • ControllerApi.create_parameter_provider()
        • ControllerApi.create_parameter_provider_with_http_info()
        • ControllerApi.create_reporting_task()
        • ControllerApi.create_reporting_task_with_http_info()
        • ControllerApi.delete_flow_analysis_rule_verification_request()
        • ControllerApi.delete_flow_analysis_rule_verification_request_with_http_info()
        • ControllerApi.delete_flow_registry_client()
        • ControllerApi.delete_flow_registry_client_with_http_info()
        • ControllerApi.delete_history()
        • ControllerApi.delete_history_with_http_info()
        • ControllerApi.delete_nar()
        • ControllerApi.delete_nar_with_http_info()
        • ControllerApi.delete_node()
        • ControllerApi.delete_node_with_http_info()
        • ControllerApi.delete_registry_client_verification_request()
        • ControllerApi.delete_registry_client_verification_request_with_http_info()
        • ControllerApi.download_nar()
        • ControllerApi.download_nar_with_http_info()
        • ControllerApi.get_cluster()
        • ControllerApi.get_cluster_with_http_info()
        • ControllerApi.get_controller_config()
        • ControllerApi.get_controller_config_with_http_info()
        • ControllerApi.get_flow_analysis_rule()
        • ControllerApi.get_flow_analysis_rule_property_descriptor()
        • ControllerApi.get_flow_analysis_rule_property_descriptor_with_http_info()
        • ControllerApi.get_flow_analysis_rule_state()
        • ControllerApi.get_flow_analysis_rule_state_with_http_info()
        • ControllerApi.get_flow_analysis_rule_verification_request()
        • ControllerApi.get_flow_analysis_rule_verification_request_with_http_info()
        • ControllerApi.get_flow_analysis_rule_with_http_info()
        • ControllerApi.get_flow_analysis_rules()
        • ControllerApi.get_flow_analysis_rules_with_http_info()
        • ControllerApi.get_flow_registry_client()
        • ControllerApi.get_flow_registry_client_with_http_info()
        • ControllerApi.get_flow_registry_clients()
        • ControllerApi.get_flow_registry_clients_with_http_info()
        • ControllerApi.get_nar_details()
        • ControllerApi.get_nar_details_with_http_info()
        • ControllerApi.get_nar_summaries()
        • ControllerApi.get_nar_summaries_with_http_info()
        • ControllerApi.get_nar_summary()
        • ControllerApi.get_nar_summary_with_http_info()
        • ControllerApi.get_node()
        • ControllerApi.get_node_status_history()
        • ControllerApi.get_node_status_history_with_http_info()
        • ControllerApi.get_node_with_http_info()
        • ControllerApi.get_property_descriptor()
        • ControllerApi.get_property_descriptor_with_http_info()
        • ControllerApi.get_registry_client_types()
        • ControllerApi.get_registry_client_types_with_http_info()
        • ControllerApi.get_registry_client_verification_request()
        • ControllerApi.get_registry_client_verification_request_with_http_info()
        • ControllerApi.import_reporting_task_snapshot()
        • ControllerApi.import_reporting_task_snapshot_with_http_info()
        • ControllerApi.remove_flow_analysis_rule()
        • ControllerApi.remove_flow_analysis_rule_with_http_info()
        • ControllerApi.submit_flow_analysis_rule_config_verification_request()
        • ControllerApi.submit_flow_analysis_rule_config_verification_request_with_http_info()
        • ControllerApi.submit_registry_client_config_verification_request()
        • ControllerApi.submit_registry_client_config_verification_request_with_http_info()
        • ControllerApi.update_controller_config()
        • ControllerApi.update_controller_config_with_http_info()
        • ControllerApi.update_flow_analysis_rule()
        • ControllerApi.update_flow_analysis_rule_with_http_info()
        • ControllerApi.update_flow_registry_client()
        • ControllerApi.update_flow_registry_client_with_http_info()
        • ControllerApi.update_node()
        • ControllerApi.update_node_with_http_info()
        • ControllerApi.update_run_status()
        • ControllerApi.update_run_status_with_http_info()
        • ControllerApi.upload_nar()
        • ControllerApi.upload_nar_with_http_info()
      • ControllerServicesApi
        • ControllerServicesApi.__init__()
        • ControllerServicesApi.analyze_configuration()
        • ControllerServicesApi.analyze_configuration_with_http_info()
        • ControllerServicesApi.clear_bulletins()
        • ControllerServicesApi.clear_bulletins_with_http_info()
        • ControllerServicesApi.clear_state1()
        • ControllerServicesApi.clear_state1_with_http_info()
        • ControllerServicesApi.delete_verification_request()
        • ControllerServicesApi.delete_verification_request_with_http_info()
        • ControllerServicesApi.get_controller_service()
        • ControllerServicesApi.get_controller_service_references()
        • ControllerServicesApi.get_controller_service_references_with_http_info()
        • ControllerServicesApi.get_controller_service_with_http_info()
        • ControllerServicesApi.get_property_descriptor1()
        • ControllerServicesApi.get_property_descriptor1_with_http_info()
        • ControllerServicesApi.get_state()
        • ControllerServicesApi.get_state_with_http_info()
        • ControllerServicesApi.get_verification_request()
        • ControllerServicesApi.get_verification_request_with_http_info()
        • ControllerServicesApi.remove_controller_service()
        • ControllerServicesApi.remove_controller_service_with_http_info()
        • ControllerServicesApi.submit_config_verification_request()
        • ControllerServicesApi.submit_config_verification_request_with_http_info()
        • ControllerServicesApi.update_controller_service()
        • ControllerServicesApi.update_controller_service_references()
        • ControllerServicesApi.update_controller_service_references_with_http_info()
        • ControllerServicesApi.update_controller_service_with_http_info()
        • ControllerServicesApi.update_run_status1()
        • ControllerServicesApi.update_run_status1_with_http_info()
      • CountersApi
        • CountersApi.__init__()
        • CountersApi.get_counters()
        • CountersApi.get_counters_with_http_info()
        • CountersApi.update_all_counters()
        • CountersApi.update_all_counters_with_http_info()
        • CountersApi.update_counter()
        • CountersApi.update_counter_with_http_info()
      • DataTransferApi
        • DataTransferApi.__init__()
        • DataTransferApi.commit_input_port_transaction()
        • DataTransferApi.commit_input_port_transaction_with_http_info()
        • DataTransferApi.commit_output_port_transaction()
        • DataTransferApi.commit_output_port_transaction_with_http_info()
        • DataTransferApi.create_port_transaction()
        • DataTransferApi.create_port_transaction_with_http_info()
        • DataTransferApi.extend_input_port_transaction_ttl()
        • DataTransferApi.extend_input_port_transaction_ttl_with_http_info()
        • DataTransferApi.extend_output_port_transaction_ttl()
        • DataTransferApi.extend_output_port_transaction_ttl_with_http_info()
        • DataTransferApi.receive_flow_files()
        • DataTransferApi.receive_flow_files_with_http_info()
        • DataTransferApi.transfer_flow_files()
        • DataTransferApi.transfer_flow_files_with_http_info()
      • FlowApi
        • FlowApi.__init__()
        • FlowApi.activate_controller_services()
        • FlowApi.activate_controller_services_with_http_info()
        • FlowApi.clear_bulletins1()
        • FlowApi.clear_bulletins1_with_http_info()
        • FlowApi.download_reporting_task_snapshot()
        • FlowApi.download_reporting_task_snapshot_with_http_info()
        • FlowApi.generate_client_id()
        • FlowApi.generate_client_id_with_http_info()
        • FlowApi.get_about_info()
        • FlowApi.get_about_info_with_http_info()
        • FlowApi.get_action()
        • FlowApi.get_action_with_http_info()
        • FlowApi.get_additional_details()
        • FlowApi.get_additional_details_with_http_info()
        • FlowApi.get_all_flow_analysis_results()
        • FlowApi.get_all_flow_analysis_results_with_http_info()
        • FlowApi.get_banners()
        • FlowApi.get_banners_with_http_info()
        • FlowApi.get_branches()
        • FlowApi.get_branches_with_http_info()
        • FlowApi.get_breadcrumbs()
        • FlowApi.get_breadcrumbs_with_http_info()
        • FlowApi.get_buckets()
        • FlowApi.get_buckets_with_http_info()
        • FlowApi.get_bulletin_board()
        • FlowApi.get_bulletin_board_with_http_info()
        • FlowApi.get_bulletins()
        • FlowApi.get_bulletins_with_http_info()
        • FlowApi.get_cluster_summary()
        • FlowApi.get_cluster_summary_with_http_info()
        • FlowApi.get_component_history()
        • FlowApi.get_component_history_with_http_info()
        • FlowApi.get_connection_statistics()
        • FlowApi.get_connection_statistics_with_http_info()
        • FlowApi.get_connection_status()
        • FlowApi.get_connection_status_history()
        • FlowApi.get_connection_status_history_with_http_info()
        • FlowApi.get_connection_status_with_http_info()
        • FlowApi.get_content_viewers()
        • FlowApi.get_content_viewers_with_http_info()
        • FlowApi.get_controller_service_definition()
        • FlowApi.get_controller_service_definition_with_http_info()
        • FlowApi.get_controller_service_types()
        • FlowApi.get_controller_service_types_with_http_info()
        • FlowApi.get_controller_services_from_controller()
        • FlowApi.get_controller_services_from_controller_with_http_info()
        • FlowApi.get_controller_services_from_group()
        • FlowApi.get_controller_services_from_group_with_http_info()
        • FlowApi.get_controller_status()
        • FlowApi.get_controller_status_with_http_info()
        • FlowApi.get_current_user()
        • FlowApi.get_current_user_with_http_info()
        • FlowApi.get_details()
        • FlowApi.get_details_with_http_info()
        • FlowApi.get_flow()
        • FlowApi.get_flow_analysis_results()
        • FlowApi.get_flow_analysis_results_with_http_info()
        • FlowApi.get_flow_analysis_rule_definition()
        • FlowApi.get_flow_analysis_rule_definition_with_http_info()
        • FlowApi.get_flow_analysis_rule_types()
        • FlowApi.get_flow_analysis_rule_types_with_http_info()
        • FlowApi.get_flow_config()
        • FlowApi.get_flow_config_with_http_info()
        • FlowApi.get_flow_metrics()
        • FlowApi.get_flow_metrics_with_http_info()
        • FlowApi.get_flow_registry_client_definition()
        • FlowApi.get_flow_registry_client_definition_with_http_info()
        • FlowApi.get_flow_with_http_info()
        • FlowApi.get_flows()
        • FlowApi.get_flows_with_http_info()
        • FlowApi.get_input_port_status()
        • FlowApi.get_input_port_status_with_http_info()
        • FlowApi.get_listen_ports()
        • FlowApi.get_listen_ports_with_http_info()
        • FlowApi.get_output_port_status()
        • FlowApi.get_output_port_status_with_http_info()
        • FlowApi.get_parameter_contexts()
        • FlowApi.get_parameter_contexts_with_http_info()
        • FlowApi.get_parameter_provider_definition()
        • FlowApi.get_parameter_provider_definition_with_http_info()
        • FlowApi.get_parameter_provider_types()
        • FlowApi.get_parameter_provider_types_with_http_info()
        • FlowApi.get_parameter_providers()
        • FlowApi.get_parameter_providers_with_http_info()
        • FlowApi.get_prioritizers()
        • FlowApi.get_prioritizers_with_http_info()
        • FlowApi.get_process_group_status()
        • FlowApi.get_process_group_status_history()
        • FlowApi.get_process_group_status_history_with_http_info()
        • FlowApi.get_process_group_status_with_http_info()
        • FlowApi.get_processor_definition()
        • FlowApi.get_processor_definition_with_http_info()
        • FlowApi.get_processor_status()
        • FlowApi.get_processor_status_history()
        • FlowApi.get_processor_status_history_with_http_info()
        • FlowApi.get_processor_status_with_http_info()
        • FlowApi.get_processor_types()
        • FlowApi.get_processor_types_with_http_info()
        • FlowApi.get_registry_clients()
        • FlowApi.get_registry_clients_with_http_info()
        • FlowApi.get_remote_process_group_status()
        • FlowApi.get_remote_process_group_status_history()
        • FlowApi.get_remote_process_group_status_history_with_http_info()
        • FlowApi.get_remote_process_group_status_with_http_info()
        • FlowApi.get_reporting_task_definition()
        • FlowApi.get_reporting_task_definition_with_http_info()
        • FlowApi.get_reporting_task_snapshot()
        • FlowApi.get_reporting_task_snapshot_with_http_info()
        • FlowApi.get_reporting_task_types()
        • FlowApi.get_reporting_task_types_with_http_info()
        • FlowApi.get_reporting_tasks()
        • FlowApi.get_reporting_tasks_with_http_info()
        • FlowApi.get_runtime_manifest()
        • FlowApi.get_runtime_manifest_with_http_info()
        • FlowApi.get_version_differences()
        • FlowApi.get_version_differences_with_http_info()
        • FlowApi.get_versions()
        • FlowApi.get_versions_with_http_info()
        • FlowApi.query_history()
        • FlowApi.query_history_with_http_info()
        • FlowApi.schedule_components()
        • FlowApi.schedule_components_with_http_info()
        • FlowApi.search_cluster()
        • FlowApi.search_cluster_with_http_info()
        • FlowApi.search_flow()
        • FlowApi.search_flow_with_http_info()
      • FlowFileQueuesApi
        • FlowFileQueuesApi.__init__()
        • FlowFileQueuesApi.create_drop_request()
        • FlowFileQueuesApi.create_drop_request_with_http_info()
        • FlowFileQueuesApi.create_flow_file_listing()
        • FlowFileQueuesApi.create_flow_file_listing_with_http_info()
        • FlowFileQueuesApi.delete_listing_request()
        • FlowFileQueuesApi.delete_listing_request_with_http_info()
        • FlowFileQueuesApi.download_flow_file_content()
        • FlowFileQueuesApi.download_flow_file_content_with_http_info()
        • FlowFileQueuesApi.get_drop_request()
        • FlowFileQueuesApi.get_drop_request_with_http_info()
        • FlowFileQueuesApi.get_flow_file()
        • FlowFileQueuesApi.get_flow_file_with_http_info()
        • FlowFileQueuesApi.get_listing_request()
        • FlowFileQueuesApi.get_listing_request_with_http_info()
        • FlowFileQueuesApi.remove_drop_request()
        • FlowFileQueuesApi.remove_drop_request_with_http_info()
      • FunnelsApi
        • FunnelsApi.__init__()
        • FunnelsApi.get_funnel()
        • FunnelsApi.get_funnel_with_http_info()
        • FunnelsApi.remove_funnel()
        • FunnelsApi.remove_funnel_with_http_info()
        • FunnelsApi.update_funnel()
        • FunnelsApi.update_funnel_with_http_info()
      • InputPortsApi
        • InputPortsApi.__init__()
        • InputPortsApi.clear_bulletins2()
        • InputPortsApi.clear_bulletins2_with_http_info()
        • InputPortsApi.get_input_port()
        • InputPortsApi.get_input_port_with_http_info()
        • InputPortsApi.remove_input_port()
        • InputPortsApi.remove_input_port_with_http_info()
        • InputPortsApi.update_input_port()
        • InputPortsApi.update_input_port_with_http_info()
        • InputPortsApi.update_run_status2()
        • InputPortsApi.update_run_status2_with_http_info()
      • LabelsApi
        • LabelsApi.__init__()
        • LabelsApi.get_label()
        • LabelsApi.get_label_with_http_info()
        • LabelsApi.remove_label()
        • LabelsApi.remove_label_with_http_info()
        • LabelsApi.update_label()
        • LabelsApi.update_label_with_http_info()
      • OutputPortsApi
        • OutputPortsApi.__init__()
        • OutputPortsApi.clear_bulletins3()
        • OutputPortsApi.clear_bulletins3_with_http_info()
        • OutputPortsApi.get_output_port()
        • OutputPortsApi.get_output_port_with_http_info()
        • OutputPortsApi.remove_output_port()
        • OutputPortsApi.remove_output_port_with_http_info()
        • OutputPortsApi.update_output_port()
        • OutputPortsApi.update_output_port_with_http_info()
        • OutputPortsApi.update_run_status3()
        • OutputPortsApi.update_run_status3_with_http_info()
      • ParameterContextsApi
        • ParameterContextsApi.__init__()
        • ParameterContextsApi.create_asset()
        • ParameterContextsApi.create_asset_with_http_info()
        • ParameterContextsApi.create_parameter_context()
        • ParameterContextsApi.create_parameter_context_with_http_info()
        • ParameterContextsApi.delete_asset()
        • ParameterContextsApi.delete_asset_with_http_info()
        • ParameterContextsApi.delete_parameter_context()
        • ParameterContextsApi.delete_parameter_context_with_http_info()
        • ParameterContextsApi.delete_update_request()
        • ParameterContextsApi.delete_update_request_with_http_info()
        • ParameterContextsApi.delete_validation_request()
        • ParameterContextsApi.delete_validation_request_with_http_info()
        • ParameterContextsApi.get_asset_content()
        • ParameterContextsApi.get_asset_content_with_http_info()
        • ParameterContextsApi.get_assets()
        • ParameterContextsApi.get_assets_with_http_info()
        • ParameterContextsApi.get_parameter_context()
        • ParameterContextsApi.get_parameter_context_update()
        • ParameterContextsApi.get_parameter_context_update_with_http_info()
        • ParameterContextsApi.get_parameter_context_with_http_info()
        • ParameterContextsApi.get_validation_request()
        • ParameterContextsApi.get_validation_request_with_http_info()
        • ParameterContextsApi.submit_parameter_context_update()
        • ParameterContextsApi.submit_parameter_context_update_with_http_info()
        • ParameterContextsApi.submit_validation_request()
        • ParameterContextsApi.submit_validation_request_with_http_info()
        • ParameterContextsApi.update_parameter_context()
        • ParameterContextsApi.update_parameter_context_with_http_info()
      • ParameterProvidersApi
        • ParameterProvidersApi.__init__()
        • ParameterProvidersApi.analyze_configuration1()
        • ParameterProvidersApi.analyze_configuration1_with_http_info()
        • ParameterProvidersApi.clear_bulletins4()
        • ParameterProvidersApi.clear_bulletins4_with_http_info()
        • ParameterProvidersApi.clear_state2()
        • ParameterProvidersApi.clear_state2_with_http_info()
        • ParameterProvidersApi.delete_apply_parameters_request()
        • ParameterProvidersApi.delete_apply_parameters_request_with_http_info()
        • ParameterProvidersApi.delete_verification_request1()
        • ParameterProvidersApi.delete_verification_request1_with_http_info()
        • ParameterProvidersApi.fetch_parameters()
        • ParameterProvidersApi.fetch_parameters_with_http_info()
        • ParameterProvidersApi.get_parameter_provider()
        • ParameterProvidersApi.get_parameter_provider_apply_parameters_request()
        • ParameterProvidersApi.get_parameter_provider_apply_parameters_request_with_http_info()
        • ParameterProvidersApi.get_parameter_provider_references()
        • ParameterProvidersApi.get_parameter_provider_references_with_http_info()
        • ParameterProvidersApi.get_parameter_provider_with_http_info()
        • ParameterProvidersApi.get_property_descriptor2()
        • ParameterProvidersApi.get_property_descriptor2_with_http_info()
        • ParameterProvidersApi.get_state1()
        • ParameterProvidersApi.get_state1_with_http_info()
        • ParameterProvidersApi.get_verification_request1()
        • ParameterProvidersApi.get_verification_request1_with_http_info()
        • ParameterProvidersApi.remove_parameter_provider()
        • ParameterProvidersApi.remove_parameter_provider_with_http_info()
        • ParameterProvidersApi.submit_apply_parameters()
        • ParameterProvidersApi.submit_apply_parameters_with_http_info()
        • ParameterProvidersApi.submit_config_verification_request1()
        • ParameterProvidersApi.submit_config_verification_request1_with_http_info()
        • ParameterProvidersApi.update_parameter_provider()
        • ParameterProvidersApi.update_parameter_provider_with_http_info()
      • PoliciesApi
        • PoliciesApi.__init__()
        • PoliciesApi.create_access_policy()
        • PoliciesApi.create_access_policy_with_http_info()
        • PoliciesApi.get_access_policy()
        • PoliciesApi.get_access_policy_for_resource()
        • PoliciesApi.get_access_policy_for_resource_with_http_info()
        • PoliciesApi.get_access_policy_with_http_info()
        • PoliciesApi.remove_access_policy()
        • PoliciesApi.remove_access_policy_with_http_info()
        • PoliciesApi.update_access_policy()
        • PoliciesApi.update_access_policy_with_http_info()
      • ProcessGroupsApi
        • ProcessGroupsApi.__init__()
        • ProcessGroupsApi.copy()
        • ProcessGroupsApi.copy_snippet()
        • ProcessGroupsApi.copy_snippet_with_http_info()
        • ProcessGroupsApi.copy_with_http_info()
        • ProcessGroupsApi.create_connection()
        • ProcessGroupsApi.create_connection_with_http_info()
        • ProcessGroupsApi.create_controller_service1()
        • ProcessGroupsApi.create_controller_service1_with_http_info()
        • ProcessGroupsApi.create_empty_all_connections_request()
        • ProcessGroupsApi.create_empty_all_connections_request_with_http_info()
        • ProcessGroupsApi.create_funnel()
        • ProcessGroupsApi.create_funnel_with_http_info()
        • ProcessGroupsApi.create_input_port()
        • ProcessGroupsApi.create_input_port_with_http_info()
        • ProcessGroupsApi.create_label()
        • ProcessGroupsApi.create_label_with_http_info()
        • ProcessGroupsApi.create_output_port()
        • ProcessGroupsApi.create_output_port_with_http_info()
        • ProcessGroupsApi.create_process_group()
        • ProcessGroupsApi.create_process_group_with_http_info()
        • ProcessGroupsApi.create_processor()
        • ProcessGroupsApi.create_processor_with_http_info()
        • ProcessGroupsApi.create_remote_process_group()
        • ProcessGroupsApi.create_remote_process_group_with_http_info()
        • ProcessGroupsApi.delete_replace_process_group_request()
        • ProcessGroupsApi.delete_replace_process_group_request_with_http_info()
        • ProcessGroupsApi.export_process_group()
        • ProcessGroupsApi.export_process_group_with_http_info()
        • ProcessGroupsApi.get_connections()
        • ProcessGroupsApi.get_connections_with_http_info()
        • ProcessGroupsApi.get_drop_all_flowfiles_request()
        • ProcessGroupsApi.get_drop_all_flowfiles_request_with_http_info()
        • ProcessGroupsApi.get_funnels()
        • ProcessGroupsApi.get_funnels_with_http_info()
        • ProcessGroupsApi.get_input_ports()
        • ProcessGroupsApi.get_input_ports_with_http_info()
        • ProcessGroupsApi.get_labels()
        • ProcessGroupsApi.get_labels_with_http_info()
        • ProcessGroupsApi.get_local_modifications()
        • ProcessGroupsApi.get_local_modifications_with_http_info()
        • ProcessGroupsApi.get_output_ports()
        • ProcessGroupsApi.get_output_ports_with_http_info()
        • ProcessGroupsApi.get_process_group()
        • ProcessGroupsApi.get_process_group_with_http_info()
        • ProcessGroupsApi.get_process_groups()
        • ProcessGroupsApi.get_process_groups_with_http_info()
        • ProcessGroupsApi.get_processors()
        • ProcessGroupsApi.get_processors_with_http_info()
        • ProcessGroupsApi.get_remote_process_groups()
        • ProcessGroupsApi.get_remote_process_groups_with_http_info()
        • ProcessGroupsApi.get_replace_process_group_request()
        • ProcessGroupsApi.get_replace_process_group_request_with_http_info()
        • ProcessGroupsApi.import_process_group()
        • ProcessGroupsApi.import_process_group_with_http_info()
        • ProcessGroupsApi.initiate_replace_process_group()
        • ProcessGroupsApi.initiate_replace_process_group_with_http_info()
        • ProcessGroupsApi.paste()
        • ProcessGroupsApi.paste_with_http_info()
        • ProcessGroupsApi.remove_drop_request1()
        • ProcessGroupsApi.remove_drop_request1_with_http_info()
        • ProcessGroupsApi.remove_process_group()
        • ProcessGroupsApi.remove_process_group_with_http_info()
        • ProcessGroupsApi.replace_process_group()
        • ProcessGroupsApi.replace_process_group_with_http_info()
        • ProcessGroupsApi.update_process_group()
        • ProcessGroupsApi.update_process_group_with_http_info()
        • ProcessGroupsApi.upload_process_group()
        • ProcessGroupsApi.upload_process_group_with_http_info()
      • ProcessorsApi
        • ProcessorsApi.__init__()
        • ProcessorsApi.analyze_configuration2()
        • ProcessorsApi.analyze_configuration2_with_http_info()
        • ProcessorsApi.clear_bulletins5()
        • ProcessorsApi.clear_bulletins5_with_http_info()
        • ProcessorsApi.clear_state3()
        • ProcessorsApi.clear_state3_with_http_info()
        • ProcessorsApi.delete_processor()
        • ProcessorsApi.delete_processor_with_http_info()
        • ProcessorsApi.delete_verification_request2()
        • ProcessorsApi.delete_verification_request2_with_http_info()
        • ProcessorsApi.get_processor()
        • ProcessorsApi.get_processor_diagnostics()
        • ProcessorsApi.get_processor_diagnostics_with_http_info()
        • ProcessorsApi.get_processor_run_status_details()
        • ProcessorsApi.get_processor_run_status_details_with_http_info()
        • ProcessorsApi.get_processor_with_http_info()
        • ProcessorsApi.get_property_descriptor3()
        • ProcessorsApi.get_property_descriptor3_with_http_info()
        • ProcessorsApi.get_state2()
        • ProcessorsApi.get_state2_with_http_info()
        • ProcessorsApi.get_verification_request2()
        • ProcessorsApi.get_verification_request2_with_http_info()
        • ProcessorsApi.submit_processor_verification_request()
        • ProcessorsApi.submit_processor_verification_request_with_http_info()
        • ProcessorsApi.terminate_processor()
        • ProcessorsApi.terminate_processor_with_http_info()
        • ProcessorsApi.update_processor()
        • ProcessorsApi.update_processor_with_http_info()
        • ProcessorsApi.update_run_status4()
        • ProcessorsApi.update_run_status4_with_http_info()
      • ProvenanceApi
        • ProvenanceApi.__init__()
        • ProvenanceApi.delete_lineage()
        • ProvenanceApi.delete_lineage_with_http_info()
        • ProvenanceApi.delete_provenance()
        • ProvenanceApi.delete_provenance_with_http_info()
        • ProvenanceApi.get_lineage()
        • ProvenanceApi.get_lineage_with_http_info()
        • ProvenanceApi.get_provenance()
        • ProvenanceApi.get_provenance_with_http_info()
        • ProvenanceApi.get_search_options()
        • ProvenanceApi.get_search_options_with_http_info()
        • ProvenanceApi.submit_lineage_request()
        • ProvenanceApi.submit_lineage_request_with_http_info()
        • ProvenanceApi.submit_provenance_request()
        • ProvenanceApi.submit_provenance_request_with_http_info()
      • ProvenanceEventsApi
        • ProvenanceEventsApi.__init__()
        • ProvenanceEventsApi.get_input_content()
        • ProvenanceEventsApi.get_input_content_with_http_info()
        • ProvenanceEventsApi.get_latest_provenance_events()
        • ProvenanceEventsApi.get_latest_provenance_events_with_http_info()
        • ProvenanceEventsApi.get_output_content()
        • ProvenanceEventsApi.get_output_content_with_http_info()
        • ProvenanceEventsApi.get_provenance_event()
        • ProvenanceEventsApi.get_provenance_event_with_http_info()
        • ProvenanceEventsApi.submit_replay()
        • ProvenanceEventsApi.submit_replay_latest_event()
        • ProvenanceEventsApi.submit_replay_latest_event_with_http_info()
        • ProvenanceEventsApi.submit_replay_with_http_info()
      • RemoteProcessGroupsApi
        • RemoteProcessGroupsApi.__init__()
        • RemoteProcessGroupsApi.clear_bulletins6()
        • RemoteProcessGroupsApi.clear_bulletins6_with_http_info()
        • RemoteProcessGroupsApi.get_remote_process_group()
        • RemoteProcessGroupsApi.get_remote_process_group_with_http_info()
        • RemoteProcessGroupsApi.get_state3()
        • RemoteProcessGroupsApi.get_state3_with_http_info()
        • RemoteProcessGroupsApi.remove_remote_process_group()
        • RemoteProcessGroupsApi.remove_remote_process_group_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group()
        • RemoteProcessGroupsApi.update_remote_process_group_input_port()
        • RemoteProcessGroupsApi.update_remote_process_group_input_port_run_status()
        • RemoteProcessGroupsApi.update_remote_process_group_input_port_run_status_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_input_port_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_output_port()
        • RemoteProcessGroupsApi.update_remote_process_group_output_port_run_status()
        • RemoteProcessGroupsApi.update_remote_process_group_output_port_run_status_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_output_port_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_run_status()
        • RemoteProcessGroupsApi.update_remote_process_group_run_status_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_run_statuses()
        • RemoteProcessGroupsApi.update_remote_process_group_run_statuses_with_http_info()
        • RemoteProcessGroupsApi.update_remote_process_group_with_http_info()
      • ReportingTasksApi
        • ReportingTasksApi.__init__()
        • ReportingTasksApi.analyze_configuration3()
        • ReportingTasksApi.analyze_configuration3_with_http_info()
        • ReportingTasksApi.clear_bulletins7()
        • ReportingTasksApi.clear_bulletins7_with_http_info()
        • ReportingTasksApi.clear_state4()
        • ReportingTasksApi.clear_state4_with_http_info()
        • ReportingTasksApi.delete_verification_request3()
        • ReportingTasksApi.delete_verification_request3_with_http_info()
        • ReportingTasksApi.get_property_descriptor4()
        • ReportingTasksApi.get_property_descriptor4_with_http_info()
        • ReportingTasksApi.get_reporting_task()
        • ReportingTasksApi.get_reporting_task_with_http_info()
        • ReportingTasksApi.get_state4()
        • ReportingTasksApi.get_state4_with_http_info()
        • ReportingTasksApi.get_verification_request3()
        • ReportingTasksApi.get_verification_request3_with_http_info()
        • ReportingTasksApi.remove_reporting_task()
        • ReportingTasksApi.remove_reporting_task_with_http_info()
        • ReportingTasksApi.submit_config_verification_request2()
        • ReportingTasksApi.submit_config_verification_request2_with_http_info()
        • ReportingTasksApi.update_reporting_task()
        • ReportingTasksApi.update_reporting_task_with_http_info()
        • ReportingTasksApi.update_run_status5()
        • ReportingTasksApi.update_run_status5_with_http_info()
      • ResourcesApi
        • ResourcesApi.__init__()
        • ResourcesApi.get_resources()
        • ResourcesApi.get_resources_with_http_info()
      • SiteToSiteApi
        • SiteToSiteApi.__init__()
        • SiteToSiteApi.get_peers()
        • SiteToSiteApi.get_peers_with_http_info()
        • SiteToSiteApi.get_site_to_site_details()
        • SiteToSiteApi.get_site_to_site_details_with_http_info()
      • SnippetsApi
        • SnippetsApi.__init__()
        • SnippetsApi.create_snippet()
        • SnippetsApi.create_snippet_with_http_info()
        • SnippetsApi.delete_snippet()
        • SnippetsApi.delete_snippet_with_http_info()
        • SnippetsApi.update_snippet()
        • SnippetsApi.update_snippet_with_http_info()
      • SystemDiagnosticsApi
        • SystemDiagnosticsApi.__init__()
        • SystemDiagnosticsApi.get_jmx_metrics()
        • SystemDiagnosticsApi.get_jmx_metrics_with_http_info()
        • SystemDiagnosticsApi.get_system_diagnostics()
        • SystemDiagnosticsApi.get_system_diagnostics_with_http_info()
      • TenantsApi
        • TenantsApi.__init__()
        • TenantsApi.create_user()
        • TenantsApi.create_user_group()
        • TenantsApi.create_user_group_with_http_info()
        • TenantsApi.create_user_with_http_info()
        • TenantsApi.get_user()
        • TenantsApi.get_user_group()
        • TenantsApi.get_user_group_with_http_info()
        • TenantsApi.get_user_groups()
        • TenantsApi.get_user_groups_with_http_info()
        • TenantsApi.get_user_with_http_info()
        • TenantsApi.get_users()
        • TenantsApi.get_users_with_http_info()
        • TenantsApi.remove_user()
        • TenantsApi.remove_user_group()
        • TenantsApi.remove_user_group_with_http_info()
        • TenantsApi.remove_user_with_http_info()
        • TenantsApi.search_tenants()
        • TenantsApi.search_tenants_with_http_info()
        • TenantsApi.update_user()
        • TenantsApi.update_user_group()
        • TenantsApi.update_user_group_with_http_info()
        • TenantsApi.update_user_with_http_info()
      • VersionsApi
        • VersionsApi.__init__()
        • VersionsApi.create_version_control_request()
        • VersionsApi.create_version_control_request_with_http_info()
        • VersionsApi.delete_revert_request()
        • VersionsApi.delete_revert_request_with_http_info()
        • VersionsApi.delete_update_request1()
        • VersionsApi.delete_update_request1_with_http_info()
        • VersionsApi.delete_version_control_request()
        • VersionsApi.delete_version_control_request_with_http_info()
        • VersionsApi.export_flow_version()
        • VersionsApi.export_flow_version_with_http_info()
        • VersionsApi.get_revert_request()
        • VersionsApi.get_revert_request_with_http_info()
        • VersionsApi.get_update_request()
        • VersionsApi.get_update_request_with_http_info()
        • VersionsApi.get_version_information()
        • VersionsApi.get_version_information_with_http_info()
        • VersionsApi.initiate_revert_flow_version()
        • VersionsApi.initiate_revert_flow_version_with_http_info()
        • VersionsApi.initiate_version_control_update()
        • VersionsApi.initiate_version_control_update_with_http_info()
        • VersionsApi.save_to_flow_registry()
        • VersionsApi.save_to_flow_registry_with_http_info()
        • VersionsApi.stop_version_control()
        • VersionsApi.stop_version_control_with_http_info()
        • VersionsApi.update_flow_version()
        • VersionsApi.update_flow_version_with_http_info()
        • VersionsApi.update_version_control_request()
        • VersionsApi.update_version_control_request_with_http_info()
    • NiFi Models
      • NiFi Models
        • Model Type Patterns
        • All Model Classes
    • Registry APIs
      • AboutApi
        • AboutApi.__init__()
        • AboutApi.get_version()
        • AboutApi.get_version_with_http_info()
      • AccessApi
        • AccessApi.__init__()
        • AccessApi.create_access_token_by_trying_all_providers()
        • AccessApi.create_access_token_by_trying_all_providers_with_http_info()
        • AccessApi.create_access_token_using_basic_auth_credentials()
        • AccessApi.create_access_token_using_basic_auth_credentials_with_http_info()
        • AccessApi.create_access_token_using_identity_provider_credentials()
        • AccessApi.create_access_token_using_identity_provider_credentials_with_http_info()
        • AccessApi.create_access_token_using_kerberos_ticket()
        • AccessApi.create_access_token_using_kerberos_ticket_with_http_info()
        • AccessApi.get_access_status()
        • AccessApi.get_access_status_with_http_info()
        • AccessApi.get_identity_provider_usage_instructions()
        • AccessApi.get_identity_provider_usage_instructions_with_http_info()
        • AccessApi.logout()
        • AccessApi.logout_complete()
        • AccessApi.logout_complete_with_http_info()
        • AccessApi.logout_with_http_info()
        • AccessApi.oidc_callback()
        • AccessApi.oidc_callback_with_http_info()
        • AccessApi.oidc_exchange()
        • AccessApi.oidc_exchange_with_http_info()
        • AccessApi.oidc_logout()
        • AccessApi.oidc_logout_callback()
        • AccessApi.oidc_logout_callback_with_http_info()
        • AccessApi.oidc_logout_with_http_info()
        • AccessApi.oidc_request()
        • AccessApi.oidc_request_with_http_info()
        • AccessApi.test_identity_provider_recognizes_credentials_format()
        • AccessApi.test_identity_provider_recognizes_credentials_format_with_http_info()
      • BucketBundlesApi
        • BucketBundlesApi.__init__()
        • BucketBundlesApi.create_extension_bundle_version()
        • BucketBundlesApi.create_extension_bundle_version_with_http_info()
        • BucketBundlesApi.get_extension_bundles()
        • BucketBundlesApi.get_extension_bundles_with_http_info()
      • BucketFlowsApi
        • BucketFlowsApi.__init__()
        • BucketFlowsApi.create_flow()
        • BucketFlowsApi.create_flow_version()
        • BucketFlowsApi.create_flow_version_with_http_info()
        • BucketFlowsApi.create_flow_with_http_info()
        • BucketFlowsApi.delete_flow()
        • BucketFlowsApi.delete_flow_with_http_info()
        • BucketFlowsApi.export_versioned_flow()
        • BucketFlowsApi.export_versioned_flow_with_http_info()
        • BucketFlowsApi.get_flow()
        • BucketFlowsApi.get_flow_diff()
        • BucketFlowsApi.get_flow_diff_with_http_info()
        • BucketFlowsApi.get_flow_version()
        • BucketFlowsApi.get_flow_version_with_http_info()
        • BucketFlowsApi.get_flow_versions()
        • BucketFlowsApi.get_flow_versions_with_http_info()
        • BucketFlowsApi.get_flow_with_http_info()
        • BucketFlowsApi.get_flows()
        • BucketFlowsApi.get_flows_with_http_info()
        • BucketFlowsApi.get_latest_flow_version()
        • BucketFlowsApi.get_latest_flow_version_metadata()
        • BucketFlowsApi.get_latest_flow_version_metadata_with_http_info()
        • BucketFlowsApi.get_latest_flow_version_with_http_info()
        • BucketFlowsApi.import_versioned_flow()
        • BucketFlowsApi.import_versioned_flow_with_http_info()
        • BucketFlowsApi.update_flow()
        • BucketFlowsApi.update_flow_with_http_info()
      • BucketsApi
        • BucketsApi.__init__()
        • BucketsApi.create_bucket()
        • BucketsApi.create_bucket_with_http_info()
        • BucketsApi.delete_bucket()
        • BucketsApi.delete_bucket_with_http_info()
        • BucketsApi.get_available_bucket_fields()
        • BucketsApi.get_available_bucket_fields_with_http_info()
        • BucketsApi.get_bucket()
        • BucketsApi.get_bucket_with_http_info()
        • BucketsApi.get_buckets()
        • BucketsApi.get_buckets_with_http_info()
        • BucketsApi.update_bucket()
        • BucketsApi.update_bucket_with_http_info()
      • BundlesApi
        • BundlesApi.__init__()
        • BundlesApi.delete_bundle()
        • BundlesApi.delete_bundle_version()
        • BundlesApi.delete_bundle_version_with_http_info()
        • BundlesApi.delete_bundle_with_http_info()
        • BundlesApi.get_bundle()
        • BundlesApi.get_bundle_version()
        • BundlesApi.get_bundle_version_content()
        • BundlesApi.get_bundle_version_content_with_http_info()
        • BundlesApi.get_bundle_version_extension()
        • BundlesApi.get_bundle_version_extension_additional_details_docs()
        • BundlesApi.get_bundle_version_extension_additional_details_docs_with_http_info()
        • BundlesApi.get_bundle_version_extension_docs()
        • BundlesApi.get_bundle_version_extension_docs_with_http_info()
        • BundlesApi.get_bundle_version_extension_with_http_info()
        • BundlesApi.get_bundle_version_extensions()
        • BundlesApi.get_bundle_version_extensions_with_http_info()
        • BundlesApi.get_bundle_version_with_http_info()
        • BundlesApi.get_bundle_versions()
        • BundlesApi.get_bundle_versions1()
        • BundlesApi.get_bundle_versions1_with_http_info()
        • BundlesApi.get_bundle_versions_with_http_info()
        • BundlesApi.get_bundle_with_http_info()
        • BundlesApi.get_bundles()
        • BundlesApi.get_bundles_with_http_info()
      • ConfigApi
        • ConfigApi.__init__()
        • ConfigApi.get_configuration()
        • ConfigApi.get_configuration_with_http_info()
      • ExtensionRepositoryApi
        • ExtensionRepositoryApi.__init__()
        • ExtensionRepositoryApi.get_extension_repo_artifacts()
        • ExtensionRepositoryApi.get_extension_repo_artifacts_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_buckets()
        • ExtensionRepositoryApi.get_extension_repo_buckets_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_groups()
        • ExtensionRepositoryApi.get_extension_repo_groups_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version()
        • ExtensionRepositoryApi.get_extension_repo_version_content()
        • ExtensionRepositoryApi.get_extension_repo_version_content_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_extension()
        • ExtensionRepositoryApi.get_extension_repo_version_extension_additional_details_docs()
        • ExtensionRepositoryApi.get_extension_repo_version_extension_additional_details_docs_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_extension_docs()
        • ExtensionRepositoryApi.get_extension_repo_version_extension_docs_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_extension_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_extensions()
        • ExtensionRepositoryApi.get_extension_repo_version_extensions_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_sha256()
        • ExtensionRepositoryApi.get_extension_repo_version_sha256_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_version_with_http_info()
        • ExtensionRepositoryApi.get_extension_repo_versions()
        • ExtensionRepositoryApi.get_extension_repo_versions_with_http_info()
        • ExtensionRepositoryApi.get_global_extension_repo_version_sha256()
        • ExtensionRepositoryApi.get_global_extension_repo_version_sha256_with_http_info()
      • ExtensionsApi
        • ExtensionsApi.__init__()
        • ExtensionsApi.get_extensions()
        • ExtensionsApi.get_extensions_providing_service_api()
        • ExtensionsApi.get_extensions_providing_service_api_with_http_info()
        • ExtensionsApi.get_extensions_with_http_info()
        • ExtensionsApi.get_tags()
        • ExtensionsApi.get_tags_with_http_info()
      • FlowsApi
        • FlowsApi.__init__()
        • FlowsApi.get_available_flow_fields()
        • FlowsApi.get_available_flow_fields_with_http_info()
        • FlowsApi.get_flow1()
        • FlowsApi.get_flow1_with_http_info()
        • FlowsApi.get_flow_version1()
        • FlowsApi.get_flow_version1_with_http_info()
        • FlowsApi.get_flow_versions1()
        • FlowsApi.get_flow_versions1_with_http_info()
        • FlowsApi.get_latest_flow_version1()
        • FlowsApi.get_latest_flow_version1_with_http_info()
        • FlowsApi.get_latest_flow_version_metadata1()
        • FlowsApi.get_latest_flow_version_metadata1_with_http_info()
      • ItemsApi
        • ItemsApi.__init__()
        • ItemsApi.get_available_bucket_item_fields()
        • ItemsApi.get_available_bucket_item_fields_with_http_info()
        • ItemsApi.get_items()
        • ItemsApi.get_items1()
        • ItemsApi.get_items1_with_http_info()
        • ItemsApi.get_items_with_http_info()
      • PoliciesApi
        • PoliciesApi.__init__()
        • PoliciesApi.create_access_policy()
        • PoliciesApi.create_access_policy_with_http_info()
        • PoliciesApi.get_access_policies()
        • PoliciesApi.get_access_policies_with_http_info()
        • PoliciesApi.get_access_policy()
        • PoliciesApi.get_access_policy_for_resource()
        • PoliciesApi.get_access_policy_for_resource_with_http_info()
        • PoliciesApi.get_access_policy_with_http_info()
        • PoliciesApi.get_resources()
        • PoliciesApi.get_resources_with_http_info()
        • PoliciesApi.remove_access_policy()
        • PoliciesApi.remove_access_policy_with_http_info()
        • PoliciesApi.update_access_policy()
        • PoliciesApi.update_access_policy_with_http_info()
      • TenantsApi
        • TenantsApi.__init__()
        • TenantsApi.create_user()
        • TenantsApi.create_user_group()
        • TenantsApi.create_user_group_with_http_info()
        • TenantsApi.create_user_with_http_info()
        • TenantsApi.get_user()
        • TenantsApi.get_user_group()
        • TenantsApi.get_user_group_with_http_info()
        • TenantsApi.get_user_groups()
        • TenantsApi.get_user_groups_with_http_info()
        • TenantsApi.get_user_with_http_info()
        • TenantsApi.get_users()
        • TenantsApi.get_users_with_http_info()
        • TenantsApi.remove_user()
        • TenantsApi.remove_user_group()
        • TenantsApi.remove_user_group_with_http_info()
        • TenantsApi.remove_user_with_http_info()
        • TenantsApi.update_user()
        • TenantsApi.update_user_group()
        • TenantsApi.update_user_group_with_http_info()
        • TenantsApi.update_user_with_http_info()
    • Registry Models
      • Registry Models
        • Model Type Patterns
        • All Model Classes
    • Examples and Tutorials
      • Available Examples
      • Quick Start
      • Sandbox Environment
  • Contributing
    • Types of Contributions
      • Report Bugs
      • Fix Bugs
      • Implement Features
      • Write Documentation
      • Submit Feedback
    • Get Started!
    • Common Mistakes to Avoid
    • Reuse Existing Code
    • Make Targets Quick Reference
    • Generated vs Maintained Code
    • Pull Request Guidelines
  • Development Notes
    • Decision Points
    • Docker Test Environment
    • Testing Notes
    • Setup Code Signing
    • Troubleshooting Development Issues
      • Docker and Certificate Issues
      • act (GitHub Actions Local Testing)
    • Generate API Clients
      • Prerequisites
      • Client Generation Workflow
      • Customization
    • Release Process
      • Pre-release Preparation
      • Build and Quality Assurance
      • Create Release
      • Publish to PyPI
      • Post-release Verification
      • Version Management Notes
  • Credits
    • Development Lead
    • Contributors
    • Shout Outs
  • History
    • 1.5.1 (2026-06-02)
    • 1.5.0 (2026-01-25)
    • 1.4.1 (2026-01-20)
    • 1.4.0 (2026-01-15)
    • 1.3.0 (2026-01-08)
    • 1.2.0 (2025-12-31)
    • 1.1.0 (2025-12-04)
    • 1.0.1 (2025-11-10)
    • 1.0.0 (2025-09-28)
    • 0.22.0 (2025-03-25)
    • 0.21.0 (2024-07-14)
    • 0.20.0 (2024-04-14)
    • 0.19.1 (2022-08-08)
    • 0.19.0 (2022-05-13)
    • 0.18.0 (2021-11-29)
    • 0.17.1 (2021-10-21)
    • 0.17.0 (2021-10-13)
    • 0.16.3 (2021-10-11)
    • 0.16.2 (2021-02-10)
    • 0.15.0 (2020-11-06)
    • 0.14.0 (2019-11-06)
    • 0.13.3 (2019-10-09)
    • 0.13.0 (2019-04-22)
    • 0.12.0 (2018-12-20)
    • 0.11.0 (2018-10-12)
    • 0.10.3 (2018-08-28)
    • 0.10.2 (2018-08-27)
    • 0.10.1 (2018-08-21)
    • 0.10.0 (2018-08-03)
    • 0.9.1 (2018-05-18)
    • 0.9.0 (2018-05-16)
    • 0.8.0 (2018-03-06)
    • 0.7.0 (2018-01-30)
    • 0.6.1 (2018-01-04)
    • 0.6.0 (2017-12-31)
    • 0.5.1 (2017-12-07)
    • 0.5.0 (2017-12-06)
    • 0.4.0 (2017-10-29)
    • 0.3.2 (2017-09-04)
    • 0.3.1 (2017-09-04)
    • 0.3.0 (2017-09-04)
    • 0.2.1 (2017-08-26)
    • 0.2.0 (2017-08-25)
    • 0.1.2 (2017-08-24)
    • 0.1.1 (2017-08-24)
    • 0.1.0 (2017-08-24)
Nipyapi
  • Search

© Copyright 2017-2025, Daniel Chaffelson.

Built with Sphinx using a theme provided by Read the Docs.