Skip to content

watchtowr/watchtowr-api-sdk-python

BranchesTags

Repository files navigation

watchtowr-api-sdk-python

The watchTowr Client API combining all watchTowr Platform APIs into a single comprehensive reference, including: * Automated Red Teaming API * Adversary Sight API * Intelligence API * Active Defense API * Platform API

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

  • API version: 1.0
  • Package version: 1.0.0
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://kb.watchtowr.io/

Requirements.

Python 3.9+

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 watchtowr_api_sdk

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 watchtowr_api_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import watchtowr_api_sdk
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.APIDocumentationApi(api_client)
    id = 3.4 # float | The asset ID of the API Documentation asset to create a new note for.
    create_client_note_dto = watchtowr_api_sdk.CreateClientNoteDto() # CreateClientNoteDto | 

    try:
        # Create Note
        api_response = api_instance.add_asset_api_documentation_note(id, create_client_note_dto)
        print("The response of APIDocumentationApi->add_asset_api_documentation_note:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIDocumentationApi->add_asset_api_documentation_note: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://your-tenant-id.sg.client.watchtowr.io

Class Method HTTP request Description
APIDocumentationApi add_asset_api_documentation_note POST /api/client/assets/apiDocumentation/show/{id}/note Create Note
APIDocumentationApi assign_api_documentation_to_business_units POST /api/client/assets/apiDocumentation/show/{id}/business-units Assign API Documentation to Business Units
APIDocumentationApi create_custom_property_api_documentation POST /api/client/assets/apiDocumentation/show/{id}/custom-property Create Custom Property
APIDocumentationApi delete_asset_api_documentation_note DELETE /api/client/assets/apiDocumentation/show/{id}/note/{noteId} Delete Note
APIDocumentationApi delete_custom_property_api_documentation DELETE /api/client/assets/apiDocumentation/show/{id}/custom-property/{customPropertyId} Delete Custom Property
APIDocumentationApi get_asset_api_documentation_changelog GET /api/client/assets/apiDocumentation/show/{id}/changelog Get API Documentation Changelog
APIDocumentationApi get_asset_api_documentation_details GET /api/client/assets/apiDocumentation/show/{id} Get API Documentation Details
APIDocumentationApi get_asset_api_documentation_notes GET /api/client/assets/apiDocumentation/show/{id}/notes List API Documentation Notes
APIDocumentationApi get_custom_properties_api_documentation GET /api/client/assets/apiDocumentation/show/{id}/custom-properties List Custom Properties
APIDocumentationApi get_list_asset_api_documentation GET /api/client/assets/apiDocumentation/list List API Documentation
APIDocumentationApi set_criticality_api_documentation PUT /api/client/assets/apiDocumentation/show/{id}/criticality Set Criticality
APIDocumentationApi unassign_api_documentation_from_business_units DELETE /api/client/assets/apiDocumentation/show/{id}/business-units Unassign API Documentation from Business Units
APIDocumentationApi update_asset_api_documentation_note PUT /api/client/assets/apiDocumentation/show/{id}/note/{noteId} Update Note
APIDocumentationApi update_asset_api_documentation_status PUT /api/client/assets/apiDocumentation/update-status/{id} Update API Documentation Status
APIDocumentationApi update_custom_property_api_documentation PUT /api/client/assets/apiDocumentation/show/{id}/custom-property/{customPropertyId} Update Custom Property
ActiveDefenseLibraryApi get_active_defense_library_rule_details GET /api/client/active-defense-library/show/{ruleId} Get Active Defense Rule Details
ActiveDefenseLibraryApi get_active_defense_library_rule_provider_template GET /api/client/active-defense-library/show/{ruleId}/provider/show/{provider} Get Active Defense Rule Provider Template
ActiveDefenseLibraryApi get_list_active_defense_library_rules GET /api/client/active-defense-library/list List Active Defense Rules
ActivityLogApi get_list_activity_logs GET /api/client/activity-log/list List Activity Logs
AddAssetApi list_submitted_assets GET /api/client/seeddata/list List Submitted Assets
AddAssetApi submit_asset POST /api/client/seeddata Submit Seed Data
AdversaryIntelligenceApi get_adversary_intelligence_details GET /api/client/adversary-intelligence/show/{attackerId} Get Adversary Details
AdversaryIntelligenceApi get_list_adversary_intelligence GET /api/client/adversary-intelligence/list List Adversaries
BusinessUnitApi create_business_unit POST /api/client/business-unit Create Business Unit
BusinessUnitApi create_business_unit_rule POST /api/client/business-unit/show/{id}/rule Create Business Unit Rule
BusinessUnitApi delete_business_unit DELETE /api/client/business-unit/show/{id} Delete Business Unit
BusinessUnitApi delete_business_unit_rule DELETE /api/client/business-unit/show/{id}/rule/{ruleId} Delete Business Unit Rule
BusinessUnitApi get_business_unit_details GET /api/client/business-unit/show/{id} Get Business Unit Details
BusinessUnitApi get_list_business_unit GET /api/client/business-unit/list List Business Units
BusinessUnitApi update_business_unit PUT /api/client/business-unit/show/{id} Update Business Unit
CapabilitySearchApi capability_search GET /api/client/capability-search Capability Search
CertificatesApi get_certificate_details GET /api/client/certificates/show/{id} Get Certificate Details
CertificatesApi get_list_certificates GET /api/client/certificates/list List Certificates
CloudIntegrationAssetsApi add_asset_cloud_asset_note POST /api/client/assets/cloudAsset/show/{id}/note Create Note
CloudIntegrationAssetsApi assign_cloud_asset_to_business_units POST /api/client/assets/cloudAsset/show/{id}/business-units Assign Cloud Integration Asset to Business Units
CloudIntegrationAssetsApi create_custom_property_cloud_asset POST /api/client/assets/cloudAsset/show/{id}/custom-property Create Custom Property
CloudIntegrationAssetsApi delete_asset_cloud_asset_note DELETE /api/client/assets/cloudAsset/show/{id}/note/{noteId} Delete Note
CloudIntegrationAssetsApi delete_custom_property_cloud_asset DELETE /api/client/assets/cloudAsset/show/{id}/custom-property/{customPropertyId} Delete Custom Property
CloudIntegrationAssetsApi get_asset_cloud_asset_changelog GET /api/client/assets/cloudAsset/show/{id}/changelog Get Cloud Asset Changelog
CloudIntegrationAssetsApi get_asset_cloud_asset_details GET /api/client/assets/cloudAsset/show/{id} Get Cloud Asset Details
CloudIntegrationAssetsApi get_asset_cloud_asset_notes GET /api/client/assets/cloudAsset/show/{id}/notes List Notes
CloudIntegrationAssetsApi get_custom_properties_cloud_asset GET /api/client/assets/cloudAsset/show/{id}/custom-properties List Custom Properties
CloudIntegrationAssetsApi get_list_asset_cloud_asset GET /api/client/assets/cloudAsset/list List Cloud Assets
CloudIntegrationAssetsApi set_criticality_cloud_asset PUT /api/client/assets/cloudAsset/show/{id}/criticality Set Criticality
CloudIntegrationAssetsApi unassign_cloud_asset_from_business_units DELETE /api/client/assets/cloudAsset/show/{id}/business-units Unassign Cloud Integration Asset from Business Units
CloudIntegrationAssetsApi update_asset_cloud_asset_note PUT /api/client/assets/cloudAsset/show/{id}/note/{noteId} Update Note
CloudIntegrationAssetsApi update_asset_cloud_asset_status PUT /api/client/assets/cloudAsset/update-status/{id} Update Cloud Asset Status
CloudIntegrationAssetsApi update_custom_property_cloud_asset PUT /api/client/assets/cloudAsset/show/{id}/custom-property/{customPropertyId} Update Custom Property
CloudStorageApi add_asset_cloud_storage_note POST /api/client/assets/cloudStorage/show/{id}/note Create Note
CloudStorageApi assign_cloud_storage_to_business_units POST /api/client/assets/cloudStorage/show/{id}/business-units Assign Cloud Storage to Business Units
CloudStorageApi create_custom_property_cloud_storage POST /api/client/assets/cloudStorage/show/{id}/custom-property Create Custom Property
CloudStorageApi delete_asset_cloud_storage_note DELETE /api/client/assets/cloudStorage/show/{id}/note/{noteId} Delete Note
CloudStorageApi delete_custom_property_cloud_storage DELETE /api/client/assets/cloudStorage/show/{id}/custom-property/{customPropertyId} Delete Custom Property
CloudStorageApi get_asset_cloud_storage_changelog GET /api/client/assets/cloudStorage/show/{id}/changelog Get Cloud Storage Changelog
CloudStorageApi get_asset_cloud_storage_details GET /api/client/assets/cloudStorage/show/{id} Get Cloud Storage
CloudStorageApi get_asset_cloud_storage_notes GET /api/client/assets/cloudStorage/show/{id}/notes List Notes
CloudStorageApi get_custom_properties_cloud_storage GET /api/client/assets/cloudStorage/show/{id}/custom-properties List Custom Properties
CloudStorageApi get_list_asset_cloud_storages GET /api/client/assets/cloudStorage/list List Cloud Storage
CloudStorageApi set_criticality_cloud_storage PUT /api/client/assets/cloudStorage/show/{id}/criticality Set Criticality
CloudStorageApi unassign_cloud_storage_from_business_units DELETE /api/client/assets/cloudStorage/show/{id}/business-units Unassign Cloud Storage from Business Units
CloudStorageApi update_asset_cloud_storage_note PUT /api/client/assets/cloudStorage/show/{id}/note/{noteId} Update Note
CloudStorageApi update_asset_cloud_storage_status PUT /api/client/assets/cloudStorage/update-status/{id} Update Status
CloudStorageApi update_custom_property_cloud_storage PUT /api/client/assets/cloudStorage/show/{id}/custom-property/{customPropertyId} Update Custom Property
ContainersApi assign_container_to_business_units POST /api/client/assets/container/show/{id}/business-units Assign Container to Business Units
ContainersApi create_custom_property_container POST /api/client/assets/container/show/{id}/custom-property Create Custom Property
ContainersApi create_note_container POST /api/client/assets/container/show/{id}/note Create Note
ContainersApi delete_custom_property_container DELETE /api/client/assets/container/show/{id}/custom-property/{customPropertyId} Delete Custom Property
ContainersApi delete_note_container DELETE /api/client/assets/container/show/{id}/note/{noteId} Delete Note
ContainersApi get_asset_container_changelog GET /api/client/assets/container/show/{id}/changelog Get Container Changelog
ContainersApi get_asset_container_details GET /api/client/assets/container/show/{id} Get Container
ContainersApi get_asset_container_notes GET /api/client/assets/container/show/{id}/notes List Notes
ContainersApi get_custom_properties_container GET /api/client/assets/container/show/{id}/custom-properties List Custom Properties
ContainersApi get_list_asset_container GET /api/client/assets/container/list List Containers
ContainersApi set_criticality_container PUT /api/client/assets/container/show/{id}/criticality Set Criticality
ContainersApi unassign_container_from_business_units DELETE /api/client/assets/container/show/{id}/business-units Unassign Container from Business Units
ContainersApi update_asset_container_status PUT /api/client/assets/container/update-status/{id} Update Status
ContainersApi update_custom_property_container PUT /api/client/assets/container/show/{id}/custom-property/{customPropertyId} Update Custom Property
ContainersApi update_note_container PUT /api/client/assets/container/show/{id}/note/{noteId} Update Note
DNSRecordAnalysisApi get_list_dns_records GET /api/client/dns-records/list List DNS Records
DomainsApi assign_domain_to_business_units POST /api/client/assets/domain/show/{id}/business-units Assign Domain to Business Units
DomainsApi create_asset_domain_note POST /api/client/assets/domain/show/{id}/note Create Note
DomainsApi create_custom_property_domain POST /api/client/assets/domain/show/{id}/custom-property Create Custom Property
DomainsApi delete_asset_domain_note DELETE /api/client/assets/domain/show/{id}/note/{noteId} Delete Note
DomainsApi delete_custom_property_domain DELETE /api/client/assets/domain/show/{id}/custom-property/{customPropertyId} Delete Custom Property
DomainsApi get_asset_domain_changelog GET /api/client/assets/domain/show/{id}/changelog Get Domain Changelog
DomainsApi get_asset_domain_details GET /api/client/assets/domain/show/{id} Get Domain Details
DomainsApi get_asset_domain_dns_records GET /api/client/assets/domain/show/{id}/dns-records List DNS Records
DomainsApi get_asset_domain_engine_settings GET /api/client/assets/domain/show/{id}/engine-settings Get Domain Engine Settings
DomainsApi get_asset_domain_notes GET /api/client/assets/domain/show/{id}/notes List Notes
DomainsApi get_custom_properties_domain GET /api/client/assets/domain/show/{id}/custom-properties List Custom Properties
DomainsApi get_list_asset_domains GET /api/client/assets/domain/list List Domains
DomainsApi set_criticality_domain PUT /api/client/assets/domain/show/{id}/criticality Set Criticality
DomainsApi unassign_domain_from_business_units DELETE /api/client/assets/domain/show/{id}/business-units Unassign Domain from Business Units
DomainsApi update_asset_domain_engine_settings PUT /api/client/assets/domain/show/{id}/engine-settings Update Domain Engine Settings
DomainsApi update_asset_domain_note PUT /api/client/assets/domain/show/{id}/note/{noteId} Update Note
DomainsApi update_asset_domain_status PUT /api/client/assets/domain/update-status/{id} Update Status
DomainsApi update_custom_property_domain PUT /api/client/assets/domain/show/{id}/custom-property/{customPropertyId} Update Custom Property
FindingRetestHistoryApi get_list_finding_retest_history GET /api/client/finding-retest-history/list List Finding Retest History
FindingsApi create_custom_property_finding POST /api/client/findings/show/{id}/custom-property Create Custom Property
FindingsApi create_finding_manual_ticket POST /api/client/findings/show/{id}/manual-ticket Create Finding Manual Ticket
FindingsApi create_finding_note POST /api/client/findings/show/{id}/note Create Finding Note
FindingsApi delete_custom_property_finding DELETE /api/client/findings/show/{id}/custom-property/{customPropertyId} Delete Custom Property
FindingsApi delete_finding_note DELETE /api/client/findings/show/{id}/note/{noteId} Delete Finding Note
FindingsApi export_pdf_for_finding GET /api/client/findings/export/{id} Export Finding PDF
FindingsApi get_available_finding_statuses GET /api/client/findings/statuses List Finding Statuses
FindingsApi get_custom_properties_finding GET /api/client/findings/show/{id}/custom-properties List Custom Properties
FindingsApi get_finding_details GET /api/client/findings/show/{id} Get Finding Details
FindingsApi get_finding_notes GET /api/client/findings/show/{id}/notes List Finding Notes
FindingsApi get_list_findings GET /api/client/findings/list List Findings
FindingsApi start_specific_finding_retest POST /api/client/findings/retest/{finding_id} Retest Finding
FindingsApi update_custom_property_finding PUT /api/client/findings/show/{id}/custom-property/{customPropertyId} Update Custom Property
FindingsApi update_finding_note PUT /api/client/findings/show/{id}/note/{noteId} Update Finding Note
FindingsApi update_finding_state POST /api/client/findings/state/{id} Update Finding State
FindingsApi update_finding_status POST /api/client/findings/status/{id} Update Finding Status
HuntsApi get_client_hunts GET /api/client/hunts/list List Hunts
HuntsApi get_list_asset_by_hunt GET /api/client/hunts/show/{id}/assets List Hunt Assets
HuntsApi get_list_finding_by_hunt GET /api/client/hunts/show/{id}/findings List Hunt Findings
HuntsApi show_the_detail_hunt GET /api/client/hunts/show/{id} Get Hunt Details
IPAddressesApi assign_ip_to_business_units POST /api/client/assets/ip/show/{id}/business-units Assign IP to Business Units
IPAddressesApi create_asset_ip_note POST /api/client/assets/ip/show/{id}/note Create Note
IPAddressesApi create_custom_property_ip POST /api/client/assets/ip/show/{id}/custom-property Create Custom Property
IPAddressesApi delete_asset_ip_note DELETE /api/client/assets/ip/show/{id}/note/{noteId} Delete Note
IPAddressesApi delete_custom_property_ip DELETE /api/client/assets/ip/show/{id}/custom-property/{customPropertyId} Delete Custom Property
IPAddressesApi get_asset_ip_changelog GET /api/client/assets/ip/show/{id}/changelog Get IP Address Changelog
IPAddressesApi get_asset_ip_details GET /api/client/assets/ip/show/{id} Get IP Address Details
IPAddressesApi get_asset_ip_dns_records GET /api/client/assets/ip/show/{id}/dns-records List DNS Records
IPAddressesApi get_asset_ip_engine_settings GET /api/client/assets/ip/show/{id}/engine-settings Get IP Engine Settings
IPAddressesApi get_asset_ip_notes GET /api/client/assets/ip/show/{id}/notes List Notes
IPAddressesApi get_asset_ip_port_details GET /api/client/assets/ip/show/{ipId}/port/show/{portId} Get Port
IPAddressesApi get_asset_ip_ports GET /api/client/assets/ip/show/{id}/port/list List Ports
IPAddressesApi get_custom_properties_ip GET /api/client/assets/ip/show/{id}/custom-properties List Custom Properties
IPAddressesApi get_list_asset_ips GET /api/client/assets/ip/list List IP Addresses
IPAddressesApi set_criticality_ip PUT /api/client/assets/ip/show/{id}/criticality Set Criticality
IPAddressesApi unassign_ip_from_business_units DELETE /api/client/assets/ip/show/{id}/business-units Unassign IP from Business Units
IPAddressesApi update_asset_ip_engine_settings PUT /api/client/assets/ip/show/{id}/engine-settings Update IP Engine Settings
IPAddressesApi update_asset_ip_note PUT /api/client/assets/ip/show/{id}/note/{noteId} Update Note
IPAddressesApi update_asset_ip_status PUT /api/client/assets/ip/update-status/{id} Update Status
IPAddressesApi update_custom_property_ip PUT /api/client/assets/ip/show/{id}/custom-property/{customPropertyId} Update Custom Property
IPRangesApi assign_ip_range_to_business_units POST /api/client/assets/ipRange/show/{id}/business-units Assign IP Range to Business Units
IPRangesApi create_custom_property_ip_range POST /api/client/assets/ipRange/show/{id}/custom-property Create Custom Property
IPRangesApi create_note_ip_range POST /api/client/assets/ipRange/show/{id}/note Create Note
IPRangesApi delete_custom_property_ip_range_ DELETE /api/client/assets/ipRange/show/{id}/custom-property/{customPropertyId} Delete Custom Property
IPRangesApi delete_note_ip_range DELETE /api/client/assets/ipRange/show/{id}/note/{noteId} Delete Note
IPRangesApi get_asset_ip_range_notes GET /api/client/assets/ipRange/show/{id}/notes List Notes
IPRangesApi get_asset_iprange_changelog GET /api/client/assets/ipRange/show/{id}/changelog Get IP Range Changelog
IPRangesApi get_asset_iprange_details GET /api/client/assets/ipRange/show/{id} Get IP Range
IPRangesApi get_custom_properties_ip_range GET /api/client/assets/ipRange/show/{id}/custom-properties List Custom Properties
IPRangesApi get_list_asset_ipranges GET /api/client/assets/ipRange/list List IP Ranges
IPRangesApi set_criticality_ip_range PUT /api/client/assets/ipRange/show/{id}/criticality Set Criticality
IPRangesApi unassign_ip_range_from_business_units DELETE /api/client/assets/ipRange/show/{id}/business-units Unassign IP Range from Business Units
IPRangesApi update_asset_ip_range_status PUT /api/client/assets/ipRange/update-status/{id} Update Status
IPRangesApi update_custom_property_ip_range PUT /api/client/assets/ipRange/show/{id}/custom-property/{customPropertyId} Update Custom Property
IPRangesApi update_note_ip_range PUT /api/client/assets/ipRange/show/{id}/note/{noteId} Update Note
KillSwitchApi get_kill_switch_status GET /api/client/kill-switch Get Kill Switch Status
KillSwitchApi update_kill_switch PUT /api/client/kill-switch Update Kill Switch
MobileApplicationsApi assign_mobile_app_to_business_units POST /api/client/assets/mobileApp/show/{id}/business-units Assign Mobile App to Business Units
MobileApplicationsApi create_custom_property_mobile_app POST /api/client/assets/mobileApp/show/{id}/custom-property Create Custom Property
MobileApplicationsApi create_note_mobile_app POST /api/client/assets/mobileApp/show/{id}/note Create Note
MobileApplicationsApi delete_custom_property_mobile_app DELETE /api/client/assets/mobileApp/show/{id}/custom-property/{customPropertyId} Delete Custom Property
MobileApplicationsApi delete_note_mobile_app DELETE /api/client/assets/mobileApp/show/{id}/note/{noteId} Delete Note
MobileApplicationsApi get_asset_mobile_app_changelog GET /api/client/assets/mobileApp/show/{id}/changelog Get Mobile Application Changelog
MobileApplicationsApi get_asset_mobile_app_details GET /api/client/assets/mobileApp/show/{id} Get Mobile Application
MobileApplicationsApi get_asset_mobile_app_notes GET /api/client/assets/mobileApp/show/{id}/notes List Notes
MobileApplicationsApi get_custom_properties_mobile_app GET /api/client/assets/mobileApp/show/{id}/custom-properties List Custom Properties
MobileApplicationsApi get_list_asset_mobile_apps GET /api/client/assets/mobileApp/list List Mobile Applications
MobileApplicationsApi set_criticality_mobile_app PUT /api/client/assets/mobileApp/show/{id}/criticality Set Criticality
MobileApplicationsApi unassign_mobile_app_from_business_units DELETE /api/client/assets/mobileApp/show/{id}/business-units Unassign Mobile App from Business Units
MobileApplicationsApi update_asset_mobile_app_status PUT /api/client/assets/mobileApp/update-status/{id} Update Status
MobileApplicationsApi update_custom_property_mobile_app PUT /api/client/assets/mobileApp/show/{id}/custom-property/{customPropertyId} Update Custom Property
MobileApplicationsApi update_note_mobile_app PUT /api/client/assets/mobileApp/show/{id}/note/{noteId} Update Note
PackageManagersApi add_asset_package_manager_note POST /api/client/assets/packageManager/show/{id}/note Create Note
PackageManagersApi assign_package_manager_to_business_units POST /api/client/assets/packageManager/show/{id}/business-units Assign Package Manager to Business Units
PackageManagersApi create_custom_property_package_manager POST /api/client/assets/packageManager/show/{id}/custom-property Create Custom Property
PackageManagersApi delete_asset_package_manager_note DELETE /api/client/assets/packageManager/show/{id}/note/{noteId} Delete Note
PackageManagersApi delete_custom_property_by_id DELETE /api/client/assets/packageManager/show/{id}/custom-property/{customPropertyId} Delete Custom Property
PackageManagersApi get_asset_package_manager_changelog GET /api/client/assets/packageManager/show/{id}/changelog Get Package Manager Changelog
PackageManagersApi get_asset_package_manager_details GET /api/client/assets/packageManager/show/{id} Get Package Manager
PackageManagersApi get_asset_package_manager_notes GET /api/client/assets/packageManager/show/{id}/notes List Notes
PackageManagersApi get_custom_properties_package_manager GET /api/client/assets/packageManager/show/{id}/custom-properties List Custom Properties
PackageManagersApi get_list_asset_package_managers GET /api/client/assets/packageManager/list List Package Managers
PackageManagersApi set_criticality_package_manager PUT /api/client/assets/packageManager/show/{id}/criticality Set Criticality
PackageManagersApi unassign_package_manager_from_business_units DELETE /api/client/assets/packageManager/show/{id}/business-units Unassign Package Manager from Business Units
PackageManagersApi update_asset_package_manager_note PUT /api/client/assets/packageManager/show/{id}/note/{noteId} Update Note
PackageManagersApi update_asset_package_manager_status PUT /api/client/assets/packageManager/update-status/{id} Update Status
PackageManagersApi update_custom_property_package_manager PUT /api/client/assets/packageManager/show/{id}/custom-property/{customPropertyId} Update Custom Property
PendingDomainsApi get_list_pending_domains GET /api/client/pending-domains/list List Pending Domains
PlatformWhitelistingApi create_platform_api_whitelist_ip POST /api/client/platform/whitelisting/api Add API Whitelisted IP
PlatformWhitelistingApi create_platform_dashboard_whitelist_ip POST /api/client/platform/whitelisting/dashboard Add Dashboard Whitelisted IP
PlatformWhitelistingApi delete_platform_api_whitelist_ip DELETE /api/client/platform/whitelisting/api/{id} Remove API Whitelisted IP
PlatformWhitelistingApi delete_platform_dashboard_whitelist_ip DELETE /api/client/platform/whitelisting/dashboard/{id} Remove Dashboard Whitelisted IP
PlatformWhitelistingApi get_platform_api_whitelist_ips GET /api/client/platform/whitelisting/api List API Whitelisted IPs
PlatformWhitelistingApi get_platform_api_whitelist_status GET /api/client/platform/whitelisting/api/status Get API Whitelisting Status
PlatformWhitelistingApi get_platform_dashboard_whitelist_ips GET /api/client/platform/whitelisting/dashboard List Dashboard Whitelisted IPs
PlatformWhitelistingApi get_platform_dashboard_whitelist_status GET /api/client/platform/whitelisting/dashboard/status Get Dashboard Whitelisting Status
PlatformWhitelistingApi update_platform_api_whitelist_ip PUT /api/client/platform/whitelisting/api/{id} Update API Whitelisted IP
PlatformWhitelistingApi update_platform_api_whitelist_status PUT /api/client/platform/whitelisting/api/status Update API Whitelisting Status
PlatformWhitelistingApi update_platform_dashboard_whitelist_ip PUT /api/client/platform/whitelisting/dashboard/{id} Update Dashboard Whitelisted IP
PlatformWhitelistingApi update_platform_dashboard_whitelist_status PUT /api/client/platform/whitelisting/dashboard/status Update Dashboard Whitelisting Status
PointsOfInterestApi convert_poi_to_finding POST /api/client/points-of-interest/{id}/convert-to-finding Convert Point of Interest to Finding
PointsOfInterestApi get_list_points_of_interest GET /api/client/points-of-interest/list List Points of Interest
PortsApi get_asset_port_details GET /api/client/assets/ip/port/show/{id} Get Port
PortsApi get_list_asset_ports GET /api/client/assets/ip/port/list List Ports
RepositoriesApi assign_repository_to_business_units POST /api/client/assets/repository/show/{id}/business-units Assign Repository to Business Units
RepositoriesApi create_custom_property_repository POST /api/client/assets/repository/show/{id}/custom-property Create Custom Property
RepositoriesApi create_note_repository POST /api/client/assets/repository/show/{id}/note Create Note
RepositoriesApi delete_custom_property_repository DELETE /api/client/assets/repository/show/{id}/custom-property/{customPropertyId} Delete Custom Property
RepositoriesApi delete_note_repository DELETE /api/client/assets/repository/show/{id}/note/{noteId} Delete Note
RepositoriesApi get_asset_repository_changelog GET /api/client/assets/repository/show/{id}/changelog Get Repository Changelog
RepositoriesApi get_asset_repository_details GET /api/client/assets/repository/show/{id} Get Repository
RepositoriesApi get_asset_repository_notes GET /api/client/assets/repository/show/{id}/notes List Notes
RepositoriesApi get_custom_properties_repository GET /api/client/assets/repository/show/{id}/custom-properties List Custom Properties
RepositoriesApi get_list_asset_repositories GET /api/client/assets/repository/list List Repositories
RepositoriesApi set_criticality_repository PUT /api/client/assets/repository/show/{id}/criticality Set Criticality
RepositoriesApi unassign_repository_from_business_units DELETE /api/client/assets/repository/show/{id}/business-units Unassign Repository from Business Units
RepositoriesApi update_asset_repository_status PUT /api/client/assets/repository/update-status/{id} Update Status
RepositoriesApi update_custom_property_repository PUT /api/client/assets/repository/show/{id}/custom-property/{customPropertyId} Update Custom Property
RepositoriesApi update_note_repository PUT /api/client/assets/repository/show/{id}/note/{noteId} Update Note
SaaSPlatformsApi assign_saas_platform_to_business_units POST /api/client/assets/saasPlatform/show/{id}/business-units Assign SaaS Platform to Business Units
SaaSPlatformsApi create_custom_property_saas_platform POST /api/client/assets/saasPlatform/show/{id}/custom-property Create Custom Property
SaaSPlatformsApi create_note_saas_platform POST /api/client/assets/saasPlatform/show/{id}/note Create Note
SaaSPlatformsApi delete_custom_property_saas_platform DELETE /api/client/assets/saasPlatform/show/{id}/custom-property/{customPropertyId} Delete Custom Property
SaaSPlatformsApi delete_note_saas_platform DELETE /api/client/assets/saasPlatform/show/{id}/note/{noteId} Delete Note
SaaSPlatformsApi get_asset_saas_platform_changelog GET /api/client/assets/saasPlatform/show/{id}/changelog Get SaaS Platform Changelog
SaaSPlatformsApi get_asset_saas_platform_details GET /api/client/assets/saasPlatform/show/{id} Get SaaS Platform
SaaSPlatformsApi get_asset_saas_platform_notes GET /api/client/assets/saasPlatform/show/{id}/notes List Notes
SaaSPlatformsApi get_custom_properties_saas_platform GET /api/client/assets/saasPlatform/show/{id}/custom-properties List Custom Properties
SaaSPlatformsApi get_list_asset_saas_platforms GET /api/client/assets/saasPlatform/list List SaaS Platforms
SaaSPlatformsApi set_criticality_saas_platform PUT /api/client/assets/saasPlatform/show/{id}/criticality Set Criticality
SaaSPlatformsApi unassign_saas_platform_from_business_units DELETE /api/client/assets/saasPlatform/show/{id}/business-units Unassign SaaS Platform from Business Units
SaaSPlatformsApi update_asset_saas_platform_status PUT /api/client/assets/saasPlatform/update-status/{id} Update Status
SaaSPlatformsApi update_custom_property_saas_platform PUT /api/client/assets/saasPlatform/show/{id}/custom-property/{customPropertyId} Update Custom Property
SaaSPlatformsApi update_note_saas_platform PUT /api/client/assets/saasPlatform/show/{id}/note/{noteId} Update Note
SecurityPostureDashboardApi get_security_posture_dashboard GET /api/client/dashboard/security-posture Get Security Posture Dashboard
ServiceDiscoveryApi get_list_service_listing GET /api/client/service-listing/list List Services
ServiceDiscoveryApi get_technology_statistics GET /api/client/service-listing/technology-statistics List Technology Statistics
SourceIPAddressesApi get_list_source_ip_addresses GET /api/client/testing-infrastructure List Testing Infrastructure
SubdomainsApi assign_subomain_to_business_units POST /api/client/assets/subdomain/show/{id}/business-units Assign Subdomain to Business Units
SubdomainsApi create_custom_property_subdomain POST /api/client/assets/subdomain/show/{id}/custom-property Create Subdomain Custom Property
SubdomainsApi create_note_subdomain POST /api/client/assets/subdomain/show/{id}/note Create Subdomain Note
SubdomainsApi delete_custom_property_subdomain DELETE /api/client/assets/subdomain/show/{id}/custom-property/{customPropertyId} Delete Subdomain Custom Property
SubdomainsApi delete_note_subdomain DELETE /api/client/assets/subdomain/show/{id}/note/{noteId} Delete Subdomain Note
SubdomainsApi get_asset_subdomain_changelog GET /api/client/assets/subdomain/show/{id}/changelog Get Subdomain Changelog
SubdomainsApi get_asset_subdomain_details GET /api/client/assets/subdomain/show/{id} Get Subdomain Details
SubdomainsApi get_asset_subdomain_dns_records GET /api/client/assets/subdomain/show/{id}/dns-records List Subdomain DNS Records
SubdomainsApi get_asset_subdomain_engine_settings GET /api/client/assets/subdomain/show/{id}/engine-settings Get Subdomain Engine Settings
SubdomainsApi get_custom_properties_subdomain GET /api/client/assets/subdomain/show/{id}/custom-properties List Subdomain Custom Properties
SubdomainsApi get_list_asset_subdomains GET /api/client/assets/subdomain/list List Subdomains
SubdomainsApi get_notes_subdomain GET /api/client/assets/subdomain/show/{id}/notes List Subdomain Notes
SubdomainsApi set_criticality_subdomain PUT /api/client/assets/subdomain/show/{id}/criticality Set Criticality
SubdomainsApi unassign_subomain_from_business_units DELETE /api/client/assets/subdomain/show/{id}/business-units Unassign Subdomain from Business Units
SubdomainsApi update_asset_subdomain_engine_settings PUT /api/client/assets/subdomain/show/{id}/engine-settings Update Subdomain Engine Settings
SubdomainsApi update_asset_subdomain_status PUT /api/client/assets/subdomain/update-status/{id} Update Subdomain Status
SubdomainsApi update_custom_property_subdomain PUT /api/client/assets/subdomain/show/{id}/custom-property/{customPropertyId} Update Subdomain Custom Property
SubdomainsApi update_note_subdomain PUT /api/client/assets/subdomain/show/{id}/note/{noteId} Update Subdomain Note
SuspiciousDomainsApi get_list_suspicious_domain GET /api/client/suspicious-domain/list List Suspicious Domains
SuspiciousDomainsApi get_suspicious_domain_details GET /api/client/suspicious-domain/show/{id} Get Suspicious Domain Details
UserManagementApi delete_user DELETE /api/client/users/{id} Delete User
UserManagementApi get_user_details GET /api/client/users/show/{id} Get User Details
UserManagementApi invite_users POST /api/client/users/invite Invite Users
UserManagementApi list_users GET /api/client/users/list List Users
UserManagementApi update_user PUT /api/client/users/{id} Update User
VulnerabilityIntelligenceApi get_list_vulnerability_intelligence GET /api/client/vulnerability-intelligence/list List Vulnerabilities
VulnerabilityIntelligenceApi get_vulnerability_intelligence_details GET /api/client/vulnerability-intelligence/show/{identifier} Get Vulnerability Details

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (API_TOKEN)

Author

support@watchTowr.io

About

watchTowr Platform Client API SDK (Python)

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages