WatchtowrAPI - the PowerShell module for the Complete watchTowr Platform API Documentation

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

This PowerShell module is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.0
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PowerShellClientCodegen For more information, please visit https://kb.watchtowr.io/

Frameworks supported

• PowerShell 6.2 or later

Dependencies

Installation

To install from PowerShell Gallery (https://www.powershellgallery.com/packages/WatchtowrAPI)

Import-Module -Name WatchtowrAPI -Verbose

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\WatchtowrAPI' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\WatchtowrAPI' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "WatchtowrAPI"; ModuleVersion = "1.0.0"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
APIDocumentationApi	Add-AssetApiDocumentationNote	POST /api/client/assets/apiDocumentation/show/{id}/note	Create Note
APIDocumentationApi	Set-ApiDocumentationToBusinessUnits	POST /api/client/assets/apiDocumentation/show/{id}/business-units	Assign API Documentation to Business Units
APIDocumentationApi	New-CustomPropertyApiDocumentation	POST /api/client/assets/apiDocumentation/show/{id}/custom-property	Create Custom Property
APIDocumentationApi	Invoke-DeleteAssetApiDocumentationNote	DELETE /api/client/assets/apiDocumentation/show/{id}/note/{noteId}	Delete Note
APIDocumentationApi	Invoke-DeleteCustomPropertyApiDocumentation	DELETE /api/client/assets/apiDocumentation/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
APIDocumentationApi	Get-AssetApiDocumentationDetails	GET /api/client/assets/apiDocumentation/show/{id}	Get API Documentation Details
APIDocumentationApi	Get-AssetApiDocumentationNotes	GET /api/client/assets/apiDocumentation/show/{id}/notes	List API Documentation Notes
APIDocumentationApi	Get-CustomPropertiesApiDocumentation	GET /api/client/assets/apiDocumentation/show/{id}/custom-properties	List Custom Properties
APIDocumentationApi	Get-ListAssetApiDocumentation	GET /api/client/assets/apiDocumentation/list	List API Documentation
APIDocumentationApi	Invoke-UnassignApiDocumentationFromBusinessUnits	DELETE /api/client/assets/apiDocumentation/show/{id}/business-units	Unassign API Documentation from Business Units
APIDocumentationApi	Update-AssetApiDocumentationNote	PUT /api/client/assets/apiDocumentation/show/{id}/note/{noteId}	Update Note
APIDocumentationApi	Update-AssetApiDocumentationStatus	PUT /api/client/assets/apiDocumentation/update-status/{id}	Update API Documentation Status
APIDocumentationApi	Update-CustomPropertyApiDocumentation	PUT /api/client/assets/apiDocumentation/show/{id}/custom-property/{customPropertyId}	Update Custom Property
ActivityLogApi	Get-ListActivityLogs	GET /api/client/activity-log/list	List Activity Logs
AddAssetApi	Submit-Asset	POST /api/client/seeddata	Submit Seed Data
BusinessUnitApi	Get-BusinessUnitDetails	GET /api/client/business-unit/show/{id}	Get Business Unit Details
BusinessUnitApi	Get-ListBusinessUnit	GET /api/client/business-unit/list	List Business Units
CertificatesApi	Get-CertificateDetails	GET /api/client/certificates/show/{id}	Get Certificate Details
CertificatesApi	Get-ListCertificates	GET /api/client/certificates/list	List Certificates
CloudIntegrationAssetsApi	Add-AssetCloudAssetNote	POST /api/client/assets/cloudAsset/show/{id}/note	Create Note
CloudIntegrationAssetsApi	Set-CloudAssetToBusinessUnits	POST /api/client/assets/cloudAsset/show/{id}/business-units	Assign Cloud Integration Asset to Business Units
CloudIntegrationAssetsApi	New-CustomPropertyCloudAsset	POST /api/client/assets/cloudAsset/show/{id}/custom-property	Create Custom Property
CloudIntegrationAssetsApi	Invoke-DeleteAssetCloudAssetNote	DELETE /api/client/assets/cloudAsset/show/{id}/note/{noteId}	Delete Note
CloudIntegrationAssetsApi	Invoke-DeleteCustomPropertyCloudAsset	DELETE /api/client/assets/cloudAsset/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
CloudIntegrationAssetsApi	Get-AssetCloudAssetDetails	GET /api/client/assets/cloudAsset/show/{id}	Get Cloud Asset Details
CloudIntegrationAssetsApi	Get-AssetCloudAssetNotes	GET /api/client/assets/cloudAsset/show/{id}/notes	List Notes
CloudIntegrationAssetsApi	Get-CustomPropertiesCloudAsset	GET /api/client/assets/cloudAsset/show/{id}/custom-properties	List Custom Properties
CloudIntegrationAssetsApi	Get-ListAssetCloudAsset	GET /api/client/assets/cloudAsset/list	List Cloud Assets
CloudIntegrationAssetsApi	Invoke-UnassignCloudAssetFromBusinessUnits	DELETE /api/client/assets/cloudAsset/show/{id}/business-units	Unassign Cloud Integration Asset from Business Units
CloudIntegrationAssetsApi	Update-AssetCloudAssetNote	PUT /api/client/assets/cloudAsset/show/{id}/note/{noteId}	Update Note
CloudIntegrationAssetsApi	Update-AssetCloudAssetStatus	PUT /api/client/assets/cloudAsset/update-status/{id}	Update Cloud Asset Status
CloudIntegrationAssetsApi	Update-CustomPropertyCloudAsset	PUT /api/client/assets/cloudAsset/show/{id}/custom-property/{customPropertyId}	Update Custom Property
CloudStorageApi	Add-AssetCloudStorageNote	POST /api/client/assets/cloudStorage/show/{id}/note	Create Note
CloudStorageApi	Set-CloudStorageToBusinessUnits	POST /api/client/assets/cloudStorage/show/{id}/business-units	Assign Cloud Storage to Business Units
CloudStorageApi	New-CustomPropertyCloudStorage	POST /api/client/assets/cloudStorage/show/{id}/custom-property	Create Custom Property
CloudStorageApi	Invoke-DeleteAssetCloudStorageNote	DELETE /api/client/assets/cloudStorage/show/{id}/note/{noteId}	Delete Note
CloudStorageApi	Invoke-DeleteCustomPropertyCloudStorage	DELETE /api/client/assets/cloudStorage/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
CloudStorageApi	Get-AssetCloudStorageDetails	GET /api/client/assets/cloudStorage/show/{id}	Get Cloud Storage
CloudStorageApi	Get-AssetCloudStorageNotes	GET /api/client/assets/cloudStorage/show/{id}/notes	List Notes
CloudStorageApi	Get-CustomPropertiesCloudStorage	GET /api/client/assets/cloudStorage/show/{id}/custom-properties	List Custom Properties
CloudStorageApi	Get-ListAssetCloudStorages	GET /api/client/assets/cloudStorage/list	List Cloud Storage
CloudStorageApi	Invoke-UnassignCloudStorageFromBusinessUnits	DELETE /api/client/assets/cloudStorage/show/{id}/business-units	Unassign Cloud Storage from Business Units
CloudStorageApi	Update-AssetCloudStorageNote	PUT /api/client/assets/cloudStorage/show/{id}/note/{noteId}	Update Note
CloudStorageApi	Update-AssetCloudStorageStatus	PUT /api/client/assets/cloudStorage/update-status/{id}	Update Status
CloudStorageApi	Update-CustomPropertyCloudStorage	PUT /api/client/assets/cloudStorage/show/{id}/custom-property/{customPropertyId}	Update Custom Property
ContainersApi	Set-ContainerToBusinessUnits	POST /api/client/assets/container/show/{id}/business-units	Assign Container to Business Units
ContainersApi	New-CustomPropertyContainer	POST /api/client/assets/container/show/{id}/custom-property	Create Custom Property
ContainersApi	New-NoteContainer	POST /api/client/assets/container/show/{id}/note	Create Note
ContainersApi	Invoke-DeleteCustomPropertyContainer	DELETE /api/client/assets/container/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
ContainersApi	Invoke-DeleteNoteContainer	DELETE /api/client/assets/container/show/{id}/note/{noteId}	Delete Note
ContainersApi	Get-AssetContainerDetails	GET /api/client/assets/container/show/{id}	Get Container
ContainersApi	Get-AssetContainerNotes	GET /api/client/assets/container/show/{id}/notes	List Notes
ContainersApi	Get-CustomPropertiesContainer	GET /api/client/assets/container/show/{id}/custom-properties	List Custom Properties
ContainersApi	Get-ListAssetContainer	GET /api/client/assets/container/list	List Containers
ContainersApi	Invoke-UnassignContainerFromBusinessUnits	DELETE /api/client/assets/container/show/{id}/business-units	Unassign Container from Business Units
ContainersApi	Update-AssetContainerStatus	PUT /api/client/assets/container/update-status/{id}	Update Status
ContainersApi	Update-CustomPropertyContainer	PUT /api/client/assets/container/show/{id}/custom-property/{customPropertyId}	Update Custom Property
ContainersApi	Update-NoteContainer	PUT /api/client/assets/container/show/{id}/note/{noteId}	Update Note
DNSRecordAnalysisApi	Get-ListDnsRecords	GET /api/client/dns-records/list	List DNS Records
DomainsApi	Set-DomainToBusinessUnits	POST /api/client/assets/domain/show/{id}/business-units	Assign Domain to Business Units
DomainsApi	New-AssetDomainNote	POST /api/client/assets/domain/show/{id}/note	Create Note
DomainsApi	New-CustomPropertyDomain	POST /api/client/assets/domain/show/{id}/custom-property	Create Custom Property
DomainsApi	Invoke-DeleteAssetDomainNote	DELETE /api/client/assets/domain/show/{id}/note/{noteId}	Delete Note
DomainsApi	Invoke-DeleteCustomPropertyDomain	DELETE /api/client/assets/domain/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
DomainsApi	Get-AssetDomainDetails	GET /api/client/assets/domain/show/{id}	Get Domain Details
DomainsApi	Get-AssetDomainDnsRecords	GET /api/client/assets/domain/show/{id}/dns-records	List DNS Records
DomainsApi	Get-AssetDomainEngineSettings	GET /api/client/assets/domain/show/{id}/engine-settings	Get Domain Engine Settings
DomainsApi	Get-AssetDomainNotes	GET /api/client/assets/domain/show/{id}/notes	List Notes
DomainsApi	Get-CustomPropertiesDomain	GET /api/client/assets/domain/show/{id}/custom-properties	List Custom Properties
DomainsApi	Get-ListAssetDomains	GET /api/client/assets/domain/list	List Domains
DomainsApi	Invoke-UnassignDomainFromBusinessUnits	DELETE /api/client/assets/domain/show/{id}/business-units	Unassign Domain from Business Units
DomainsApi	Update-AssetDomainEngineSettings	PUT /api/client/assets/domain/show/{id}/engine-settings	Update Domain Engine Settings
DomainsApi	Update-AssetDomainNote	PUT /api/client/assets/domain/show/{id}/note/{noteId}	Update Note
DomainsApi	Update-AssetDomainStatus	PUT /api/client/assets/domain/update-status/{id}	Update Status
DomainsApi	Update-CustomPropertyDomain	PUT /api/client/assets/domain/show/{id}/custom-property/{customPropertyId}	Update Custom Property
FindingRetestHistoryApi	Get-ListFindingRetestHistory	GET /api/client/finding-retest-history/list	List Finding Retest History
FindingsApi	New-CustomPropertyFinding	POST /api/client/findings/show/{id}/custom-property	Create Custom Property
FindingsApi	New-FindingNote	POST /api/client/findings/show/{id}/note	Create Finding Note
FindingsApi	Invoke-DeleteCustomPropertyFinding	DELETE /api/client/findings/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
FindingsApi	Invoke-DeleteFindingNote	DELETE /api/client/findings/show/{id}/note/{noteId}	Delete Finding Note
FindingsApi	Export-PDFForFinding	GET /api/client/findings/export/{id}	Export Finding PDF
FindingsApi	Get-AvailableFindingStatuses	GET /api/client/findings/statuses	List Finding Statuses
FindingsApi	Get-CustomPropertiesFinding	GET /api/client/findings/show/{id}/custom-properties	List Custom Properties
FindingsApi	Get-FindingDetails	GET /api/client/findings/show/{id}	Get Finding Details
FindingsApi	Get-FindingNotes	GET /api/client/findings/show/{id}/notes	List Finding Notes
FindingsApi	Get-ListFindings	GET /api/client/findings/list	List Findings
FindingsApi	Start-SpecificFindingRetest	POST /api/client/findings/retest/{finding_id}	Retest Finding
FindingsApi	Update-CustomPropertyFinding	PUT /api/client/findings/show/{id}/custom-property/{customPropertyId}	Update Custom Property
FindingsApi	Update-FindingNote	PUT /api/client/findings/show/{id}/note/{noteId}	Update Finding Note
FindingsApi	Update-FindingStatus	POST /api/client/findings/status/{id}	Update Finding Status
HuntsApi	Get-ClientHunts	GET /api/client/hunts/list	List Hunts
HuntsApi	Get-ListAssetByHunt	GET /api/client/hunts/show/{id}/assets	List Assets
HuntsApi	Get-ListFindingByHunt	GET /api/client/hunts/show/{id}/findings	List Hunt Findings
HuntsApi	Show-TheDetailHunt	GET /api/client/hunts/show/{id}	Get Hunt Details
IPAddressesApi	Set-IpToBusinessUnits	POST /api/client/assets/ip/show/{id}/business-units	Assign IP to Business Units
IPAddressesApi	New-AssetIpNote	POST /api/client/assets/ip/show/{id}/note	Create Note
IPAddressesApi	New-CustomPropertyIp	POST /api/client/assets/ip/show/{id}/custom-property	Create Custom Property
IPAddressesApi	Invoke-DeleteAssetIpNote	DELETE /api/client/assets/ip/show/{id}/note/{noteId}	Delete Note
IPAddressesApi	Invoke-DeleteCustomPropertyIp	DELETE /api/client/assets/ip/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
IPAddressesApi	Get-AssetIpDetails	GET /api/client/assets/ip/show/{id}	Get IP Address Details
IPAddressesApi	Get-AssetIpDnsRecords	GET /api/client/assets/ip/show/{id}/dns-records	List DNS Records
IPAddressesApi	Get-AssetIpEngineSettings	GET /api/client/assets/ip/show/{id}/engine-settings	Get IP Engine Settings
IPAddressesApi	Get-AssetIpNotes	GET /api/client/assets/ip/show/{id}/notes	List Notes
IPAddressesApi	Get-AssetIpPortDetails	GET /api/client/assets/ip/show/{ipId}/port/show/{portId}	Get Port
IPAddressesApi	Get-AssetIpPorts	GET /api/client/assets/ip/show/{id}/port/list	List Ports
IPAddressesApi	Get-CustomPropertiesIp	GET /api/client/assets/ip/show/{id}/custom-properties	List Custom Properties
IPAddressesApi	Get-ListAssetIps	GET /api/client/assets/ip/list	List IP Addresses
IPAddressesApi	Invoke-UnassignIpFromBusinessUnits	DELETE /api/client/assets/ip/show/{id}/business-units	Unassign IP from Business Units
IPAddressesApi	Update-AssetIpEngineSettings	PUT /api/client/assets/ip/show/{id}/engine-settings	Update IP Engine Settings
IPAddressesApi	Update-AssetIpNote	PUT /api/client/assets/ip/show/{id}/note/{noteId}	Update Note
IPAddressesApi	Update-AssetIpStatus	PUT /api/client/assets/ip/update-status/{id}	Update Status
IPAddressesApi	Update-CustomPropertyIp	PUT /api/client/assets/ip/show/{id}/custom-property/{customPropertyId}	Update Custom Property
IPRangesApi	Set-IpRangeToBusinessUnits	POST /api/client/assets/ipRange/show/{id}/business-units	Assign IP Range to Business Units
IPRangesApi	New-CustomPropertyIpRange	POST /api/client/assets/ipRange/show/{id}/custom-property	Create Custom Property
IPRangesApi	New-NoteIpRange	POST /api/client/assets/ipRange/show/{id}/note	Create Note
IPRangesApi	Invoke-DeleteCustomPropertyIpRange	DELETE /api/client/assets/ipRange/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
IPRangesApi	Invoke-DeleteNoteIpRange	DELETE /api/client/assets/ipRange/show/{id}/note/{noteId}	Delete Note
IPRangesApi	Get-AssetIpRangeNotes	GET /api/client/assets/ipRange/show/{id}/notes	List Notes
IPRangesApi	Get-AssetIprangeDetails	GET /api/client/assets/ipRange/show/{id}	Get IP Range
IPRangesApi	Get-CustomPropertiesIpRange	GET /api/client/assets/ipRange/show/{id}/custom-properties	List Custom Properties
IPRangesApi	Get-ListAssetIpranges	GET /api/client/assets/ipRange/list	List IP Ranges
IPRangesApi	Invoke-UnassignIpRangeFromBusinessUnits	DELETE /api/client/assets/ipRange/show/{id}/business-units	Unassign IP Range from Business Units
IPRangesApi	Update-AssetIpRangeStatus	PUT /api/client/assets/ipRange/update-status/{id}	Update Status
IPRangesApi	Update-CustomPropertyIpRange	PUT /api/client/assets/ipRange/show/{id}/custom-property/{customPropertyId}	Update Custom Property
IPRangesApi	Update-NoteIpRange	PUT /api/client/assets/ipRange/show/{id}/note/{noteId}	Update Note
KillSwitchApi	Get-KillSwitchStatus	GET /api/client/kill-switch	Get Kill Switch Status
KillSwitchApi	Update-KillSwitch	PUT /api/client/kill-switch	Update Kill Switch
MobileApplicationsApi	Set-MobileAppToBusinessUnits	POST /api/client/assets/mobileApp/show/{id}/business-units	Assign Mobile App to Business Units
MobileApplicationsApi	New-CustomPropertyMobileApp	POST /api/client/assets/mobileApp/show/{id}/custom-property	Create Custom Property
MobileApplicationsApi	New-NoteMobileApp	POST /api/client/assets/mobileApp/show/{id}/note	Create Note
MobileApplicationsApi	Invoke-DeleteCustomPropertyMobileApp	DELETE /api/client/assets/mobileApp/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
MobileApplicationsApi	Invoke-DeleteNoteMobileApp	DELETE /api/client/assets/mobileApp/show/{id}/note/{noteId}	Delete Note
MobileApplicationsApi	Get-AssetMobileAppDetails	GET /api/client/assets/mobileApp/show/{id}	Get Mobile Application
MobileApplicationsApi	Get-AssetMobileAppNotes	GET /api/client/assets/mobileApp/show/{id}/notes	List Notes
MobileApplicationsApi	Get-CustomPropertiesMobileApp	GET /api/client/assets/mobileApp/show/{id}/custom-properties	List Custom Properties
MobileApplicationsApi	Get-ListAssetMobileApps	GET /api/client/assets/mobileApp/list	List Mobile Applications
MobileApplicationsApi	Invoke-UnassignMobileAppFromBusinessUnits	DELETE /api/client/assets/mobileApp/show/{id}/business-units	Unassign Mobile App from Business Units
MobileApplicationsApi	Update-AssetMobileAppStatus	PUT /api/client/assets/mobileApp/update-status/{id}	Update Status
MobileApplicationsApi	Update-CustomPropertyMobileApp	PUT /api/client/assets/mobileApp/show/{id}/custom-property/{customPropertyId}	Update Custom Property
MobileApplicationsApi	Update-NoteMobileApp	PUT /api/client/assets/mobileApp/show/{id}/note/{noteId}	Update Note
PackageManagersApi	Add-AssetPackageManagerNote	POST /api/client/assets/packageManager/show/{id}/note	Create Note
PackageManagersApi	Set-PackageManagerToBusinessUnits	POST /api/client/assets/packageManager/show/{id}/business-units	Assign Package Manager to Business Units
PackageManagersApi	New-CustomPropertyPackageManager	POST /api/client/assets/packageManager/show/{id}/custom-property	Create Custom Property
PackageManagersApi	Invoke-DeleteAssetPackageManagerNote	DELETE /api/client/assets/packageManager/show/{id}/note/{noteId}	Delete Note
PackageManagersApi	Invoke-DeleteCustomPropertyById	DELETE /api/client/assets/packageManager/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
PackageManagersApi	Get-AssetPackageManagerDetails	GET /api/client/assets/packageManager/show/{id}	Get Package Manager
PackageManagersApi	Get-AssetPackageManagerNotes	GET /api/client/assets/packageManager/show/{id}/notes	List Notes
PackageManagersApi	Get-CustomPropertiesPackageManager	GET /api/client/assets/packageManager/show/{id}/custom-properties	List Custom Properties
PackageManagersApi	Get-ListAssetPackageManagers	GET /api/client/assets/packageManager/list	List Package Managers
PackageManagersApi	Invoke-UnassignPackageManagerFromBusinessUnits	DELETE /api/client/assets/packageManager/show/{id}/business-units	Unassign Package Manager from Business Units
PackageManagersApi	Update-AssetPackageManagerNote	PUT /api/client/assets/packageManager/show/{id}/note/{noteId}	Update Note
PackageManagersApi	Update-AssetPackageManagerStatus	PUT /api/client/assets/packageManager/update-status/{id}	Update Status
PackageManagersApi	Update-CustomPropertyPackageManager	PUT /api/client/assets/packageManager/show/{id}/custom-property/{customPropertyId}	Update Custom Property
PendingDomainsApi	Get-ListPendingDomains	GET /api/client/pending-domains/list	List Pending Domains
PlatformWhitelistingApi	New-PlatformApiWhitelistIp	POST /api/client/platform/whitelisting/api	Add API Whitelisted IP
PlatformWhitelistingApi	New-PlatformDashboardWhitelistIp	POST /api/client/platform/whitelisting/dashboard	Add Dashboard Whitelisted IP
PlatformWhitelistingApi	Invoke-DeletePlatformApiWhitelistIp	DELETE /api/client/platform/whitelisting/api/{id}	Remove API Whitelisted IP
PlatformWhitelistingApi	Invoke-DeletePlatformDashboardWhitelistIp	DELETE /api/client/platform/whitelisting/dashboard/{id}	Remove Dashboard Whitelisted IP
PlatformWhitelistingApi	Get-PlatformApiWhitelistIps	GET /api/client/platform/whitelisting/api	List API Whitelisted IPs
PlatformWhitelistingApi	Get-PlatformApiWhitelistStatus	GET /api/client/platform/whitelisting/api/status	Get API Whitelisting Status
PlatformWhitelistingApi	Get-PlatformDashboardWhitelistIps	GET /api/client/platform/whitelisting/dashboard	List Dashboard Whitelisted IPs
PlatformWhitelistingApi	Get-PlatformDashboardWhitelistStatus	GET /api/client/platform/whitelisting/dashboard/status	Get Dashboard Whitelisting Status
PlatformWhitelistingApi	Update-PlatformApiWhitelistIp	PUT /api/client/platform/whitelisting/api/{id}	Update API Whitelisted IP
PlatformWhitelistingApi	Update-PlatformApiWhitelistStatus	PUT /api/client/platform/whitelisting/api/status	Update API Whitelisting Status
PlatformWhitelistingApi	Update-PlatformDashboardWhitelistIp	PUT /api/client/platform/whitelisting/dashboard/{id}	Update Dashboard Whitelisted IP
PlatformWhitelistingApi	Update-PlatformDashboardWhitelistStatus	PUT /api/client/platform/whitelisting/dashboard/status	Update Dashboard Whitelisting Status
PointsOfInterestApi	Get-ListPointsOfInterest	GET /api/client/points-of-interest/list	List Points of Interest
PortsApi	Get-AssetPortDetails	GET /api/client/assets/ip/port/show/{id}	Get Port
PortsApi	Get-ListAssetPorts	GET /api/client/assets/ip/port/list	List Ports
RepositoriesApi	Set-RepositoryToBusinessUnits	POST /api/client/assets/repository/show/{id}/business-units	Assign Repository to Business Units
RepositoriesApi	New-CustomPropertyRepository	POST /api/client/assets/repository/show/{id}/custom-property	Create Custom Property
RepositoriesApi	New-NoteRepository	POST /api/client/assets/repository/show/{id}/note	Create Note
RepositoriesApi	Invoke-DeleteCustomPropertyRepository	DELETE /api/client/assets/repository/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
RepositoriesApi	Invoke-DeleteNoteRepository	DELETE /api/client/assets/repository/show/{id}/note/{noteId}	Delete Note
RepositoriesApi	Get-AssetRepositoryDetails	GET /api/client/assets/repository/show/{id}	Get Repository
RepositoriesApi	Get-AssetRepositoryNotes	GET /api/client/assets/repository/show/{id}/notes	List Notes
RepositoriesApi	Get-CustomPropertiesRepository	GET /api/client/assets/repository/show/{id}/custom-properties	List Custom Properties
RepositoriesApi	Get-ListAssetRepositories	GET /api/client/assets/repository/list	List Repositories
RepositoriesApi	Invoke-UnassignRepositoryFromBusinessUnits	DELETE /api/client/assets/repository/show/{id}/business-units	Unassign Repository from Business Units
RepositoriesApi	Update-AssetRepositoryStatus	PUT /api/client/assets/repository/update-status/{id}	Update Status
RepositoriesApi	Update-CustomPropertyRepository	PUT /api/client/assets/repository/show/{id}/custom-property/{customPropertyId}	Update Custom Property
RepositoriesApi	Update-NoteRepository	PUT /api/client/assets/repository/show/{id}/note/{noteId}	Update Note
SaaSPlatformsApi	Set-SaasPlatformToBusinessUnits	POST /api/client/assets/saasPlatform/show/{id}/business-units	Assign SaaS Platform to Business Units
SaaSPlatformsApi	New-CustomPropertySaasPlatform	POST /api/client/assets/saasPlatform/show/{id}/custom-property	Create Custom Property
SaaSPlatformsApi	New-NoteSaasPlatform	POST /api/client/assets/saasPlatform/show/{id}/note	Create Note
SaaSPlatformsApi	Invoke-DeleteCustomPropertySaasPlatform	DELETE /api/client/assets/saasPlatform/show/{id}/custom-property/{customPropertyId}	Delete Custom Property
SaaSPlatformsApi	Invoke-DeleteNoteSaasPlatform	DELETE /api/client/assets/saasPlatform/show/{id}/note/{noteId}	Delete Note
SaaSPlatformsApi	Get-AssetSaasPlatformDetails	GET /api/client/assets/saasPlatform/show/{id}	Get SaaS Platform
SaaSPlatformsApi	Get-AssetSaasPlatformNotes	GET /api/client/assets/saasPlatform/show/{id}/notes	List Notes
SaaSPlatformsApi	Get-CustomPropertiesSaasPlatform	GET /api/client/assets/saasPlatform/show/{id}/custom-properties	List Custom Properties
SaaSPlatformsApi	Get-ListAssetSaasPlatforms	GET /api/client/assets/saasPlatform/list	List SaaS Platforms
SaaSPlatformsApi	Invoke-UnassignSaasPlatformFromBusinessUnits	DELETE /api/client/assets/saasPlatform/show/{id}/business-units	Unassign SaaS Platform from Business Units
SaaSPlatformsApi	Update-AssetSaasPlatformStatus	PUT /api/client/assets/saasPlatform/update-status/{id}	Update Status
SaaSPlatformsApi	Update-CustomPropertySaasPlatform	PUT /api/client/assets/saasPlatform/show/{id}/custom-property/{customPropertyId}	Update Custom Property
SaaSPlatformsApi	Update-NoteSaasPlatform	PUT /api/client/assets/saasPlatform/show/{id}/note/{noteId}	Update Note
SecurityPostureDashboardApi	Get-SecurityPostureDashboard	GET /api/client/dashboard/security-posture	Get Security Posture Dashboard
ServiceDiscoveryApi	Get-ListServiceListing	GET /api/client/service-listing/list	List Services
SourceIPAddressesApi	Get-ListSourceIpAddresses	GET /api/client/testing-infrastructure	List Testing Infrastructure
SubdomainsApi	Set-SubomainToBusinessUnits	POST /api/client/assets/subdomain/show/{id}/business-units	Assign Subdomain to Business Units
SubdomainsApi	New-CustomPropertySubdomain	POST /api/client/assets/subdomain/show/{id}/custom-property	Create Subdomain Custom Property
SubdomainsApi	New-NoteSubdomain	POST /api/client/assets/subdomain/show/{id}/note	Create Subdomain Note
SubdomainsApi	Invoke-DeleteCustomPropertySubdomain	DELETE /api/client/assets/subdomain/show/{id}/custom-property/{customPropertyId}	Delete Subdomain Custom Property
SubdomainsApi	Invoke-DeleteNoteSubdomain	DELETE /api/client/assets/subdomain/show/{id}/note/{noteId}	Delete Subdomain Note
SubdomainsApi	Get-AssetSubdomainDetails	GET /api/client/assets/subdomain/show/{id}	Get Subdomain Details
SubdomainsApi	Get-AssetSubdomainDnsRecords	GET /api/client/assets/subdomain/show/{id}/dns-records	List Subdomain DNS Records
SubdomainsApi	Get-AssetSubdomainEngineSettings	GET /api/client/assets/subdomain/show/{id}/engine-settings	Get Subdomain Engine Settings
SubdomainsApi	Get-CustomPropertiesSubdomain	GET /api/client/assets/subdomain/show/{id}/custom-properties	List Subdomain Custom Properties
SubdomainsApi	Get-ListAssetSubdomains	GET /api/client/assets/subdomain/list	List Subdomains
SubdomainsApi	Get-NotesSubdomain	GET /api/client/assets/subdomain/show/{id}/notes	List Subdomain Notes
SubdomainsApi	Invoke-UnassignSubomainFromBusinessUnits	DELETE /api/client/assets/subdomain/show/{id}/business-units	Unassign Subdomain from Business Units
SubdomainsApi	Update-AssetSubdomainEngineSettings	PUT /api/client/assets/subdomain/show/{id}/engine-settings	Update Subdomain Engine Settings
SubdomainsApi	Update-AssetSubdomainStatus	PUT /api/client/assets/subdomain/update-status/{id}	Update Subdomain Status
SubdomainsApi	Update-CustomPropertySubdomain	PUT /api/client/assets/subdomain/show/{id}/custom-property/{customPropertyId}	Update Subdomain Custom Property
SubdomainsApi	Update-NoteSubdomain	PUT /api/client/assets/subdomain/show/{id}/note/{noteId}	Update Subdomain Note
SuspiciousDomainsApi	Get-ListSuspiciousDomain	GET /api/client/suspicious-domain/list	List Suspicious Domains
SuspiciousDomainsApi	Get-SuspiciousDomainDetails	GET /api/client/suspicious-domain/show/{id}	Get Suspicious Domain Details
UserManagementApi	Get-UserDetails	GET /api/client/users/show/{id}	Get User Details
UserManagementApi	Invoke-ListUsers	GET /api/client/users/list	List Users

Documentation for Models

• WatchtowrAPI\Model.Asset
• WatchtowrAPI\Model.AssetAndBusinessUnitAlreadyAssociatedConflictErrorResponse
• WatchtowrAPI\Model.AssetAndBusinessUnitNotAssociatedConflictErrorResponse
• WatchtowrAPI\Model.AssetBusinessUnitIdsDTO
• WatchtowrAPI\Model.AssetsListResponse
• WatchtowrAPI\Model.AttackSurfaceDto
• WatchtowrAPI\Model.AttackSurfaceResiliencyDto
• WatchtowrAPI\Model.BadRequestResponse
• WatchtowrAPI\Model.Causer
• WatchtowrAPI\Model.ClientActivityLog
• WatchtowrAPI\Model.ClientApiDocumentation
• WatchtowrAPI\Model.ClientApiDocumentationAsset
• WatchtowrAPI\Model.ClientAssetDnsRecord
• WatchtowrAPI\Model.ClientBusinessUnit
• WatchtowrAPI\Model.ClientBusinessUnitData
• WatchtowrAPI\Model.ClientBusinessUnitDetail
• WatchtowrAPI\Model.ClientCloudAsset
• WatchtowrAPI\Model.ClientCloudAssetData
• WatchtowrAPI\Model.ClientCloudStorage
• WatchtowrAPI\Model.ClientCloudStorageData
• WatchtowrAPI\Model.ClientContainer
• WatchtowrAPI\Model.ClientContainerData
• WatchtowrAPI\Model.ClientCustomProperty
• WatchtowrAPI\Model.ClientDnsRecord
• WatchtowrAPI\Model.ClientDnsRecordAsset
• WatchtowrAPI\Model.ClientDnsRecordListData
• WatchtowrAPI\Model.ClientDomain
• WatchtowrAPI\Model.ClientDomainData
• WatchtowrAPI\Model.ClientEngineSettings
• WatchtowrAPI\Model.ClientEngineSettingsData
• WatchtowrAPI\Model.ClientEngineSettingsDetails
• WatchtowrAPI\Model.ClientFinding
• WatchtowrAPI\Model.ClientFindingAssignee
• WatchtowrAPI\Model.ClientFindingData
• WatchtowrAPI\Model.ClientFindingImpactTag
• WatchtowrAPI\Model.ClientFindingRetestHistory
• WatchtowrAPI\Model.ClientFindingRetestHistoryAsset
• WatchtowrAPI\Model.ClientFindingRetestHistoryFinding
• WatchtowrAPI\Model.ClientFindingRetestHistoryTriggeredBy
• WatchtowrAPI\Model.ClientIp
• WatchtowrAPI\Model.ClientIpData
• WatchtowrAPI\Model.ClientIpDetailDnsRecords
• WatchtowrAPI\Model.ClientIpDnsRecordData
• WatchtowrAPI\Model.ClientIpDnsRecordOwnedData
• WatchtowrAPI\Model.ClientIpDnsRecordPointingAtData
• WatchtowrAPI\Model.ClientIpDnsRecordResponse
• WatchtowrAPI\Model.ClientIpRange
• WatchtowrAPI\Model.ClientIpRangeData
• WatchtowrAPI\Model.ClientIpRelatedDnsRecord
• WatchtowrAPI\Model.ClientIpRelatedDnsRecordAsset
• WatchtowrAPI\Model.ClientMobileApp
• WatchtowrAPI\Model.ClientMobileAppData
• WatchtowrAPI\Model.ClientNote
• WatchtowrAPI\Model.ClientNoteData
• WatchtowrAPI\Model.ClientNoteListData
• WatchtowrAPI\Model.ClientPackageManager
• WatchtowrAPI\Model.ClientPackageManagerData
• WatchtowrAPI\Model.ClientPendingDomain
• WatchtowrAPI\Model.ClientPendingDomainWhoisData
• WatchtowrAPI\Model.ClientPort
• WatchtowrAPI\Model.ClientPortData
• WatchtowrAPI\Model.ClientRepository
• WatchtowrAPI\Model.ClientRepositoryData
• WatchtowrAPI\Model.ClientSaasPlatform
• WatchtowrAPI\Model.ClientSaasPlatformData
• WatchtowrAPI\Model.ClientSeedData
• WatchtowrAPI\Model.ClientSeedDataData
• WatchtowrAPI\Model.ClientServiceInformationResponseData
• WatchtowrAPI\Model.ClientSourceIpsAddresses
• WatchtowrAPI\Model.ClientSubdomain
• WatchtowrAPI\Model.ClientSubdomainData
• WatchtowrAPI\Model.ClientSuspiciousDomainData
• WatchtowrAPI\Model.ClientUser
• WatchtowrAPI\Model.ClientUserDetail
• WatchtowrAPI\Model.CreateClientCustomPropertyDto
• WatchtowrAPI\Model.CreateClientNoteDto
• WatchtowrAPI\Model.CreateClientSeedDataRequestBody
• WatchtowrAPI\Model.CreateOrganisationWhitelistIpDto
• WatchtowrAPI\Model.DeleteNoteSucces
• WatchtowrAPI\Model.DeleteWhitelistIpData
• WatchtowrAPI\Model.FilterByBusinessUnitInput
• WatchtowrAPI\Model.FindingListResponse
• WatchtowrAPI\Model.FindingRetestResponseDto
• WatchtowrAPI\Model.FindingsSummaryDto
• WatchtowrAPI\Model.ForbiddenResponse
• WatchtowrAPI\Model.HostnameBusinessUnitIDsDTO
• WatchtowrAPI\Model.Hunt
• WatchtowrAPI\Model.HuntAcknowledgementDto
• WatchtowrAPI\Model.HuntDetail
• WatchtowrAPI\Model.HuntDetailResponse
• WatchtowrAPI\Model.HuntOverviewDto
• WatchtowrAPI\Model.Infrastructure
• WatchtowrAPI\Model.KillSwitchDisabledError
• WatchtowrAPI\Model.KillSwitchForbiddenError
• WatchtowrAPI\Model.KillSwitchStatusData
• WatchtowrAPI\Model.KillSwitchStatusResponse
• WatchtowrAPI\Model.LatestExecutedHuntDto
• WatchtowrAPI\Model.Link
• WatchtowrAPI\Model.Meta
• WatchtowrAPI\Model.MttrMetricsDto
• WatchtowrAPI\Model.NotFound
• WatchtowrAPI\Model.NotFoundResponse
• WatchtowrAPI\Model.OpenFindingsDto
• WatchtowrAPI\Model.OrganizationSummaryDto
• WatchtowrAPI\Model.PaginatedApiDocumentation
• WatchtowrAPI\Model.PaginatedBusinessUnit
• WatchtowrAPI\Model.PaginatedClientActivityLog
• WatchtowrAPI\Model.PaginatedClientCloudAsset
• WatchtowrAPI\Model.PaginatedClientCloudStorage
• WatchtowrAPI\Model.PaginatedClientContainer
• WatchtowrAPI\Model.PaginatedClientCustomProperty
• WatchtowrAPI\Model.PaginatedClientDnsRecord
• WatchtowrAPI\Model.PaginatedClientDomain
• WatchtowrAPI\Model.PaginatedClientFindingRetestHistory
• WatchtowrAPI\Model.PaginatedClientFindings
• WatchtowrAPI\Model.PaginatedClientIp
• WatchtowrAPI\Model.PaginatedClientIpRange
• WatchtowrAPI\Model.PaginatedClientMobileApp
• WatchtowrAPI\Model.PaginatedClientPackageManager
• WatchtowrAPI\Model.PaginatedClientPendingDomain
• WatchtowrAPI\Model.PaginatedClientPort
• WatchtowrAPI\Model.PaginatedClientRepository
• WatchtowrAPI\Model.PaginatedClientSaasPlatform
• WatchtowrAPI\Model.PaginatedClientSubdomain
• WatchtowrAPI\Model.PaginatedHunts
• WatchtowrAPI\Model.PaginatedPointOfInterest
• WatchtowrAPI\Model.PaginatedServiceInformationResponse
• WatchtowrAPI\Model.PaginatedServiceListing
• WatchtowrAPI\Model.PaginatedSuspiciousDomain
• WatchtowrAPI\Model.PaginatedUsers
• WatchtowrAPI\Model.Pagination
• WatchtowrAPI\Model.PointsOfInterest
• WatchtowrAPI\Model.RemoveClientCustomPropertyResponseDto
• WatchtowrAPI\Model.RequiredActionsDto
• WatchtowrAPI\Model.Retest
• WatchtowrAPI\Model.SecurityPostureDashboardDto
• WatchtowrAPI\Model.SecurityPostureDashboardResponse
• WatchtowrAPI\Model.ServiceInformationAsset
• WatchtowrAPI\Model.ServiceInformationCertificate
• WatchtowrAPI\Model.ServiceInformationResponse
• WatchtowrAPI\Model.ServiceListing
• WatchtowrAPI\Model.ServiceType
• WatchtowrAPI\Model.SuspiciousDomain
• WatchtowrAPI\Model.Technology
• WatchtowrAPI\Model.ThreatActorDto
• WatchtowrAPI\Model.Unauthorized
• WatchtowrAPI\Model.UnauthorizedResponse
• WatchtowrAPI\Model.UnprocessableContent
• WatchtowrAPI\Model.UpdateApiDocumentationStatusDto
• WatchtowrAPI\Model.UpdateClientCloudAssetStatusDto
• WatchtowrAPI\Model.UpdateClientCustomPropertyDto
• WatchtowrAPI\Model.UpdateClientEngineSettingsDto
• WatchtowrAPI\Model.UpdateClientFindingStatusRequestBody
• WatchtowrAPI\Model.UpdateClientLegacyAssetStatusDto
• WatchtowrAPI\Model.UpdateClientNextGenAssetStatusDto
• WatchtowrAPI\Model.UpdateKillSwitchData
• WatchtowrAPI\Model.UpdateKillSwitchRequestDto
• WatchtowrAPI\Model.UpdateKillSwitchResponse
• WatchtowrAPI\Model.UpdateOrganisationWhitelistIpDto
• WatchtowrAPI\Model.UserDetailData
• WatchtowrAPI\Model.WhitelistIpData
• WatchtowrAPI\Model.WhitelistIpDataSingle
• WatchtowrAPI\Model.WhitelistIpListData
• WatchtowrAPI\Model.WhitelistStatusData
• WatchtowrAPI\Model.WhitelistStatusDto
• WatchtowrAPI\Model.WhoisData
• WatchtowrAPI\Model.WhoisDataObject
• WatchtowrAPI\Model.WhoisDataObjectEmails
• WatchtowrAPI\Model.WhoisDataObjectNameServers
• WatchtowrAPI\Model.WhoisDataObjectStatus

Documentation for Authorization

Authentication schemes defined for the API:

bearer

• Type: HTTP Bearer Token authentication (API_TOKEN)