Skip to content

sysdiglabs/sysdig-sdk-python

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

454 Commits
.github
.github
 
 
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
examples
examples
 
 
sdcclient
sdcclient
 
 
specs
specs
 
 
sysdig_client
sysdig_client
 
 
test
test
 
 
utils
utils
 
 
.editorconfig
.editorconfig
 
 
.flake8
.flake8
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.readthedocs.yml
.readthedocs.yml
 
 
LICENSE.txt
LICENSE.txt
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
poetry.lock
poetry.lock
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

sysdig-sdk

Sysdig Secure Client API.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.1
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://sysdig.com

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sysdig_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sysdig_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sysdig_client
from sysdig_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = sysdig_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = sysdig_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sysdig_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sysdig_client.AccessKeysApi(api_client)
    create_access_key_request_v1 = sysdig_client.CreateAccessKeyRequestV1() # CreateAccessKeyRequestV1 |  (optional)

    try:
        # Create Access Key
        api_response = api_instance.create_access_key_v1(create_access_key_request_v1=create_access_key_request_v1)
        print("The response of AccessKeysApi->create_access_key_v1:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessKeysApi->create_access_key_v1: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccessKeysApi create_access_key_v1 POST /platform/v1/access-keys Create Access Key
AccessKeysApi delete_access_key_by_id_v1 DELETE /platform/v1/access-keys/{accessKeyId} Delete Access Key
AccessKeysApi get_access_key_by_id_v1 GET /platform/v1/access-keys/{accessKeyId} Get Access Key
AccessKeysApi get_access_keys_v1 GET /platform/v1/access-keys List Access Keys
AccessKeysApi update_access_key_by_id_v1 PUT /platform/v1/access-keys/{accessKeyId} Update Access Key
ActivityAuditApi get_activity_audit_entries_supported_filters_v1 GET /secure/activity-audit/v1/supported-filters Get available filters
ActivityAuditApi get_activity_audit_entries_v1 GET /secure/activity-audit/v1/entries List entries
ActivityAuditApi get_activity_audit_entry_v1 GET /secure/activity-audit/v1/entries/{entryId} Get entry
CaptureStorageApi get_capture_storage_configuration_v1 GET /platform/v1/configuration/capture-storage Get Capture Storage Configuration
CaptureStorageApi update_capture_storage_configuration_v1 PUT /platform/v1/configuration/capture-storage Update or Create Capture Storage Configuration
CertificatesApi create_csrv1 POST /secure/certman/v1/csr Create CSR
CertificatesApi delete_certificate_v1 DELETE /secure/certman/v1/certificates/{certId} Delete Certificate
CertificatesApi get_certificate_registration_v1 GET /secure/certman/v1/certificates/{certId}/services List Services
CertificatesApi get_certificate_v1 GET /secure/certman/v1/certificates/{certId} Get Certificate
CertificatesApi get_certificates_v1 GET /secure/certman/v1/certificates List Certificates
CertificatesApi upload_certificate_v1 POST /secure/certman/v1/certificates Upload Certificate
CostAdvisorCustomPricingApi create_pricing_v1 POST /monitor/cost-advisor/v1/pricing Create Pricing
CostAdvisorCustomPricingApi delete_pricing_by_id_v1 DELETE /monitor/cost-advisor/v1/pricing/{pricingId} Delete Pricing
CostAdvisorCustomPricingApi get_pricing_by_id_v1 GET /monitor/cost-advisor/v1/pricing/{pricingId} Get Pricing
CostAdvisorCustomPricingApi get_pricing_projected_costs_v1 GET /monitor/cost-advisor/v1/pricing/{pricingId}/projected-costs Get Pricing Projected Costs
CostAdvisorCustomPricingApi get_pricing_v1 GET /monitor/cost-advisor/v1/pricing List Pricing
CostAdvisorCustomPricingApi update_pricing_by_id_v1 PUT /monitor/cost-advisor/v1/pricing/{pricingId} Update Pricing
CostAdvisorDataApi get_workload_cost_data_v1 POST /monitor/cost-advisor/v1alpha1/data/workload-cost-trends Workload Cost Trends Data
EventsForwarderApi create_efo_inegration_v1 POST /secure/events-forwarder/v1/integrations Create Integration
EventsForwarderApi delete_efo_integration_by_idv1 DELETE /secure/events-forwarder/v1/integrations/{integrationId} Delete Integration
EventsForwarderApi get_efo_integration_by_id_v1 GET /secure/events-forwarder/v1/integrations/{integrationId} Get Integration
EventsForwarderApi list_efo_channels_by_integration_v1 GET /secure/events-forwarder/v1/channels List Channels
EventsForwarderApi list_efo_integrations_types_v1 GET /secure/events-forwarder/v1/types List Integrations types
EventsForwarderApi list_efo_integrations_v1 GET /secure/events-forwarder/v1/integrations List Integrations
EventsForwarderApi update_efo_integration_by_id_v1 PUT /secure/events-forwarder/v1/integrations/{integrationId} Update Integration
GroupMappingsApi create_group_mapping_v1 POST /platform/v1/group-mappings Create Group Mapping
GroupMappingsApi delete_group_mapping_by_id_v1 DELETE /platform/v1/group-mappings/{groupMappingId} Delete Group Mapping
GroupMappingsApi get_group_mapping_by_id_v1 GET /platform/v1/group-mappings/{groupMappingId} Get Group Mapping
GroupMappingsApi get_group_mapping_settings_v1 GET /platform/v1/group-mappings-settings Get Group Mappings Settings
GroupMappingsApi get_group_mappings_v1 GET /platform/v1/group-mappings List Group Mappings
GroupMappingsApi save_group_mapping_settings_v1 PUT /platform/v1/group-mappings-settings Save Group Mapping settings
GroupMappingsApi update_group_mapping_by_id_v1 PUT /platform/v1/group-mappings/{groupMappingId} Update Group Mapping
IPFilteringApi create_ip_filter_v1 POST /platform/v1/ip-filters Create IP Filter
IPFilteringApi delete_ip_filter_by_id_v1 DELETE /platform/v1/ip-filters/{ipFilterId} Delete IP Filter
IPFilteringApi get_ip_filter_by_id_v1 GET /platform/v1/ip-filters/{ipFilterId} Get IP Filter by ID
IPFilteringApi get_ip_filters_settings_v1 GET /platform/v1/ip-filters-settings Get IP Filters Settings
IPFilteringApi get_ip_filters_v1 GET /platform/v1/ip-filters List IP Filters
IPFilteringApi save_ip_filters_settings_v1 PUT /platform/v1/ip-filters-settings Save IP Filters settings
IPFilteringApi update_ip_filter_v1 PUT /platform/v1/ip-filters/{ipFilterId} Update IP Filter
InhibitionRulesApi create_inhibition_rule POST /monitor/alerts/v1/inhibition-rules Create Inhibition Rule
InhibitionRulesApi delete_inhibition_rule_by_id DELETE /monitor/alerts/v1/inhibition-rules/{inhibitionRuleId} Delete Inhibition Rule
InhibitionRulesApi get_inhibition_rule_by_id GET /monitor/alerts/v1/inhibition-rules/{inhibitionRuleId} Get Inhibition Rule
InhibitionRulesApi get_inhibition_rules GET /monitor/alerts/v1/inhibition-rules List Inhibition Rules
InhibitionRulesApi update_inhibition_rule PUT /monitor/alerts/v1/inhibition-rules/{inhibitionRuleId} Update Inhibition Rule
InventoryApi get_resource GET /secure/inventory/v1/resources/{hash} Get Resource
InventoryApi get_resources GET /secure/inventory/v1/resources List Resources
JiraIntegrationsApi create_jira_integration_v1 POST /platform/jira/v1/integrations Create Jira integration
JiraIntegrationsApi create_jira_issue_type_v1 POST /platform/jira/v1/integrations/{integrationId}/issue-types Create Jira issue type
JiraIntegrationsApi delete_jira_integration_v1 DELETE /platform/jira/v1/integrations/{integrationId} Delete Jira integration
JiraIntegrationsApi delete_jira_issue_type_v1 DELETE /platform/jira/v1/integrations/{integrationId}/issue-types/{issueTypeId} Delete Jira issue type
JiraIntegrationsApi get_jira_integration_v1 GET /platform/jira/v1/integrations/{integrationId} Get Jira integration
JiraIntegrationsApi get_jira_integrations_v1 GET /platform/jira/v1/integrations List Jira integrations
JiraIntegrationsApi get_jira_issue_type_v1 GET /platform/jira/v1/integrations/{integrationId}/issue-types/{issueTypeId} Get Jira issue type
JiraIntegrationsApi get_jira_issue_types_v1 GET /platform/jira/v1/integrations/{integrationId}/issue-types List Jira issue types
JiraIntegrationsApi update_jira_integration_v1 PUT /platform/jira/v1/integrations/{integrationId} Update Jira integration
JiraIntegrationsApi update_jira_issue_type_v1 PUT /platform/jira/v1/integrations/{integrationId}/issue-types/{issueTypeId} Update Jira issue type
MetricsCollectionApi get_disabled_metrics_by_job_v1 GET /monitor/prometheus-jobs/v1/disabled-metrics List disabled metrics collection for Jobs.
MetricsCollectionApi post_disabled_metrics_v1 POST /monitor/prometheus-jobs/v1/disabled-metrics Disable or re-enable metrics collection for Jobs
NotificationChannelsApi create_notification_channel POST /platform/v1/notification-channels Create Notification Channel
NotificationChannelsApi delete_notification_channel_by_id DELETE /platform/v1/notification-channels/{notificationChannelId} Delete Notification Channel
NotificationChannelsApi get_notification_channel_by_id GET /platform/v1/notification-channels/{notificationChannelId} Get Notification Channel
NotificationChannelsApi get_notification_channels GET /platform/v1/notification-channels List Notification Channels
NotificationChannelsApi update_notification_channel_by_id PUT /platform/v1/notification-channels/{notificationChannelId} Update Notification Channel
PermissionsApi get_permissions_v1 GET /platform/v1/permissions Get Customer Permissions
PlatformAuditApi get_platform_audit_events_v1 GET /platform/v1/platform-audit-events Get Platform Audit Events
ReportingApi list_jobs_v1 GET /platform/reporting/v1/jobs List Report Job Runs
ReportingApi list_schedules_v1 GET /platform/reporting/v1/schedules List Report Schedules
ResponseActionsApi get_action_execution_file_acquire_v1 GET /secure/response-actions/v1alpha1/action-executions/{actionExecutionId}/acquired-file Get Acquired File
ResponseActionsApi get_action_execution_v1 GET /secure/response-actions/v1alpha1/action-executions/{actionExecutionId} Get Action Execution
ResponseActionsApi get_action_executionsv1 GET /secure/response-actions/v1alpha1/action-executions Returns the list of Response Actions executions. You can filter them with the available query parameters.
ResponseActionsApi get_actions_v1 GET /secure/response-actions/v1alpha1/actions Get All Response Actions
ResponseActionsApi submit_action_executionv1 POST /secure/response-actions/v1alpha1/action-executions Submit the execution of an action
ResponseActionsApi undo_action_execution_v1 DELETE /secure/response-actions/v1alpha1/action-executions/{actionExecutionId} Undoes an Action Execution
RolesApi create_role_v1 POST /platform/v1/roles Create Role
RolesApi delete_role_by_id_v1 DELETE /platform/v1/roles/{roleId} Delete Role
RolesApi get_role_by_id_v1 GET /platform/v1/roles/{roleId} Get Role
RolesApi get_roles_v1 GET /platform/v1/roles List Roles
RolesApi update_role_by_id_v1 PUT /platform/v1/roles/{roleId} Update Role
SBOMApi get_sbomv1beta1 GET /secure/vulnerability/v1beta1/sboms Get SBOM
SSOSettingsApi create_sso_settings_v1 POST /platform/v1/sso-settings Create SSO Settings
SSOSettingsApi delete_sso_settings_by_id_v1 DELETE /platform/v1/sso-settings/{ssoSettingsId} Delete SSO Settings
SSOSettingsApi get_sso_settings_by_id_v1 GET /platform/v1/sso-settings/{ssoSettingsId} Get SSO Settings
SSOSettingsApi get_sso_settings_v1 GET /platform/v1/sso-settings List SSO Settings
SSOSettingsApi update_sso_settings_by_id_v1 PUT /platform/v1/sso-settings/{ssoSettingsId} Update SSO Settings
SecureEventsApi get_event_v1 GET /secure/events/v1/events/{eventId} Get event
SecureEventsApi get_events_supported_filters_v1 GET /secure/events/v1/supported-filters Get available filters
SecureEventsApi get_events_v1 GET /secure/events/v1/events List events
ServiceAccountsApi create_global_service_account_v1 POST /platform/v1/service-accounts Create a Global Service Account
ServiceAccountsApi create_team_service_account_v1 POST /platform/v1/teams/{teamId}/service-accounts Create a Team Service Account
ServiceAccountsApi delete_global_service_account_by_id_v1 DELETE /platform/v1/service-accounts/{serviceAccountId} Delete a Global Service Account
ServiceAccountsApi delete_team_service_account_by_id_v1 DELETE /platform/v1/teams/{teamId}/service-accounts/{serviceAccountId} Delete a Team Service Account
ServiceAccountsApi get_global_service_account_by_id_v1 GET /platform/v1/service-accounts/{serviceAccountId} Get a Global Service Account
ServiceAccountsApi get_global_service_accounts_v1 GET /platform/v1/service-accounts List Global Service Accounts
ServiceAccountsApi get_team_service_account_by_id_v1 GET /platform/v1/teams/{teamId}/service-accounts/{serviceAccountId} Get a Team Service Account
ServiceAccountsApi get_team_service_accounts_v1 GET /platform/v1/teams/{teamId}/service-accounts List Team Service Accounts
ServiceAccountsNotificationSettingsApi create_global_service_accounts_notification_settings_v1 POST /platform/v1/service-accounts/notification-settings Create Global Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi create_service_accounts_notification_settings_v1 POST /platform/v1/teams/{teamId}/service-accounts/notification-settings Create Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi delete_global_service_accounts_notification_settings_v1 DELETE /platform/v1/service-accounts/notification-settings Delete Global Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi delete_service_accounts_notification_settings_v1 DELETE /platform/v1/teams/{teamId}/service-accounts/notification-settings Delete Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi get_global_service_accounts_notification_settings_v1 GET /platform/v1/service-accounts/notification-settings Get Global Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi get_service_accounts_notification_settings_v1 GET /platform/v1/teams/{teamId}/service-accounts/notification-settings Get Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi update_global_service_accounts_notification_settings_v1 PUT /platform/v1/service-accounts/notification-settings Update Global Service Accounts Notification Settings
ServiceAccountsNotificationSettingsApi update_service_accounts_notification_settings_v1 PUT /platform/v1/teams/{teamId}/service-accounts/notification-settings Update Service Accounts Notification Settings
SysQLApi get_sysql_schema GET /api/sysql/v2/schema Get SysQL Schema
SysQLApi query_sysql_get GET /api/sysql/v2/query Execute SysQL query via GET
SysQLApi query_sysql_post POST /api/sysql/v2/query Execute SysQL query via POST
TeamsApi create_team_v1 POST /platform/v1/teams Create Team
TeamsApi delete_team_by_id_v1 DELETE /platform/v1/teams/{teamId} Delete Team
TeamsApi delete_team_user_by_id_v1 DELETE /platform/v1/teams/{teamId}/users/{userId} Delete Membership
TeamsApi get_team_by_id_v1 GET /platform/v1/teams/{teamId} Get Team
TeamsApi get_team_user_by_id_v1 GET /platform/v1/teams/{teamId}/users/{userId} Get Membership
TeamsApi get_team_users_v1 GET /platform/v1/teams/{teamId}/users List Memberships
TeamsApi get_teams_v1 GET /platform/v1/teams List Teams
TeamsApi save_team_user_v1 PUT /platform/v1/teams/{teamId}/users/{userId} Save Membership
TeamsApi update_team_by_id_v1 PUT /platform/v1/teams/{teamId} Update Team
UserDeactivationApi get_user_deactivation_configuration_v1 GET /platform/v1/configuration/user-deactivation Get User Deactivation Configuration
UserDeactivationApi update_user_deactivation_configuration_by_id_v1 PUT /platform/v1/configuration/user-deactivation Update or Create User Deactivation Configuration
UsersApi create_user_v1 POST /platform/v1/users Create User
UsersApi delete_user_by_id_v1 DELETE /platform/v1/users/{userId} Delete User
UsersApi get_user_by_id_v1 GET /platform/v1/users/{userId} Get User
UsersApi get_users_v1 GET /platform/v1/users List Users
UsersApi update_user_v1 PUT /platform/v1/users/{userId} Update User
VulnerabilityManagementApi delete_accepted_risk_v1 DELETE /secure/vulnerability/v1beta1/accepted-risks/{acceptedRiskID} Delete an Accepted Risk
VulnerabilityManagementApi get_accepted_risk_v1 GET /secure/vulnerability/v1beta1/accepted-risks/{acceptedRiskID} Get Accepted Risk
VulnerabilityManagementApi get_accepted_risks_v1 GET /secure/vulnerability/v1beta1/accepted-risks List all Accepted Risks
VulnerabilityManagementApi post_accepted_risk_v1 POST /secure/vulnerability/v1beta1/accepted-risks Create Accepted Risk
VulnerabilityManagementApi scanner_api_service_list_registry_results GET /secure/vulnerability/v1/registry-results Get a list of registry scan results
VulnerabilityManagementApi scanner_api_service_list_runtime_results GET /secure/vulnerability/v1/runtime-results Get a list of runtime scan results
VulnerabilityManagementApi secure_vulnerability_v1_bundles_bundle_id_delete DELETE /secure/vulnerability/v1/bundles/{bundleId} Delete Bundle
VulnerabilityManagementApi secure_vulnerability_v1_bundles_bundle_id_get GET /secure/vulnerability/v1/bundles/{bundleId} Get a Bundle
VulnerabilityManagementApi secure_vulnerability_v1_bundles_bundle_id_put PUT /secure/vulnerability/v1/bundles/{bundleId} Edit Bundle
VulnerabilityManagementApi secure_vulnerability_v1_bundles_get GET /secure/vulnerability/v1/bundles List Bundles
VulnerabilityManagementApi secure_vulnerability_v1_bundles_post POST /secure/vulnerability/v1/bundles Create a new Bundle
VulnerabilityManagementApi secure_vulnerability_v1_pipeline_results_get GET /secure/vulnerability/v1/pipeline-results Get a list of pipeline scan results
VulnerabilityManagementApi secure_vulnerability_v1_policies_get GET /secure/vulnerability/v1/policies List Policies
VulnerabilityManagementApi secure_vulnerability_v1_policies_policy_id_delete DELETE /secure/vulnerability/v1/policies/{policyId} Delete a Policy
VulnerabilityManagementApi secure_vulnerability_v1_policies_policy_id_get GET /secure/vulnerability/v1/policies/{policyId} Get a Policy
VulnerabilityManagementApi secure_vulnerability_v1_policies_policy_id_put PUT /secure/vulnerability/v1/policies/{policyId} Edit a Policy
VulnerabilityManagementApi secure_vulnerability_v1_policies_post POST /secure/vulnerability/v1/policies Create a new Policy
VulnerabilityManagementApi secure_vulnerability_v1_results_result_id_get GET /secure/vulnerability/v1/results/{resultId} Get full scan result
VulnerabilityManagementApi update_accepted_risk_v1 PUT /secure/vulnerability/v1beta1/accepted-risks/{acceptedRiskID} Update an Accepted Risk
ZonesApi create_zone_v1 POST /platform/v1/zones Create Zone
ZonesApi delete_zone_v1 DELETE /platform/v1/zones/{zoneId} Delete Zone
ZonesApi edit_zone_v1 PUT /platform/v1/zones/{zoneId} Update Zone
ZonesApi get_zone_by_id_v1 GET /platform/v1/zones/{zoneId} Get Zone
ZonesApi list_zones_v1 GET /platform/v1/zones List Zones

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication

Author

[email protected]

About

Sysdig Platform Python client library

sysdiglabs.github.io/sysdig-sdk-python

Topics

python sysdig sysdig-monitor sysdig-secure

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

69 stars

Watchers

51 watching

Forks

43 forks
Report repository

Releases 44

v0.19.0 Latest
May 8, 2025
+ 43 releases

Contributors 47
+ 33 contributors

Languages