Sysdig SDK for Python
This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs. It exposes most of the sysdig REST API functionality as an easy to use and easy to install Python interface.
Having troubles? We would like to help you!
Looking for specific information? Try the Index
Check out the Sysdig Documentation.
Ask a question in the Sysdig Slack.
API Core Reference
- Sysdig Monitor
SdMonitorClientSdMonitorClient.add_dashboard_panel()SdMonitorClient.clear_agents_config()SdMonitorClient.convert_scope_string_to_expression()SdMonitorClient.create_access_key()SdMonitorClient.create_alert()SdMonitorClient.create_dashboard()SdMonitorClient.create_dashboard_from_dashboard()SdMonitorClient.create_dashboard_from_file()SdMonitorClient.create_dashboard_from_template()SdMonitorClient.create_dashboard_from_view()SdMonitorClient.create_dashboard_with_configuration()SdMonitorClient.create_email_notification_channel()SdMonitorClient.create_notification_channel()SdMonitorClient.create_sysdig_capture()SdMonitorClient.create_team()SdMonitorClient.create_user()SdMonitorClient.create_user_invite()SdMonitorClient.delete_alert()SdMonitorClient.delete_dashboard()SdMonitorClient.delete_event()SdMonitorClient.delete_notification_channel()SdMonitorClient.delete_sysdig_capture()SdMonitorClient.delete_team()SdMonitorClient.delete_user()SdMonitorClient.disable_access_key()SdMonitorClient.download_sysdig_capture()SdMonitorClient.edit_team()SdMonitorClient.edit_user()SdMonitorClient.enable_access_key()SdMonitorClient.favorite_dashboard()SdMonitorClient.find_dashboard_by()SdMonitorClient.get_agents_config()SdMonitorClient.get_alerts()SdMonitorClient.get_connected_agents()SdMonitorClient.get_dashboard()SdMonitorClient.get_dashboards()SdMonitorClient.get_data()SdMonitorClient.get_data_retention_info()SdMonitorClient.get_event()SdMonitorClient.get_events()SdMonitorClient.get_explore_grouping_hierarchy()SdMonitorClient.get_metrics()SdMonitorClient.get_n_connected_agents()SdMonitorClient.get_notification_channel()SdMonitorClient.get_notification_ids()SdMonitorClient.get_notifications()SdMonitorClient.get_sysdig_captures()SdMonitorClient.get_team()SdMonitorClient.get_team_by_id()SdMonitorClient.get_team_ids()SdMonitorClient.get_teams()SdMonitorClient.get_topology_map()SdMonitorClient.get_user()SdMonitorClient.get_user_api_token()SdMonitorClient.get_user_ids()SdMonitorClient.get_user_info()SdMonitorClient.get_user_token()SdMonitorClient.get_users()SdMonitorClient.get_view()SdMonitorClient.get_views_list()SdMonitorClient.lasterrSdMonitorClient.list_access_keys()SdMonitorClient.list_memberships()SdMonitorClient.list_notification_channels()SdMonitorClient.poll_sysdig_capture()SdMonitorClient.post_event()SdMonitorClient.remove_dashboard_panel()SdMonitorClient.remove_memberships()SdMonitorClient.save_dashboard_to_file()SdMonitorClient.save_memberships()SdMonitorClient.set_agents_config()SdMonitorClient.set_explore_grouping_hierarchy()SdMonitorClient.share_dashboard_with_all_teams()SdMonitorClient.share_dashboard_with_team()SdMonitorClient.unshare_dashboard()SdMonitorClient.update_alert()SdMonitorClient.update_dashboard()SdMonitorClient.update_notification_channel()SdMonitorClient.update_notification_resolution()
- Sysdig Secure
SdSecureClientSdSecureClient.add_compliance_task()SdSecureClient.add_falco_list()SdSecureClient.add_falco_macro()SdSecureClient.add_policy()SdSecureClient.add_policy_json()SdSecureClient.add_rule()SdSecureClient.clear_agents_config()SdSecureClient.create_access_key()SdSecureClient.create_default_policies()SdSecureClient.create_email_notification_channel()SdSecureClient.create_notification_channel()SdSecureClient.create_sysdig_capture()SdSecureClient.create_team()SdSecureClient.create_user()SdSecureClient.create_user_invite()SdSecureClient.delete_all_policies()SdSecureClient.delete_compliance_task()SdSecureClient.delete_falco_list()SdSecureClient.delete_falco_macro()SdSecureClient.delete_notification_channel()SdSecureClient.delete_policy_id()SdSecureClient.delete_policy_name()SdSecureClient.delete_rule()SdSecureClient.delete_sysdig_capture()SdSecureClient.delete_team()SdSecureClient.delete_user()SdSecureClient.disable_access_key()SdSecureClient.download_sysdig_capture()SdSecureClient.edit_team()SdSecureClient.edit_user()SdSecureClient.enable_access_key()SdSecureClient.get_agents_config()SdSecureClient.get_command_audit()SdSecureClient.get_compliance_results()SdSecureClient.get_compliance_results_csv()SdSecureClient.get_compliance_task()SdSecureClient.get_connected_agents()SdSecureClient.get_data()SdSecureClient.get_data_retention_info()SdSecureClient.get_default_falco_rules_files()SdSecureClient.get_falco_list_id()SdSecureClient.get_falco_lists_group()SdSecureClient.get_falco_macro_id()SdSecureClient.get_falco_macros_group()SdSecureClient.get_image_profile()SdSecureClient.get_more_policy_events()SdSecureClient.get_n_connected_agents()SdSecureClient.get_notification_channel()SdSecureClient.get_notification_ids()SdSecureClient.get_policy()SdSecureClient.get_policy_event()SdSecureClient.get_policy_events_duration()SdSecureClient.get_policy_events_id_duration()SdSecureClient.get_policy_events_id_range()SdSecureClient.get_policy_events_range()SdSecureClient.get_policy_id()SdSecureClient.get_rule_id()SdSecureClient.get_rules_group()SdSecureClient.get_sysdig_captures()SdSecureClient.get_system_falco_rules()SdSecureClient.get_team()SdSecureClient.get_team_by_id()SdSecureClient.get_team_ids()SdSecureClient.get_teams()SdSecureClient.get_topology_map()SdSecureClient.get_user()SdSecureClient.get_user_api_token()SdSecureClient.get_user_falco_rules()SdSecureClient.get_user_ids()SdSecureClient.get_user_info()SdSecureClient.get_user_token()SdSecureClient.get_users()SdSecureClient.lasterrSdSecureClient.list_access_keys()SdSecureClient.list_commands_audit()SdSecureClient.list_compliance_results()SdSecureClient.list_compliance_tasks()SdSecureClient.list_falco_lists()SdSecureClient.list_falco_macros()SdSecureClient.list_image_profiles()SdSecureClient.list_memberships()SdSecureClient.list_notification_channels()SdSecureClient.list_policies()SdSecureClient.list_rules()SdSecureClient.load_default_falco_rules_files()SdSecureClient.policy_v2SdSecureClient.poll_sysdig_capture()SdSecureClient.remove_memberships()SdSecureClient.save_default_falco_rules_files()SdSecureClient.save_memberships()SdSecureClient.set_agents_config()SdSecureClient.set_default_falco_rules_files()SdSecureClient.set_system_falco_rules()SdSecureClient.set_user_falco_rules()SdSecureClient.update_compliance_task()SdSecureClient.update_falco_list()SdSecureClient.update_falco_macro()SdSecureClient.update_notification_channel()SdSecureClient.update_policy()SdSecureClient.update_policy_json()SdSecureClient.update_rule()
SdScanningClientSdScanningClient.RepositoryAlertTriggerSdScanningClient.RuntimeAlertTriggerSdScanningClient.activate_subscription()SdScanningClient.add_alert()SdScanningClient.add_alert_object()SdScanningClient.add_image()SdScanningClient.add_policy()SdScanningClient.add_registry()SdScanningClient.add_repo()SdScanningClient.add_repository_alert()SdScanningClient.add_runtime_alert()SdScanningClient.add_vulnerability_exception()SdScanningClient.add_vulnerability_exception_bundle()SdScanningClient.check_image_evaluation()SdScanningClient.clear_agents_config()SdScanningClient.create_access_key()SdScanningClient.create_email_notification_channel()SdScanningClient.create_notification_channel()SdScanningClient.create_sysdig_capture()SdScanningClient.create_team()SdScanningClient.create_user()SdScanningClient.create_user_invite()SdScanningClient.deactivate_subscription()SdScanningClient.delete_alert()SdScanningClient.delete_image()SdScanningClient.delete_notification_channel()SdScanningClient.delete_policy()SdScanningClient.delete_registry()SdScanningClient.delete_repo()SdScanningClient.delete_subscription()SdScanningClient.delete_sysdig_capture()SdScanningClient.delete_team()SdScanningClient.delete_user()SdScanningClient.delete_vulnerability_exception()SdScanningClient.delete_vulnerability_exception_bundle()SdScanningClient.disable_access_key()SdScanningClient.download_cve_report_csv()SdScanningClient.download_sysdig_capture()SdScanningClient.edit_team()SdScanningClient.edit_user()SdScanningClient.enable_access_key()SdScanningClient.get_agents_config()SdScanningClient.get_alert()SdScanningClient.get_anchore_users_account()SdScanningClient.get_connected_agents()SdScanningClient.get_data()SdScanningClient.get_data_retention_info()SdScanningClient.get_image()SdScanningClient.get_image_scan_result_by_id()SdScanningClient.get_image_scanning_results()SdScanningClient.get_latest_pdf_report_by_digest()SdScanningClient.get_n_connected_agents()SdScanningClient.get_notification_channel()SdScanningClient.get_notification_ids()SdScanningClient.get_pdf_report()SdScanningClient.get_policy()SdScanningClient.get_registry()SdScanningClient.get_repo()SdScanningClient.get_subscriptions()SdScanningClient.get_sysdig_captures()SdScanningClient.get_team()SdScanningClient.get_team_by_id()SdScanningClient.get_team_ids()SdScanningClient.get_teams()SdScanningClient.get_topology_map()SdScanningClient.get_user()SdScanningClient.get_user_api_token()SdScanningClient.get_user_ids()SdScanningClient.get_user_info()SdScanningClient.get_user_token()SdScanningClient.get_users()SdScanningClient.get_vulnerability_details()SdScanningClient.get_vulnerability_exception_bundle()SdScanningClient.import_image()SdScanningClient.lasterrSdScanningClient.list_access_keys()SdScanningClient.list_alerts()SdScanningClient.list_image_tags()SdScanningClient.list_images()SdScanningClient.list_memberships()SdScanningClient.list_notification_channels()SdScanningClient.list_policies()SdScanningClient.list_policy_bundles()SdScanningClient.list_registry()SdScanningClient.list_repos()SdScanningClient.list_runtime()SdScanningClient.list_subscription()SdScanningClient.list_vulnerability_exception_bundles()SdScanningClient.list_whitelisted_cves()SdScanningClient.poll_sysdig_capture()SdScanningClient.query_image_content()SdScanningClient.query_image_metadata()SdScanningClient.query_image_vuln()SdScanningClient.query_images_by_package()SdScanningClient.query_images_by_vulnerability()SdScanningClient.remove_memberships()SdScanningClient.save_memberships()SdScanningClient.set_agents_config()SdScanningClient.unwatch_repo()SdScanningClient.update_alert()SdScanningClient.update_notification_channel()SdScanningClient.update_policy()SdScanningClient.update_registry()SdScanningClient.update_repository_alert()SdScanningClient.update_runtime_alert()SdScanningClient.update_vulnerability_exception()SdScanningClient.watch_repo()