runzero
Module runzero
API
Definitions
ballerinax/runzero Ballerina library
Overview
runZero is a cyber asset attack surface management platform that discovers and inventories the assets on a network. The runZero connector lets Ballerina applications work with the runZero REST API: manage organizations, sites, explorers and scan tasks, query discovered assets, services and vulnerabilities, export inventory data, and administer account users, groups, credentials and API keys.
This connector supports version 4.0.251021.0 of the runZero API.
Key features
- Query and manage discovered assets, services, wireless networks, software and vulnerabilities
- Create and update sites, then launch scans, traffic sampling and data imports
- Monitor explorers, hosted zones and scan tasks
- Export inventory data in JSON, JSON Lines and CSV formats
- Administer account organizations, users, groups, SSO mappings, credentials and API keys
Setup guide
To use the runZero connector, you need a runZero account and an API token.
-
Sign in to the runZero console at console.runzero.com.
-
Open the API keys page of your account or organization settings and create a new API key. Account keys start with
CT, organization keys start withOTand export tokens start withET.Note: Organization operations such as
getSites()need an organization key (OT), which is scoped to one organization, or an account key (CT) or OAuth client, which can select the organization with the_oidquery parameter. Export tokens (ET) work only with the export operations, and account operations need an account key or an OAuth client. -
Copy the generated token and store it securely. It is passed to the connector as a bearer token.
-
Alternatively, create an API client in the account settings and use its client ID and client secret with the OAuth 2.0 client credentials grant. The token endpoint is
https://console.runzero.com/api/v1.0/account/api/token.
Quickstart
To use the runzero connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/runzero;
Step 2: Instantiate a new connector
Create a Config.toml file and configure the API token:
token = "<API token>"
Then create a client in the .bal file:
configurable string token = ?; final runzero:Client runzeroClient = check new ({auth: {token}});
Step 3: Invoke the connector operation
Use the client to list the sites of your organization:
public function main() returns error? { runzero:Site[] _ = check runzeroClient->getSites(); }
Step 4: Run the Ballerina application
bal run
Examples
The runZero connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Site asset inventory - List the live assets discovered in a site.
- Explorer task monitoring - Check explorer connectivity and review tasks by status.
Clients
runzero: Client
Manage runZero network asset discovery and inventory, including organizations, sites, assets, scans, tasks, users and integrations, through the runZero REST API.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://console.runzero.com/api/v1.0" - URL of the target service
getLatestAgentVersion
function getLatestAgentVersion(map<string|string[]> headers) returns ComponentVersion|errorReturns latest agent version
Return Type
- ComponentVersion|error - component version
getLatestScannerVersion
function getLatestScannerVersion(map<string|string[]> headers) returns ComponentVersion|errorReturns latest scanner version
Return Type
- ComponentVersion|error - component version
getLatestPlatformVersion
function getLatestPlatformVersion(map<string|string[]> headers) returns ComponentVersion|errorReturns latest platform version
Return Type
- ComponentVersion|error - component version
getHealthCheck
function getHealthCheck(map<string|string[]> headers) returns HealthCheckResponse|errorReturns a health check status (cloud and self-hosted)
Return Type
- HealthCheckResponse|error - health status and current version
importCustomIntegrationAssets
function importCustomIntegrationAssets(string orgID, NewAssetImport payload, map<string|string[]> headers) returns Task|errorImport assets described by a registered custom integration
Parameters
- orgID string - The ID of the organization to import the assets into
- payload NewAssetImport - Custom integration asset import payload with assets to create or merge
exportAssetsJSON
function exportAssetsJSON(map<string|string[]> headers, *ExportAssetsJSONQueries queries) returns ExportAssetsResponse|errorExports the asset inventory
Parameters
- queries *ExportAssetsJSONQueries - Queries to be sent with the request
Return Type
- ExportAssetsResponse|error - Filtered asset results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of assets.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with an assets array and anext_keystring for pagination.</li></ul>
exportAssetsJSONL
function exportAssetsJSONL(map<string|string[]> headers, *ExportAssetsJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorAsset inventory as JSON line-delimited
Parameters
- queries *ExportAssetsJSONLQueries - Queries to be sent with the request
exportAssetsCSV
function exportAssetsCSV(map<string|string[]> headers, *ExportAssetsCSVQueries queries) returns string|errorAsset inventory as CSV
Parameters
- queries *ExportAssetsCSVQueries - Queries to be sent with the request
exportAssetsNmapXML
function exportAssetsNmapXML(map<string|string[]> headers, *ExportAssetsNmapXMLQueries queries) returns xml|errorAsset inventory as Nmap-style XML
Parameters
- queries *ExportAssetsNmapXMLQueries - Queries to be sent with the request
exportServicesJSON
function exportServicesJSON(map<string|string[]> headers, *ExportServicesJSONQueries queries) returns ExportServicesResponse|errorService inventory as JSON
Parameters
- queries *ExportServicesJSONQueries - Queries to be sent with the request
Return Type
- ExportServicesResponse|error - Filtered service results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of services.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with a services array and anext_keystring for pagination.</li></ul>
exportServicesJSONL
function exportServicesJSONL(map<string|string[]> headers, *ExportServicesJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorService inventory as JSON line-delimited
Parameters
- queries *ExportServicesJSONLQueries - Queries to be sent with the request
exportServicesCSV
function exportServicesCSV(map<string|string[]> headers, *ExportServicesCSVQueries queries) returns string|errorService inventory as CSV
Parameters
- queries *ExportServicesCSVQueries - Queries to be sent with the request
exportSitesJSON
function exportSitesJSON(map<string|string[]> headers, *ExportSitesJSONQueries queries) returns Site[]|errorExport all sites
Parameters
- queries *ExportSitesJSONQueries - Queries to be sent with the request
exportSitesJSONL
function exportSitesJSONL(map<string|string[]> headers, *ExportSitesJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorSite list as JSON line-delimited
Parameters
- queries *ExportSitesJSONLQueries - Queries to be sent with the request
exportSitesCSV
function exportSitesCSV(map<string|string[]> headers, *ExportSitesCSVQueries queries) returns string|errorSite list as CSV
Parameters
- queries *ExportSitesCSVQueries - Queries to be sent with the request
exportWirelessJSON
function exportWirelessJSON(map<string|string[]> headers, *ExportWirelessJSONQueries queries) returns ExportWirelessResponse|errorWireless inventory as JSON
Parameters
- queries *ExportWirelessJSONQueries - Queries to be sent with the request
Return Type
- ExportWirelessResponse|error - Filtered wireless results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of wireless.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with a wireless array and anext_keystring for pagination.</li></ul>
exportWirelessJSONL
function exportWirelessJSONL(map<string|string[]> headers, *ExportWirelessJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorWireless inventory as JSON line-delimited
Parameters
- queries *ExportWirelessJSONLQueries - Queries to be sent with the request
exportWirelessCSV
function exportWirelessCSV(map<string|string[]> headers, *ExportWirelessCSVQueries queries) returns string|errorWireless inventory as CSV
Parameters
- queries *ExportWirelessCSVQueries - Queries to be sent with the request
exportSoftwareJSON
function exportSoftwareJSON(map<string|string[]> headers, *ExportSoftwareJSONQueries queries) returns ExportSoftwareResponse|errorExports the software inventory
Parameters
- queries *ExportSoftwareJSONQueries - Queries to be sent with the request
Return Type
- ExportSoftwareResponse|error - Filtered software results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of software.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with a software array and anext_keystring for pagination.</li></ul>
exportSoftwareJSONL
function exportSoftwareJSONL(map<string|string[]> headers, *ExportSoftwareJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorSoftware inventory as JSON line-delimited
Parameters
- queries *ExportSoftwareJSONLQueries - Queries to be sent with the request
exportSoftwareCSV
function exportSoftwareCSV(map<string|string[]> headers, *ExportSoftwareCSVQueries queries) returns string|errorSoftware inventory as CSV
Parameters
- queries *ExportSoftwareCSVQueries - Queries to be sent with the request
exportVulnerabilitiesJSON
function exportVulnerabilitiesJSON(map<string|string[]> headers, *ExportVulnerabilitiesJSONQueries queries) returns ExportVulnerabilitiesResponse|errorExport the vulnerability inventory as JSON
Parameters
- queries *ExportVulnerabilitiesJSONQueries - Queries to be sent with the request
Return Type
- ExportVulnerabilitiesResponse|error - Filtered vulnerability results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of vulnerabilities.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with an vulnerabilites array and anext_keystring for pagination.</li></ul>
exportVulnerabilitiesJSONL
function exportVulnerabilitiesJSONL(map<string|string[]> headers, *ExportVulnerabilitiesJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorExport the vulnerability inventory as JSON line-delimited
Parameters
- queries *ExportVulnerabilitiesJSONLQueries - Queries to be sent with the request
exportVulnerabilitiesCSV
function exportVulnerabilitiesCSV(map<string|string[]> headers, *ExportVulnerabilitiesCSVQueries queries) returns string|errorExport the vulnerability inventory as CSV
Parameters
- queries *ExportVulnerabilitiesCSVQueries - Queries to be sent with the request
exportCertificatesCSV
function exportCertificatesCSV(map<string|string[]> headers, *ExportCertificatesCSVQueries queries) returns string|errorExport the certificate inventory as CSV
Parameters
- queries *ExportCertificatesCSVQueries - Queries to be sent with the request
exportCertificatesJSON
function exportCertificatesJSON(map<string|string[]> headers, *ExportCertificatesJSONQueries queries) returns Certificate[]|errorExport the certificate inventory as JSON
Parameters
- queries *ExportCertificatesJSONQueries - Queries to be sent with the request
Return Type
- Certificate[]|error - filtered certificate results
exportCertificatesJSONL
function exportCertificatesJSONL(map<string|string[]> headers, *ExportCertificatesJSONLQueries queries) returns Certificate|errorExport the certificate inventory as JSONL line-delimited
Parameters
- queries *ExportCertificatesJSONLQueries - Queries to be sent with the request
Return Type
- Certificate|error - filtered certificate results
exportDirectoryUsersJSON
function exportDirectoryUsersJSON(map<string|string[]> headers, *ExportDirectoryUsersJSONQueries queries) returns DirectoryUser[]|errorExports the user inventory
Parameters
- queries *ExportDirectoryUsersJSONQueries - Queries to be sent with the request
Return Type
- DirectoryUser[]|error - filtered user results
exportDirectoryUsersJSONL
function exportDirectoryUsersJSONL(map<string|string[]> headers, *ExportDirectoryUsersJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorUser inventory as JSON line-delimited
Parameters
- queries *ExportDirectoryUsersJSONLQueries - Queries to be sent with the request
exportDirectoryUsersCSV
function exportDirectoryUsersCSV(map<string|string[]> headers, *ExportDirectoryUsersCSVQueries queries) returns string|errorUser inventory as CSV
Parameters
- queries *ExportDirectoryUsersCSVQueries - Queries to be sent with the request
exportDirectoryGroupsJSON
function exportDirectoryGroupsJSON(map<string|string[]> headers, *ExportDirectoryGroupsJSONQueries queries) returns DirectoryGroup[]|errorExports the group inventory
Parameters
- queries *ExportDirectoryGroupsJSONQueries - Queries to be sent with the request
Return Type
- DirectoryGroup[]|error - filtered group results
exportDirectoryGroupsJSONL
function exportDirectoryGroupsJSONL(map<string|string[]> headers, *ExportDirectoryGroupsJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorGroup inventory as JSON line-delimited
Parameters
- queries *ExportDirectoryGroupsJSONLQueries - Queries to be sent with the request
exportDirectoryGroupsCSV
function exportDirectoryGroupsCSV(map<string|string[]> headers, *ExportDirectoryGroupsCSVQueries queries) returns string|errorGroup inventory as CSV
Parameters
- queries *ExportDirectoryGroupsCSVQueries - Queries to be sent with the request
exportFindingsCSV
function exportFindingsCSV(map<string|string[]> headers, *ExportFindingsCSVQueries queries) returns string|errorExport findings as CSV
Parameters
- queries *ExportFindingsCSVQueries - Queries to be sent with the request
exportFindingsJSON
function exportFindingsJSON(map<string|string[]> headers, *ExportFindingsJSONQueries queries) returns Finding[]|errorExport findings as JSON
Parameters
- queries *ExportFindingsJSONQueries - Queries to be sent with the request
exportFindingsJSONL
function exportFindingsJSONL(map<string|string[]> headers, *ExportFindingsJSONLQueries queries) returns Finding[]|errorExport findings as JSON line-delimited
Parameters
- queries *ExportFindingsJSONLQueries - Queries to be sent with the request
exportSubnetUtilizationStatsCSV
function exportSubnetUtilizationStatsCSV(map<string|string[]> headers, *ExportSubnetUtilizationStatsCSVQueries queries) returns string|errorSubnet utilization statistics as as CSV
Parameters
- queries *ExportSubnetUtilizationStatsCSVQueries - Queries to be sent with the request
exportSNMPARPCacheCSV
function exportSNMPARPCacheCSV(map<string|string[]> headers, *ExportSNMPARPCacheCSVQueries queries) returns string|errorSNMP ARP cache data as CSV
Parameters
- queries *ExportSNMPARPCacheCSVQueries - Queries to be sent with the request
exportTasksJSON
function exportTasksJSON(map<string|string[]> headers, *ExportTasksJSONQueries queries) returns Task[]|errorExports organization tasks
Parameters
- queries *ExportTasksJSONQueries - Queries to be sent with the request
exportTasksJSONL
function exportTasksJSONL(map<string|string[]> headers, *ExportTasksJSONLQueries queries) returns record { fileContent byte[], fileName string }|errorOrganization tasks as JSON line-delimited
Parameters
- queries *ExportTasksJSONLQueries - Queries to be sent with the request
exportAssetTopTypesCSV
function exportAssetTopTypesCSV(map<string|string[]> headers, *ExportAssetTopTypesCSVQueries queries) returns string|errorTop asset types as CSV
Parameters
- queries *ExportAssetTopTypesCSVQueries - Queries to be sent with the request
exportAssetTopOSCSV
function exportAssetTopOSCSV(map<string|string[]> headers, *ExportAssetTopOSCSVQueries queries) returns string|errorTop asset operating systems as CSV
Parameters
- queries *ExportAssetTopOSCSVQueries - Queries to be sent with the request
exportAssetTopHWCSV
function exportAssetTopHWCSV(map<string|string[]> headers, *ExportAssetTopHWCSVQueries queries) returns string|errorTop asset hardware products as CSV
Parameters
- queries *ExportAssetTopHWCSVQueries - Queries to be sent with the request
exportAssetTopTagsCSV
function exportAssetTopTagsCSV(map<string|string[]> headers, *ExportAssetTopTagsCSVQueries queries) returns string|errorTop asset tags as CSV
Parameters
- queries *ExportAssetTopTagsCSVQueries - Queries to be sent with the request
exportServicesTopTCPCSV
function exportServicesTopTCPCSV(map<string|string[]> headers, *ExportServicesTopTCPCSVQueries queries) returns string|errorTop TCP services as CSV
Parameters
- queries *ExportServicesTopTCPCSVQueries - Queries to be sent with the request
exportServicesTopUDPCSV
function exportServicesTopUDPCSV(map<string|string[]> headers, *ExportServicesTopUDPCSVQueries queries) returns string|errorTop UDP services as CSV
Parameters
- queries *ExportServicesTopUDPCSVQueries - Queries to be sent with the request
exportServicesTopProtocolsCSV
function exportServicesTopProtocolsCSV(map<string|string[]> headers, *ExportServicesTopProtocolsCSVQueries queries) returns string|errorTop service protocols as CSV
Parameters
- queries *ExportServicesTopProtocolsCSVQueries - Queries to be sent with the request
exportServicesTopProductsCSV
function exportServicesTopProductsCSV(map<string|string[]> headers, *ExportServicesTopProductsCSVQueries queries) returns string|errorTop service products as CSV
Parameters
- queries *ExportServicesTopProductsCSVQueries - Queries to be sent with the request
exportAssetMetricsJSON
function exportAssetMetricsJSON(map<string|string[]> headers, *ExportAssetMetricsJSONQueries queries) returns record { AssetMetricsResponse... }|errorExport asset metrics
Parameters
- queries *ExportAssetMetricsJSONQueries - Queries to be sent with the request
Return Type
- record { AssetMetricsResponse... }|error - asset metrics
getOrganization
function getOrganization(map<string|string[]> headers, *GetOrganizationQueries queries) returns Organization|errorGet organization details
Parameters
- queries *GetOrganizationQueries - Queries to be sent with the request
Return Type
- Organization|error - organization details
updateOrganization
function updateOrganization(OrgOptions payload, map<string|string[]> headers, *UpdateOrganizationQueries queries) returns Organization|errorUpdate organization details
Parameters
- payload OrgOptions - organization options
- queries *UpdateOrganizationQueries - Queries to be sent with the request
Return Type
- Organization|error - organization details
getKey
Get API key details
Parameters
- queries *GetKeyQueries - Queries to be sent with the request
removeKey
function removeKey(map<string|string[]> headers, *RemoveKeyQueries queries) returns error?Remove the current API key
Parameters
- queries *RemoveKeyQueries - Queries to be sent with the request
Return Type
- error? - empty response
rotateKey
Rotate the API key secret and return the updated key
Parameters
- queries *RotateKeyQueries - Queries to be sent with the request
getAgents
Get all agents. Legacy path for /org/explorers
Parameters
- queries *GetAgentsQueries - Queries to be sent with the request
getAgent
function getAgent(string agentId, map<string|string[]> headers, *GetAgentQueries queries) returns Agent|errorGet details for a single agent. Legacy path for /org/explorers/{explorer_id}
Parameters
- agentId string - UUID of the agent
- queries *GetAgentQueries - Queries to be sent with the request
removeAgent
function removeAgent(string agentId, map<string|string[]> headers, *RemoveAgentQueries queries) returns error?Remove and uninstall an agent. Legacy path for /org/explorers/{explorer_id}
Parameters
- agentId string - UUID of the agent to remove
- queries *RemoveAgentQueries - Queries to be sent with the request
Return Type
- error? - empty response
updateAgentSettings
function updateAgentSettings(string agentId, AgentPatchedSettings payload, map<string|string[]> headers, *UpdateAgentSettingsQueries queries) returns Agent|errorUpdate the settings associated with the agent. Legacy path for /org/explorers/{explorer_id}
Parameters
- agentId string - UUID of the agent to update
- payload AgentPatchedSettings - The updated settings to apply to the agent
- queries *UpdateAgentSettingsQueries - Queries to be sent with the request
upgradeAgent
function upgradeAgent(string agentId, map<string|string[]> headers, *UpgradeAgentQueries queries) returns error?Force an agent to update and restart. Legacy path for /org/explorers/{explorer_id}/update
Parameters
- agentId string - UUID of the agent to update
- queries *UpgradeAgentQueries - Queries to be sent with the request
Return Type
- error? - empty response
getExplorers
function getExplorers(map<string|string[]> headers, *GetExplorersQueries queries) returns Explorer[]|errorGet all explorers
Parameters
- queries *GetExplorersQueries - Queries to be sent with the request
getExplorer
function getExplorer(string explorerId, map<string|string[]> headers, *GetExplorerQueries queries) returns Explorer|errorGet details for a single explorer.
Parameters
- explorerId string - UUID of the explorer
- queries *GetExplorerQueries - Queries to be sent with the request
removeExplorer
function removeExplorer(string explorerId, map<string|string[]> headers, *RemoveExplorerQueries queries) returns error?Remove and uninstall an explorer
Parameters
- explorerId string - UUID of the explorer to remove
- queries *RemoveExplorerQueries - Queries to be sent with the request
Return Type
- error? - empty response
updateExplorerSettings
function updateExplorerSettings(string explorerId, ExplorerPatchedSettings payload, map<string|string[]> headers, *UpdateExplorerSettingsQueries queries) returns Explorer|errorUpdate the settings associated with the Explorer
Parameters
- explorerId string - UUID of the explorer to update
- payload ExplorerPatchedSettings - The updated settings to apply to the Explorer
- queries *UpdateExplorerSettingsQueries - Queries to be sent with the request
upgradeExplorer
function upgradeExplorer(string explorerId, map<string|string[]> headers, *UpgradeExplorerQueries queries) returns error?Force an explorer to update and restart
Parameters
- explorerId string - UUID of the explorer to update
- queries *UpgradeExplorerQueries - Queries to be sent with the request
Return Type
- error? - empty response
getHostedZones
function getHostedZones(map<string|string[]> headers, *GetHostedZonesQueries queries) returns HostedZone[]|errorGet all hosted zones
Parameters
- queries *GetHostedZonesQueries - Queries to be sent with the request
Return Type
- HostedZone[]|error - array of hosted zones
getHostedZone
function getHostedZone(string hostedZoneId, map<string|string[]> headers, *GetHostedZoneQueries queries) returns HostedZone|errorGet details for a single hosted zone.
Parameters
- hostedZoneId string - UUID of the hosted zone
- queries *GetHostedZoneQueries - Queries to be sent with the request
Return Type
- HostedZone|error - hosted zone details
getSites
Get all sites
Parameters
- queries *GetSitesQueries - Queries to be sent with the request
createSite
function createSite(SiteOptions payload, map<string|string[]> headers, *CreateSiteQueries queries) returns Site|errorCreate a new site
Parameters
- payload SiteOptions - site definition
- queries *CreateSiteQueries - Queries to be sent with the request
getSite
function getSite(string siteId, map<string|string[]> headers, *GetSiteQueries queries) returns Site|errorGet site details
Parameters
- siteId string - UUID or name of the site
- queries *GetSiteQueries - Queries to be sent with the request
removeSite
function removeSite(string siteId, map<string|string[]> headers, *RemoveSiteQueries queries) returns error?Remove a site and associated assets
Parameters
- siteId string - UUID or name of the site to remove
- queries *RemoveSiteQueries - Queries to be sent with the request
Return Type
- error? - empty response
updateSite
function updateSite(string siteId, SiteOptions payload, map<string|string[]> headers, *UpdateSiteQueries queries) returns Site|errorUpdate a site definition
Parameters
- siteId string - UUID or name of the site to update
- payload SiteOptions - site object
- queries *UpdateSiteQueries - Queries to be sent with the request
importScanData
function importScanData(string siteId, byte[] payload, map<string|string[]> headers, *ImportScanDataQueries queries) returns Task|errorImport a scan data file into a site
Parameters
- siteId string - UUID or name of the site to import scan data into
- payload byte[] - Scan data file to import into the site
- queries *ImportScanDataQueries - Queries to be sent with the request
importNessusScanData
function importNessusScanData(string siteId, byte[] payload, map<string|string[]> headers, *ImportNessusScanDataQueries queries) returns Task|errorImport a Nessus scan data file into a site
Parameters
- siteId string - UUID or name of the site to import Nessus scan data into
- payload byte[] - Nessus scan data file to import into the site
- queries *ImportNessusScanDataQueries - Queries to be sent with the request
importPacketData
function importPacketData(string siteId, byte[] payload, map<string|string[]> headers, *ImportPacketDataQueries queries) returns Task|errorImport a packet capture file into a site
Parameters
- siteId string - UUID or name of the site to import packet capture into
- payload byte[] - Packet capture file to import into the site
- queries *ImportPacketDataQueries - Queries to be sent with the request
createScan
function createScan(string siteId, ScanOptions payload, map<string|string[]> headers, *CreateScanQueries queries) returns Task|errorCreate a scan task for a given site
Parameters
- siteId string - UUID or name of the site to scan
- payload ScanOptions - Scan task options, targets and scan settings for the site
- queries *CreateScanQueries - Queries to be sent with the request
createSample
function createSample(string siteId, SampleOptions payload, map<string|string[]> headers, *CreateSampleQueries queries) returns Task|errorCreate a traffic sampling task for a given site
Parameters
- siteId string - UUID or name of the site to scan
- payload SampleOptions - Traffic sampling task options for the site
- queries *CreateSampleQueries - Queries to be sent with the request
getAssets
Get all assets
Parameters
- queries *GetAssetsQueries - Queries to be sent with the request
getAsset
function getAsset(string assetId, map<string|string[]> headers, *GetAssetQueries queries) returns Asset|errorGet asset details
Parameters
- assetId string - UUID of the asset to retrieve
- queries *GetAssetQueries - Queries to be sent with the request
removeAsset
function removeAsset(string assetId, map<string|string[]> headers, *RemoveAssetQueries queries) returns error?Remove an asset
Parameters
- assetId string - UUID of the asset to remove
- queries *RemoveAssetQueries - Queries to be sent with the request
Return Type
- error? - empty response
removeBulkAssets
function removeBulkAssets(AssetIDs payload, map<string|string[]> headers, *RemoveBulkAssetsQueries queries) returns error?Removes multiple assets by ID
Parameters
- payload AssetIDs - list of asset IDs to remove
- queries *RemoveBulkAssetsQueries - Queries to be sent with the request
Return Type
- error? - empty response
updateAssetComments
function updateAssetComments(string assetId, AssetComments payload, map<string|string[]> headers, *UpdateAssetCommentsQueries queries) returns Asset|errorUpdate asset comments
Parameters
- assetId string - UUID of the asset to update
- payload AssetComments - comments to apply to the asset
- queries *UpdateAssetCommentsQueries - Queries to be sent with the request
updateAssetTags
function updateAssetTags(string assetId, AssetTags payload, map<string|string[]> headers, *UpdateAssetTagsQueries queries) returns Asset|errorUpdate asset tags
Parameters
- assetId string - UUID of the asset to update
- payload AssetTags - tags to apply to the asset
- queries *UpdateAssetTagsQueries - Queries to be sent with the request
updateAssetCriticality
function updateAssetCriticality(string assetId, AssetCriticality payload, map<string|string[]> headers, *UpdateAssetCriticalityQueries queries) returns Asset|errorUpdate asset criticality
Parameters
- assetId string - UUID of the asset to update
- payload AssetCriticality - comments to apply to the asset
- queries *UpdateAssetCriticalityQueries - Queries to be sent with the request
mergeAssets
function mergeAssets(AssetIDs payload, map<string|string[]> headers, *MergeAssetsQueries queries) returns error?Merge multiple assets
Parameters
- payload AssetIDs - List of Asset IDs to merge
- queries *MergeAssetsQueries - Queries to be sent with the request
Return Type
- error? - Summary of operation results
updateBulkAssetTags
function updateBulkAssetTags(AssetTagsWithSearch payload, map<string|string[]> headers, *UpdateBulkAssetTagsQueries queries) returns error?Update tags across multiple assets based on a search query
Parameters
- payload AssetTagsWithSearch - search query to filter and tags to apply
- queries *UpdateBulkAssetTagsQueries - Queries to be sent with the request
Return Type
- error? - Summary of operation results
clearBulkAssetTags
function clearBulkAssetTags(Search payload, map<string|string[]> headers, *ClearBulkAssetTagsQueries queries) returns error?Clear all tags across multiple assets based on a search query
Parameters
- payload Search - search query to filter
- queries *ClearBulkAssetTagsQueries - Queries to be sent with the request
Return Type
- error? - Summary of operation results
updateBulkAssetCriticality
function updateBulkAssetCriticality(AssetCriticalityWithSearch payload, map<string|string[]> headers, *UpdateBulkAssetCriticalityQueries queries) returns error?Update criticality across multiple assets based on a search query
Parameters
- payload AssetCriticalityWithSearch - search query to filter and criticality to apply
- queries *UpdateBulkAssetCriticalityQueries - Queries to be sent with the request
Return Type
- error? - Summary of operation results
updateAssetOwners
function updateAssetOwners(string assetId, AssetOwnerships payload, map<string|string[]> headers, *UpdateAssetOwnersQueries queries) returns Asset|errorUpdate asset owners
Parameters
- assetId string - UUID of the asset to update
- payload AssetOwnerships - list of ownerships to apply to the asset
- queries *UpdateAssetOwnersQueries - Queries to be sent with the request
updateBulkAssetOwners
function updateBulkAssetOwners(AssetOwnershipsWithSearch payload, map<string|string[]> headers, *UpdateBulkAssetOwnersQueries queries) returns UpdatedAssetCountResponse|errorUpdate asset owners across multiple assets based on a search query
Parameters
- payload AssetOwnershipsWithSearch - search query to filter and ownerships to apply
- queries *UpdateBulkAssetOwnersQueries - Queries to be sent with the request
Return Type
- UpdatedAssetCountResponse|error - updated asset count
clearBulkAssetOwners
function clearBulkAssetOwners(Search payload, map<string|string[]> headers, *ClearBulkAssetOwnersQueries queries) returns UpdatedAssetCountResponse|errorClear all owners across multiple assets based on a search query
Parameters
- payload Search - search query to filter
- queries *ClearBulkAssetOwnersQueries - Queries to be sent with the request
Return Type
- UpdatedAssetCountResponse|error - updated asset count
bulkRemoveCustomIntegration
function bulkRemoveCustomIntegration(string customIntegrationId, AssetIDs payload, map<string|string[]> headers) returns error?Remove custom integration from a list of assets
Parameters
- customIntegrationId string - UUID of the custom integration
- payload AssetIDs - list of asset IDs to remove
Return Type
- error? - empty response
removeCustomIntegration
function removeCustomIntegration(string assetId, string customIntegrationId, map<string|string[]> headers) returns error?Remove single custom integration from asset
Parameters
- assetId string - UUID of the asset to update
- customIntegrationId string - UUID of the custom integration
Return Type
- error? - empty response
removeAssetSource
function removeAssetSource(string assetId, string sourceId, map<string|string[]> headers) returns error?Remove single source from asset
Return Type
- error? - empty response
getOrgCustomIntegrations
function getOrgCustomIntegrations(map<string|string[]> headers) returns CustomIntegration|errorGet all custom integrations
Return Type
- CustomIntegration|error - An array of all custom integrations
getOrgCustomIntegration
function getOrgCustomIntegration(string customIntegrationId, map<string|string[]> headers) returns CustomIntegration|errorGet single custom integration
Parameters
- customIntegrationId string - UUID of the custom integration
Return Type
- CustomIntegration|error - The custom integration with given ID
getServices
function getServices(map<string|string[]> headers, *GetServicesQueries queries) returns Service[]|errorGet all services
Parameters
- queries *GetServicesQueries - Queries to be sent with the request
getService
function getService(string serviceId, map<string|string[]> headers, *GetServiceQueries queries) returns Service|errorGet service details
Parameters
- serviceId string - UUID of the service to retrieve
- queries *GetServiceQueries - Queries to be sent with the request
removeService
function removeService(string serviceId, map<string|string[]> headers, *RemoveServiceQueries queries) returns error?Remove a service
Parameters
- serviceId string - UUID of the service to remove
- queries *RemoveServiceQueries - Queries to be sent with the request
Return Type
- error? - empty response
getWirelessLANs
function getWirelessLANs(map<string|string[]> headers, *GetWirelessLANsQueries queries) returns Wireless[]|errorGet all wireless LANs
Parameters
- queries *GetWirelessLANsQueries - Queries to be sent with the request
getWirelessLAN
function getWirelessLAN(string wirelessId, map<string|string[]> headers, *GetWirelessLANQueries queries) returns Wireless|errorGet wireless LAN details
Parameters
- wirelessId string - UUID of the wireless LAN to retrieve
- queries *GetWirelessLANQueries - Queries to be sent with the request
removeWirelessLAN
function removeWirelessLAN(string wirelessId, map<string|string[]> headers, *RemoveWirelessLANQueries queries) returns error?Remove a wireless LAN
Parameters
- wirelessId string - UUID of the wireless LAN to remove
- queries *RemoveWirelessLANQueries - Queries to be sent with the request
Return Type
- error? - empty response
getTasks
Get all tasks (last 1000)
Parameters
- queries *GetTasksQueries - Queries to be sent with the request
getTask
function getTask(string taskId, map<string|string[]> headers, *GetTaskQueries queries) returns Task|errorGet task details
Parameters
- taskId string - UUID of the task to retrieve
- queries *GetTaskQueries - Queries to be sent with the request
updateTask
function updateTask(string taskId, TaskOptions payload, map<string|string[]> headers, *UpdateTaskQueries queries) returns Task|errorUpdate task parameters
Parameters
- taskId string - UUID of the task to update
- payload TaskOptions - task object
- queries *UpdateTaskQueries - Queries to be sent with the request
getTaskScanData
function getTaskScanData(string taskId, map<string|string[]> headers, *GetTaskScanDataQueries queries) returns Response|errorReturns a temporary task scan data url
Parameters
- taskId string - UUID of the task
- queries *GetTaskScanDataQueries - Queries to be sent with the request
getTaskChangeReport
function getTaskChangeReport(string taskId, map<string|string[]> headers, *GetTaskChangeReportQueries queries) returns Response|errorReturns a temporary task change report data url
Parameters
- taskId string - UUID of the task
- queries *GetTaskChangeReportQueries - Queries to be sent with the request
getTaskLog
function getTaskLog(string taskId, map<string|string[]> headers, *GetTaskLogQueries queries) returns Response|errorReturns a temporary task log data url
Parameters
- taskId string - UUID of the task
- queries *GetTaskLogQueries - Queries to be sent with the request
stopTask
function stopTask(string taskId, map<string|string[]> headers, *StopTaskQueries queries) returns Task|errorSignal that a task should be stopped or canceled.This will also remove recurring and scheduled tasks
Parameters
- taskId string - UUID of the task to stop
- queries *StopTaskQueries - Queries to be sent with the request
hideTask
function hideTask(string taskId, map<string|string[]> headers, *HideTaskQueries queries) returns Task|errorSignal that a completed task should be hidden
Parameters
- taskId string - UUID of the task to hide
- queries *HideTaskQueries - Queries to be sent with the request
getAccountOrganizations
function getAccountOrganizations(map<string|string[]> headers, *GetAccountOrganizationsQueries queries) returns Organization[]|errorGet all organization details
Parameters
- queries *GetAccountOrganizationsQueries - Queries to be sent with the request
Return Type
- Organization[]|error - array of organizations
createAccountOrganization
function createAccountOrganization(OrgOptions payload, map<string|string[]> headers) returns Organization|errorCreate a new organization
Parameters
- payload OrgOptions - organization definition
Return Type
- Organization|error - organization details
getAccountOrganization
function getAccountOrganization(string orgId, map<string|string[]> headers) returns Organization|errorGet account organization details
Parameters
- orgId string - UUID of the organization to retrieve
Return Type
- Organization|error - organization information
removeAccountOrganization
Remove this organization
Parameters
- orgId string - UUID of the organization to retrieve
Return Type
- error? - empty response
updateAccountOrganization
function updateAccountOrganization(string orgId, OrgOptions payload, map<string|string[]> headers) returns Organization|errorUpdate account organization details
Parameters
- orgId string - UUID of the organization to retrieve
- payload OrgOptions - organization options
Return Type
- Organization|error - organization details
deleteAccountOrgExportTokenLegacy
function deleteAccountOrgExportTokenLegacy(string orgId, map<string|string[]> headers) returns error?Removes the legacy export token from the specified organization
Parameters
- orgId string - UUID of the organization to retrieve
Return Type
- error? - empty response
Deprecated
rotateAccountOrgExportTokenLegacy
function rotateAccountOrgExportTokenLegacy(string orgId, map<string|string[]> headers) returns ExportToken|errorRotates the legacy organization export token and returns the updated token
Parameters
- orgId string - UUID of the organization to retrieve
Return Type
- ExportToken|error - export token details
Deprecated
getAccountOrganizationExportTokens
function getAccountOrganizationExportTokens(string orgId, map<string|string[]> headers) returns ExportToken[]|errorGet all active export tokens for an organization
Parameters
- orgId string - UUID of the organization to retrieve export tokens for
Return Type
- ExportToken[]|error - array of export tokens
createAccountOrganizationExportToken
function createAccountOrganizationExportToken(string orgId, ExportTokenOptions payload, map<string|string[]> headers) returns ExportToken|errorCreate a new export token for an organization
Parameters
- orgId string - UUID of the organization to create an export token for
- payload ExportTokenOptions - export token parameters
Return Type
- ExportToken|error - export token details
getAccountOrganizationExportToken
function getAccountOrganizationExportToken(string orgId, string keyId, map<string|string[]> headers) returns ExportToken|errorGet export token details
Parameters
- orgId string - UUID of the organization to retrieve
- keyId string - UUID of the export token ID to retrieve
Return Type
- ExportToken|error - export token details
deleteAccountOrganizationExportToken
function deleteAccountOrganizationExportToken(string orgId, string keyId, map<string|string[]> headers) returns error?Removes the export token from the specified organization
Parameters
- orgId string - UUID of the organization to retrieve
- keyId string - UUID of the export token ID to remove
Return Type
- error? - empty response
rotateAccountOrganizationExportToken
function rotateAccountOrganizationExportToken(string orgId, string keyId, map<string|string[]> headers) returns ExportToken|errorRotates an organization export token and returns the updated token
Parameters
- orgId string - UUID of the organization to retrieve
- keyId string - UUID of the export token ID to rotate
Return Type
- ExportToken|error - export token details
getAccountLicense
Get license details
getAccountSites
function getAccountSites(map<string|string[]> headers, *GetAccountSitesQueries queries) returns Site[]|errorGet all sites details across all organizations
Parameters
- queries *GetAccountSitesQueries - Queries to be sent with the request
getAccountCredentials
function getAccountCredentials(map<string|string[]> headers, *GetAccountCredentialsQueries queries) returns Credential[]|errorGet all account credentials
Parameters
- queries *GetAccountCredentialsQueries - Queries to be sent with the request
Return Type
- Credential[]|error - array of credentials
createAccountCredential
function createAccountCredential(CredentialOptions payload, map<string|string[]> headers) returns Credential|errorCreate a new credential
Parameters
- payload CredentialOptions - credential parameters
Return Type
- Credential|error - credential details
getAccountCredential
function getAccountCredential(string credentialId, map<string|string[]> headers) returns Credential|errorGet credential details
Parameters
- credentialId string - UUID of the credential to retrieve
Return Type
- Credential|error - credential details
removeAccountCredential
Remove this credential
Parameters
- credentialId string - UUID of the credential to delete
Return Type
- error? - empty response
getAccountKeys
Get all active API keys
createAccountKey
Create a new key
Parameters
- payload APIKeyOptions - key parameters
getAccountKey
Get key details
Parameters
- keyId string - UUID of the key to retrieve
removeAccountKey
Remove this key
Parameters
- keyId string - UUID of the key to retrieve
Return Type
- error? - empty response
rotateAccountKey
Rotates the key secret
Parameters
- keyId string - UUID of the key to retrieve
exportEventsJSON
function exportEventsJSON(map<string|string[]> headers, *ExportEventsJSONQueries queries) returns ExportEventsResponse|errorSystem event log as JSON
Parameters
- queries *ExportEventsJSONQueries - Queries to be sent with the request
Return Type
- ExportEventsResponse|error - Filtered event results. <ul><li>When the
page_sizequery parameter is not set in the request, the response will be a JSON array of events.</li><li>When thepage_sizequery parameter is present in the request, the response will be an object with an events array and anext_keystring for pagination.</li></ul>
exportEventsJSONL
function exportEventsJSONL(map<string|string[]> headers, *ExportEventsJSONLQueries queries) returns Event[]|errorSystem event log as JSON line-delimited
Parameters
- queries *ExportEventsJSONLQueries - Queries to be sent with the request
getAccountTasks
function getAccountTasks(map<string|string[]> headers, *GetAccountTasksQueries queries) returns Task[]|errorGet all task details across all organizations (up to 1000)
Parameters
- queries *GetAccountTasksQueries - Queries to be sent with the request
getAccountScanTemplates
function getAccountScanTemplates(map<string|string[]> headers, *GetAccountScanTemplatesQueries queries) returns ScanTemplate[]|errorGet all scan templates across all organizations (up to 1000)
Parameters
- queries *GetAccountScanTemplatesQueries - Queries to be sent with the request
Return Type
- ScanTemplate[]|error - array of scan templates
updateAccountScanTemplate
function updateAccountScanTemplate(ScanTemplate payload, map<string|string[]> headers) returns ScanTemplate|errorUpdate scan template
Parameters
- payload ScanTemplate - Scan template identifier and updated settings
Return Type
- ScanTemplate|error - scan template
createAccountScanTemplate
function createAccountScanTemplate(ScanTemplateOptions payload, map<string|string[]> headers) returns ScanTemplate|errorCreate a new scan template
Parameters
- payload ScanTemplateOptions - Scan template name, description and scan settings
Return Type
- ScanTemplate|error - scan template
getAccountScanTemplate
function getAccountScanTemplate(string scanTemplateId, map<string|string[]> headers) returns ScanTemplate|errorGet scan template details
Parameters
- scanTemplateId string - UUID of the scan template to retrieve
Return Type
- ScanTemplate|error - scan template
removeAccountScanTemplate
function removeAccountScanTemplate(string scanTemplateId, map<string|string[]> headers) returns ScanTemplate|errorRemove scan template
Parameters
- scanTemplateId string - UUID of the scan template to remove
Return Type
- ScanTemplate|error - scan template
getAccountAgents
function getAccountAgents(map<string|string[]> headers, *GetAccountAgentsQueries queries) returns Agent[]|errorGet all agents across all organizations
Parameters
- queries *GetAccountAgentsQueries - Queries to be sent with the request
getAccountUsers
Get all users
createAccountUser
Create a new user account
Parameters
- payload UserOptions - user parameters
createAccountUserInvite
function createAccountUserInvite(UserInviteOptions payload, map<string|string[]> headers) returns User|errorCreate a new user account and send an email invite
Parameters
- payload UserInviteOptions - user invite parameters
getAccountUser
Get user details
Parameters
- userId string - UUID of the user to retrieve
removeAccountUser
Remove this user
Parameters
- userId string - UUID of the user to delete
Return Type
- error? - empty response
updateAccountUser
function updateAccountUser(string userId, UserOptions payload, map<string|string[]> headers) returns User|errorUpdate a user's details
resetAccountUserMFA
Resets the user's MFA tokens
Parameters
- userId string - UUID of the user to retrieve
resetAccountUserLockout
Resets the user's lockout status
Parameters
- userId string - UUID of the user to retrieve
resetAccountUserPassword
Sends the user a password reset email
Parameters
- userId string - UUID of the user to retrieve
getAccountGroups
Get all groups
updateAccountGroup
Update an existing group
Parameters
- payload GroupPut - Group identifier and updated name, description or permissions
createAccountGroup
Create a new group
Parameters
- payload GroupPost - Group name, description and organization permissions
getAccountGroup
Get group details
Parameters
- groupId string - UUID of the group
removeAccountGroup
Remove this group
Parameters
- groupId string - UUID of the group
Return Type
- error? - empty response
getAccountGroupMappings
function getAccountGroupMappings(map<string|string[]> headers) returns GroupMapping|errorGet all SSO group mappings
Return Type
- GroupMapping|error - group mapping information
updateAccountGroupMapping
function updateAccountGroupMapping(GroupMapping payload, map<string|string[]> headers) returns GroupMapping|errorUpdate an existing SSO group mapping
Parameters
- payload GroupMapping - SSO group mapping identifier and updated mapping details
Return Type
- GroupMapping|error - group information
createAccountGroupMapping
function createAccountGroupMapping(GroupMapping payload, map<string|string[]> headers) returns GroupMapping|errorCreate a new SSO group mapping
Parameters
- payload GroupMapping - SSO group attribute and the group to map it to
Return Type
- GroupMapping|error - group information
getAccountGroupMapping
function getAccountGroupMapping(string groupMappingId, map<string|string[]> headers) returns GroupMapping|errorGet SSO group mapping details
Parameters
- groupMappingId string - UUID of the SSO group mapping
Return Type
- GroupMapping|error - group information
removeAccountGroupMapping
function removeAccountGroupMapping(string groupMappingId, map<string|string[]> headers) returns error?Remove this SSO group mapping
Parameters
- groupMappingId string - UUID of the SSO group mapping
Return Type
- error? - empty response
getAccountAssetOwnershipTypes
function getAccountAssetOwnershipTypes(map<string|string[]> headers) returns AssetOwnershipType[]|errorGet all asset ownership types
Return Type
- AssetOwnershipType[]|error - array of asset ownership types
updateAccountAssetOwnershipTypes
function updateAccountAssetOwnershipTypes(AssetOwnershipType[] payload, map<string|string[]> headers) returns AssetOwnershipType[]|errorUpdate asset ownership types
Parameters
- payload AssetOwnershipType[] - array of asset ownership types
Return Type
- AssetOwnershipType[]|error - array of asset ownership types
createAccountAssetOwnershipTypes
function createAccountAssetOwnershipTypes(AssetOwnershipTypePost[] payload, map<string|string[]> headers) returns AssetOwnershipType[]|errorCreate new asset ownership types
Parameters
- payload AssetOwnershipTypePost[] - array of asset ownership types
Return Type
- AssetOwnershipType[]|error - array of asset ownership types
deleteAccountAssetOwnershipTypes
function deleteAccountAssetOwnershipTypes(string[] payload, map<string|string[]> headers) returns AssetOwnershipType[]|errorDelete asset ownership types
Parameters
- payload string[] - Array of ids
Return Type
- AssetOwnershipType[]|error - array of remaining asset ownership types
deleteAccountAssetOwnershipType
function deleteAccountAssetOwnershipType(string ownershipTypeId, map<string|string[]> headers) returns AssetOwnershipType[]|errorDelete a single asset ownership type
Parameters
- ownershipTypeId string - UUID of the asset ownership type
Return Type
- AssetOwnershipType[]|error - array of remaining asset ownership types
updateAccountAssetOwnershipType
function updateAccountAssetOwnershipType(string ownershipTypeId, AssetOwnershipTypePost payload, map<string|string[]> headers) returns AssetOwnershipType|errorUpdate a single asset ownership type
Parameters
- ownershipTypeId string - UUID of the asset ownership type
- payload AssetOwnershipTypePost - Updated reference, display and ownership type fields
Return Type
- AssetOwnershipType|error - updated asset ownership type
getAccountCustomIntegrations
function getAccountCustomIntegrations(map<string|string[]> headers) returns CustomIntegration|errorGet all account custom integrations
Return Type
- CustomIntegration|error - An array of all custom integrations
createAccountCustomIntegration
function createAccountCustomIntegration(NewCustomIntegration payload, map<string|string[]> headers) returns CustomIntegration|errorCreate a new custom integration
Parameters
- payload NewCustomIntegration - The description of the custom integration
Return Type
- CustomIntegration|error - The custom integration created
getAccountCustomIntegration
function getAccountCustomIntegration(string customIntegrationId, map<string|string[]> headers) returns CustomIntegration|errorGet single account custom integration
Parameters
- customIntegrationId string - UUID of the custom integration
Return Type
- CustomIntegration|error - The custom integration with given ID
createAccountCustomIntegrationAndID
function createAccountCustomIntegrationAndID(string customIntegrationId, NewCustomIntegration payload, map<string|string[]> headers) returns CustomIntegration|errorReplace custom integration at provided ID
Parameters
- customIntegrationId string - UUID of the custom integration
- payload NewCustomIntegration - single custom integration type
Return Type
- CustomIntegration|error - The updated custom integration
deleteAccountCustomIntegration
function deleteAccountCustomIntegration(string customIntegrationId, map<string|string[]> headers) returns CustomIntegration|errorDelete an custom integration
Parameters
- customIntegrationId string - UUID of the custom integration
Return Type
- CustomIntegration|error - The deleted custom integration
updateAccountCustomIntegration
function updateAccountCustomIntegration(string customIntegrationId, BaseCustomIntegration payload, map<string|string[]> headers) returns CustomIntegration|errorUpdate a single custom integration
Parameters
- customIntegrationId string - UUID of the custom integration
- payload BaseCustomIntegration - Updated custom integration name, description and icon
Return Type
- CustomIntegration|error - The updated custom integration
getAPIToken
function getAPIToken(ClientIDForm payload, map<string|string[]> headers) returns AccessToken|errorGenerate an access token using an API client
Parameters
- payload ClientIDForm - Client ID and secret
Return Type
- AccessToken|error - An access token
rotateAPIToken
Rotate the API client secret
Parameters
- payload ClientIDForm - Client ID and secret
splunkAssetSyncCreatedJSON
function splunkAssetSyncCreatedJSON(map<string|string[]> headers, *SplunkAssetSyncCreatedJSONQueries queries) returns AssetsWithCheckpoint|errorExports the asset inventory in a sync-friendly manner using created_at as a checkpoint. Requires the Splunk entitlement.
Parameters
- queries *SplunkAssetSyncCreatedJSONQueries - Queries to be sent with the request
Return Type
- AssetsWithCheckpoint|error - filtered asset results with a checkpoint wrapper
splunkAssetSyncUpdatedJSON
function splunkAssetSyncUpdatedJSON(map<string|string[]> headers, *SplunkAssetSyncUpdatedJSONQueries queries) returns AssetsWithCheckpoint|errorExports the asset inventory in a sync-friendly manner using updated_at as a checkpoint. Requires the Splunk entitlement.
Parameters
- queries *SplunkAssetSyncUpdatedJSONQueries - Queries to be sent with the request
Return Type
- AssetsWithCheckpoint|error - filtered asset results with a checkpoint wrapper
snowExportAssetsCSV
function snowExportAssetsCSV(map<string|string[]> headers, *SnowExportAssetsCSVQueries queries) returns string|errorExport an asset inventory as CSV for ServiceNow integration
Parameters
- queries *SnowExportAssetsCSVQueries - Queries to be sent with the request
snowExportAssetsJSON
function snowExportAssetsJSON(map<string|string[]> headers, *SnowExportAssetsJSONQueries queries) returns AssetServiceNow[]|errorExports the asset inventory as JSON
Parameters
- queries *SnowExportAssetsJSONQueries - Queries to be sent with the request
Return Type
- AssetServiceNow[]|error - filtered asset results
snowExportServicesCSV
function snowExportServicesCSV(map<string|string[]> headers, *SnowExportServicesCSVQueries queries) returns string|errorExport a service inventory as CSV for ServiceNow integration
Parameters
- queries *SnowExportServicesCSVQueries - Queries to be sent with the request
snowServiceGraphExportAssetsJSON
function snowServiceGraphExportAssetsJSON(map<string|string[]> headers, *SnowServiceGraphExportAssetsJSONQueries queries) returns AssetServiceNow[]|errorExports the asset inventory as ServiceGraph JSON
Parameters
- queries *SnowServiceGraphExportAssetsJSONQueries - Queries to be sent with the request
Return Type
- AssetServiceNow[]|error - filtered asset results
exportAssetsCiscoCSV
function exportAssetsCiscoCSV(map<string|string[]> headers, *ExportAssetsCiscoCSVQueries queries) returns string|errorCisco serial number and model name export for Cisco Smart Net Total Care Service.
Parameters
- queries *ExportAssetsCiscoCSVQueries - Queries to be sent with the request
Records
runzero: AccessToken
Fields
- accessToken? string -
- tokenType? string -
- expiresIn? int -
runzero: Agent
A deployed service which performs scan tasks. Explorers may be referred to by their legacy name, Agents
Fields
- os? string - Operating system of the explorer host
- systemInfo? record {} - System information reported by the explorer
- deactivatedAt? int - Time the explorer was deactivated, as a Unix timestamp
- createdAt? int - Time the explorer was created, as a Unix timestamp
- lastCheckin? int - Time of the last explorer check-in, as a Unix timestamp
- version? string - Version of the explorer software
- clientId? string - Client ID of the explorer
- hostId? string - ID of the host the explorer runs on
- internalIp? anydata - Internal IP address of the explorer
- connected? boolean - Whether the explorer is currently connected
- hubId? string - ID of the hub the explorer is connected to
- inactive? boolean - Whether the explorer is inactive
- updatedAt? int - Time the explorer was last updated, as a Unix timestamp
- organizationId? string - ID of the organization the explorer belongs to
- name? string - Name of the explorer
- siteId? string - ID of the site the explorer is assigned to
- id string - Unique ID of the explorer
- arch? string - CPU architecture of the explorer host
- externalIp? string - External IP address of the explorer
runzero: AgentPatchedSettings
Fields
- settings? AgentPatchedSettingsSettings -
- siteId? string -
runzero: AgentPatchedSettingsSettings
Fields
- maxConcurrentScans? int -
runzero: APIClient
Fields
- apiClientId? string -
- apiClientSecret? string -
runzero: APIKey
Fields
- usageLimit? int -
- createdAt? int -
- counter? int -
- 'type? string -
- createdBy? string -
- clientId? string -
- token? string -
- usageToday? int -
- lastUsedAt? int -
- inactive? boolean -
- organizationId? string -
- lastUsedUa? string -
- comment? string -
- id string -
- lastUsedIp? string -
runzero: APIKeyOptions
Fields
- organizationId? string -
- comment? string -
runzero: Asset
Fields
- addresses? AssetAddresses[] -
- lastSeen? int -
- agentName? string -
- 'type? string -
- vulnerabilityCount? decimal -
- lastAgentId? string -
- hw? string -
- lowestRtt? int -
- scanned? boolean -
- id string -
- addressesExtra? AssetAddressesExtra[] -
- domains? string[] -
- newestMacVendor? string -
- lowestTtl? int -
- newestMac? string -
- serviceProtocols? string[] -
- tags? record { string... } -
- siteName? string -
- serviceCountIcmp? int -
- serviceProducts? string[] -
- organizationId? string -
- macs? string[] -
- siteId? string -
- newestMacAge? int -
- firstSeen? int -
- alive? boolean -
- sources? string[] - Sources used for asset data
- credentials? record { record { boolean... }... } -
- createdAt? int -
- serviceCountUdp? int -
- macVendors? string[] -
- servicePortsUdp? string[] -
- updatedAt? int -
- riskRank? decimal - -1 = none, 0 = info, 4 = critical
- detectedBy? string -
- orgName? string -
- eolOsExt? decimal - OS extended support EOL date
- comments? string -
- os? string -
- lastTaskId? string -
- osVersion? string -
- serviceCount? int -
- findingCount? decimal -
- serviceCountTcp? int -
- eolOs? decimal - OS main EOL date
- serviceCountArp? int -
- services? record { record { string... }... } -
- servicePortsTcp? string[] -
- names? string[] -
- rtts? record {} -
- risk? string -
- attributes? record { string... } -
runzero: AssetComments
Fields
- comments string -
runzero: AssetCriticality
Fields
- criticality string -
runzero: AssetCriticalityWithSearch
Fields
- search string -
- criticality string -
runzero: AssetIDs
Fields
- assetIds string[] -
runzero: AssetMetricsResponse
Fields
- siteId? string -
- metrics? record {} -
runzero: AssetOwnerships
Fields
- ownerships? AssetOwnershipsOwnerships[] -
runzero: AssetOwnershipsOwnerships
Fields
- owner? string -
- ownershipTypeId? string -
runzero: AssetOwnershipsWithSearch
Fields
- search string -
- ownerships AssetOwnershipsOwnerships[] -
runzero: AssetOwnershipType
Fields
- reference? int -
- hidden? boolean -
- name string -
- id string -
- 'order? int -
runzero: AssetOwnershipTypePost
Fields
- reference? int -
- hidden? boolean -
- name string -
- 'order? int -
runzero: AssetServiceNow
Fields
- macManufacturer? string -
- hwVersion? string -
- alive? boolean -
- serviceCountUdp? int -
- assetId string -
- macVendors? string -
- 'type? string -
- lastDiscovered? string -
- sysClassName? string -
- lowestRtt? int -
- firstDiscovered? string -
- detectedBy? string -
- macAddress? string -
- addressesScope? string -
- addressesExtra? string -
- osVendor? string -
- lastUpdated? string -
- comments? string -
- osProduct? string -
- osVersion? string -
- serviceCount? int -
- domains? string -
- serviceCountTcp? int -
- lowestTtl? int -
- ipAddress? anydata -
- serviceCountArp? int -
- tags? string -
- site? string -
- serviceCountIcmp? int -
- organization? string -
- macs? string -
- name? string -
- hwProduct? string -
- hwVendor? string -
- newestMacAge? string -
runzero: AssetsPage
Fields
- assets? Asset[] -
- nextKey? string - The key to use for the next page of results
runzero: AssetsWithCheckpoint
Fields
- assets Asset[] -
- since int -
runzero: AssetTags
Fields
- tags string -
runzero: AssetTagsWithSearch
Fields
- search string -
- tags string -
runzero: AWSCredentialFields
Fields
- regions? string -
- role? string -
- useCrossAccountOrg? string -
- accessKey string -
- secretAccessKey string -
runzero: AzureClientSecretCredentialFields
Fields
- tenantId string -
- subscriptionId? string -
- multiSubscription? string -
- environment "global"|"gcc"|"gcc_high"|"dod" -
- clientSecret string -
- clientId string -
runzero: AzureUsernamePasswordCredentialFields
Fields
- tenantId string -
- password string -
- clientId string -
- username string -
runzero: BaseCustomIntegration
Fields
- name? string - The unique name of the custom integration, without spaces
- icon? string - Base64 encoded png with maximum size 256x256 pixels
- description? string - A text description of the custom integration
runzero: BaseResponse
Minimal identifying information with lifecycle metadata
Fields
- createdAt string - A timestamp indicating creation time of the object
- destroyedAt? string - A timestamp indicating deletion time of the object
- clientId string - The unique ID of the runZero client/customer account that owns the object
- id string - The unique ID of the object
- createdById string - The unique ID of the entity that created the object
- updatedAt string - A timestamp indicating last modified time of the object
runzero: CensysCredentialFields
Fields
- apiUrl? string -
- clientSecret string -
- clientId string -
runzero: Certificate
Fields
- publicKey? string -
- hidden? boolean - Whether the certificate has been hidden from the default certificates view
- keyUsage? string[] - Valid purposes the certificate's key can be used for
- signature? string -
- subject? string - The subject of the certificate
- createdAt? int -
- 'type? "x509"|"ssh" -
- sanUris? string[] - Subject Alternative Name URIs
- validityEnd? int - When the certificate ceases to be valid
- issuer? string - The authority which issued the certificate
- fpSha1? string - The SHA1 hash of the certificate
- subjectKeyId? string - The key ID of the subject of the certificate
- ocspServer? string[] - Zero or more OCSP server URLs
- updatedAt? int - When the certificate was last seen in a response from a service, and updated
- publicKeyBits? Signed32 -
- signatureAlgorithm? string -
- publicKeyParameters? record {} - Parameters specific to the public key type
- id string -
- selfSigned? boolean - Whether the certificate appears to be self-signed based on subject and authority
- sanDnsNames? string[] - Subject Alternative Name hostnames
- fpSha256? string - The SHA256 hash of the certificate
- issuingCertificateUrl? string[] - Zero or more URLs where the issuing certificate can be found
- fpBkhash? string - The badkeys hash
- cn? string - The Common Name field from the certificate (no longer used by web browsers)
- sanIpAddresses? CertificateSanIpAddresses[] - Subject Alternative Name IP addresses
- fpMd5? string - The MD5 hash of the certificate (for SSH)
- version? Signed32 - The version of the certificate
- isCa? boolean - Whether the certificate claims to be a Certificate Authority
- sanEmailAddresses? string[] - Subject Alternative Name email addresses
- crlDistributionPoints? string[] - Zero or more URLs of CRLs
- names? string[] - An assembled list of all names in the certificate
- authorityKeyId? string - The key ID of the authority which signed the certificate
- serial? string - The serial number of the certificate
- organizationId string -
- validityStart? int - When the certificate becomes valid
- publicKeyAlgorithm? string -
- extKeyUsage? string[] - Additional purposes the certificate's key can be used for
runzero: ClearBulkAssetOwnersQueries
Represents the Queries record for the operation: clearBulkAssetOwners
Fields
- oid? string - The current Organization
runzero: ClearBulkAssetTagsQueries
Represents the Queries record for the operation: clearBulkAssetTags
Fields
- oid? string - The current Organization
runzero: ClientIDForm
Fields
- grantType string -
- clientSecret string -
- clientId string -
runzero: ComponentVersion
A component ID and version
Fields
- id string - Identifier of the component
- version string - Version of the component
runzero: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
runzero: CreateSampleQueries
Represents the Queries record for the operation: createSample
Fields
- oid? string - The current Organization
runzero: CreateScanQueries
Represents the Queries record for the operation: createScan
Fields
- oid? string - The current Organization
runzero: CreateSiteQueries
Represents the Queries record for the operation: createSite
Fields
- oid? string - The current Organization
runzero: Credential
Fields
- lastUsedAt? int -
- name? string -
- createdAt? int -
- global? boolean -
- id string -
- createdById? string -
- acl? record {} -
- cidrs? string[] -
- lastUsedById? string -
- 'type? "miradore_api_key_v1"|"aws_access_secret"|"crowdstrike_api_key"|"azure_client_secret"|"azure_username_password"|"censys_search_api_key"|"snmpv2_community"|"snmpv3_credential"|"vmware_username_password" - The service the credentials are for
- createdByEmail? string -
- clientId? string -
runzero: CredentialOptions
Fields
- name? string -
- global? boolean -
- acl? record {} -
- cidrs? string -
- secret? CredentialFields -
- 'type? "aws_access_secret"|"azure_client_secret"|"azure_username_password"|"censys_search_api_key"|"crowdstrike_api_key"|"custom_integration_credential"|"gcp_service_account_key"|"google_workspace_client_secret"|"insightvm_username_password"|"ldap_username_password"|"mecm_db_connection_string"|"meraki_api_key"|"miradore_api_key_v1"|"nessus_access_secret"|"netbox_api_key"|"palo_alto_api_key"|"qualys_username_password"|"sentinelone_api_key"|"shodan_api_key"|"snmpv2_community"|"snmpv3_credential"|"tanium_api_token"|"tenable_access_secret"|"tenable_security_center_access_secret"|"vmware_username_password"|"wiz_client_secret"|"x509_keypair" -
runzero: CrowdstrikeCredentialFields
Fields
- apiUrl string -
- clientSecret string -
- clientId string -
runzero: CustomIntegration
Fields
- Fields Included from *BaseCustomIntegration
- name string -
- Fields Included from *BaseResponse
runzero: CustomIntegrationScriptCredentialFields
Fields
- accessKey string -
- accessSecret string -
runzero: DirectoryGroup
Fields
- directoryGroupSiteId? string -
- directoryGroupName? string -
- directoryGroupCreatedAt? int -
- directoryGroupDescription? string -
- directoryGroupEmailNormalized? string -
- directoryGroupDisplayName? string -
- directoryGroupGroupId? string -
- directoryGroupUserCount? int -
- directoryGroupOrganizationId? string -
- directoryGroupSourceId? int -
- directoryGroupEmail? string -
- directoryGroupAttributes? record { string... } -
- directoryGroupId? string -
- id string -
- directoryGroupUpdatedAt? int -
runzero: DirectoryUser
Fields
- directoryUserName? string -
- directoryUserAttributes? record { string... } -
- directoryUserGroupIds? string[] -
- directoryUserDescription? string -
- directoryUserLastLogonAt? int -
- directoryUserUpdatedAt? int -
- directoryUserSourceId? int -
- directoryUserFirstName? string -
- directoryUserTitle? string -
- directoryUserPhone? string -
- directoryUserDisplayName? string -
- directoryUserId? string -
- directoryUserUserId? string -
- directoryUserEmailNormalized? string -
- directoryUserEmail? string -
- directoryUserLocation? string -
- directoryUserSiteId? string -
- id string -
- directoryUserOrganizationId? string -
- directoryUserCreatedAt? int -
- directoryUserLastName? string -
runzero: Event
Fields
- targetName? string -
- targetType? string -
- createdAt? int -
- sourceType? string -
- targetId? string -
- clientId? string -
- success? boolean -
- organizationId? string -
- siteId? string -
- action? string -
- processorId? string -
- processedAt? int -
- details? record {} -
- id? string -
- sourceId? string -
- state? string -
- sourceName? string -
runzero: EventsPage
Fields
- nextKey? string - The key to use for the next page of results
- events? Event[] -
runzero: ExportAssetMetricsJSONQueries
Represents the Queries record for the operation: exportAssetMetricsJSON
Fields
- oid? string - The current Organization
runzero: ExportAssetsCiscoCSVQueries
Represents the Queries record for the operation: exportAssetsCiscoCSV
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
runzero: ExportAssetsCSVQueries
Represents the Queries record for the operation: exportAssetsCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportAssetsJSONLQueries
Represents the Queries record for the operation: exportAssetsJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportAssetsJSONQueries
Represents the Queries record for the operation: exportAssetsJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - A list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: ExportAssetsNmapXMLQueries
Represents the Queries record for the operation: exportAssetsNmapXML
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportAssetTopHWCSVQueries
Represents the Queries record for the operation: exportAssetTopHWCSV
Fields
- oid? string - The current Organization
runzero: ExportAssetTopOSCSVQueries
Represents the Queries record for the operation: exportAssetTopOSCSV
Fields
- oid? string - The current Organization
runzero: ExportAssetTopTagsCSVQueries
Represents the Queries record for the operation: exportAssetTopTagsCSV
Fields
- oid? string - The current Organization
runzero: ExportAssetTopTypesCSVQueries
Represents the Queries record for the operation: exportAssetTopTypesCSV
Fields
- oid? string - The current Organization
runzero: ExportCertificatesCSVQueries
Represents the Queries record for the operation: exportCertificatesCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportCertificatesJSONLQueries
Represents the Queries record for the operation: exportCertificatesJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportCertificatesJSONQueries
Represents the Queries record for the operation: exportCertificatesJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportDirectoryGroupsCSVQueries
Represents the Queries record for the operation: exportDirectoryGroupsCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportDirectoryGroupsJSONLQueries
Represents the Queries record for the operation: exportDirectoryGroupsJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportDirectoryGroupsJSONQueries
Represents the Queries record for the operation: exportDirectoryGroupsJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportDirectoryUsersCSVQueries
Represents the Queries record for the operation: exportDirectoryUsersCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportDirectoryUsersJSONLQueries
Represents the Queries record for the operation: exportDirectoryUsersJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportDirectoryUsersJSONQueries
Represents the Queries record for the operation: exportDirectoryUsersJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportEventsJSONLQueries
Represents the Queries record for the operation: exportEventsJSONL
Fields
- search? string - an optional search string for filtering results
- fields? string - an optional list of fields to export, comma-separated
runzero: ExportEventsJSONQueries
Represents the Queries record for the operation: exportEventsJSON
Fields
- search? string - an optional search string for filtering results
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - an optional list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: ExportFindingsCSVQueries
Represents the Queries record for the operation: exportFindingsCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportFindingsJSONLQueries
Represents the Queries record for the operation: exportFindingsJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportFindingsJSONQueries
Represents the Queries record for the operation: exportFindingsJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportServicesCSVQueries
Represents the Queries record for the operation: exportServicesCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportServicesJSONLQueries
Represents the Queries record for the operation: exportServicesJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportServicesJSONQueries
Represents the Queries record for the operation: exportServicesJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - A list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: ExportServicesTopProductsCSVQueries
Represents the Queries record for the operation: exportServicesTopProductsCSV
Fields
- oid? string - The current Organization
runzero: ExportServicesTopProtocolsCSVQueries
Represents the Queries record for the operation: exportServicesTopProtocolsCSV
Fields
- oid? string - The current Organization
runzero: ExportServicesTopTCPCSVQueries
Represents the Queries record for the operation: exportServicesTopTCPCSV
Fields
- oid? string - The current Organization
runzero: ExportServicesTopUDPCSVQueries
Represents the Queries record for the operation: exportServicesTopUDPCSV
Fields
- oid? string - The current Organization
runzero: ExportSitesCSVQueries
Represents the Queries record for the operation: exportSitesCSV
Fields
- oid? string - The current Organization
runzero: ExportSitesJSONLQueries
Represents the Queries record for the operation: exportSitesJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportSitesJSONQueries
Represents the Queries record for the operation: exportSitesJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportSNMPARPCacheCSVQueries
Represents the Queries record for the operation: exportSNMPARPCacheCSV
Fields
- oid? string - The current Organization
runzero: ExportSoftwareCSVQueries
Represents the Queries record for the operation: exportSoftwareCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportSoftwareJSONLQueries
Represents the Queries record for the operation: exportSoftwareJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportSoftwareJSONQueries
Represents the Queries record for the operation: exportSoftwareJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - A list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: ExportSubnetUtilizationStatsCSVQueries
Represents the Queries record for the operation: exportSubnetUtilizationStatsCSV
Fields
- oid? string - The current Organization
- mask? string - an optional subnet mask size (ex:24)
runzero: ExportTasksJSONLQueries
Represents the Queries record for the operation: exportTasksJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportTasksJSONQueries
Represents the Queries record for the operation: exportTasksJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportToken
Fields
- lastUsedAt? int -
- createdAt? int -
- comment? string -
- id anydata -
- counter? int -
- lastUsedBy? string -
- token? string -
runzero: ExportTokenOptions
Fields
- comment? string -
runzero: ExportVulnerabilitiesCSVQueries
Represents the Queries record for the operation: exportVulnerabilitiesCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportVulnerabilitiesJSONLQueries
Represents the Queries record for the operation: exportVulnerabilitiesJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportVulnerabilitiesJSONQueries
Represents the Queries record for the operation: exportVulnerabilitiesJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - A list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: ExportWirelessCSVQueries
Represents the Queries record for the operation: exportWirelessCSV
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
runzero: ExportWirelessJSONLQueries
Represents the Queries record for the operation: exportWirelessJSONL
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: ExportWirelessJSONQueries
Represents the Queries record for the operation: exportWirelessJSON
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- startKey? string - The value to use for requesting the next page when requesting paginated results. This should be the value of the
next_keyattribute returned in the previous response
- fields? string - A list of fields to export, comma-separated
- pageSize? int - The number of results to return per request
runzero: Finding
Fields
- riskRankValue? Signed32 - 0 = info, 4 = critical
- description? string - Additional information about the finding
- createdAt? int -
- solution? string - Remediation information
- updatedAt? int -
- riskRank? string -
- organizationId string -
- findingCode? string - A runZero-assigned code for the finding
- name? string - The title of the finding
- links? FindingLinks -
- id string -
- category? string -
- lastDetectedAt? int -
- instanceCount? int -
runzero: FindingLinks
Fields
- urls? FindingLinksCves[] - Additional relevant URLs
- rzBlog? FindingLinksCves[] - URLs of relevant runZero blog postings
- cves? FindingLinksCves[] -
runzero: FindingLinksCves
Fields
- title? string -
- url? string -
runzero: GCPCredentialFields
Fields
- tokenUri? string -
- clientX509CertUrl? string -
- privateKeyId? string -
- projectId? string -
- universeDomain? string -
- crossProject? string -
- authProviderX509CertUrl? string -
- authUri? string -
- clientEmail? string -
- privateKey? string - base64 encoded private key, beginning with -----BEGIN PRIVATE KEY-----
- 'type? string -
- clientId? string -
runzero: GetAccountAgentsQueries
Represents the Queries record for the operation: getAccountAgents
Fields
- search? string - an optional search string for filtering results
runzero: GetAccountCredentialsQueries
Represents the Queries record for the operation: getAccountCredentials
Fields
- search? string - an optional search string for filtering results
runzero: GetAccountOrganizationsQueries
Represents the Queries record for the operation: getAccountOrganizations
Fields
- search? string - an optional search string for filtering results
runzero: GetAccountScanTemplatesQueries
Represents the Queries record for the operation: getAccountScanTemplates
Fields
- search? string - an optional search string for filtering results
runzero: GetAccountSitesQueries
Represents the Queries record for the operation: getAccountSites
Fields
- search? string - an optional search string for filtering results
runzero: GetAccountTasksQueries
Represents the Queries record for the operation: getAccountTasks
Fields
- search? string - an optional search string for filtering results
runzero: GetAgentQueries
Represents the Queries record for the operation: getAgent
Fields
- oid? string - The current Organization
runzero: GetAgentsQueries
Represents the Queries record for the operation: getAgents
Fields
- oid? string - The current Organization
runzero: GetAssetQueries
Represents the Queries record for the operation: getAsset
Fields
- oid? string - The current Organization
runzero: GetAssetsQueries
Represents the Queries record for the operation: getAssets
Fields
- search? string - A search query in runZero search query syntax
- oid? string - The current Organization
- fields? string - A list of fields to export, comma-separated
runzero: GetExplorerQueries
Represents the Queries record for the operation: getExplorer
Fields
- oid? string - The current Organization
runzero: GetExplorersQueries
Represents the Queries record for the operation: getExplorers
Fields
- oid? string - The current Organization
runzero: GetHostedZoneQueries
Represents the Queries record for the operation: getHostedZone
Fields
- oid? string - The current Organization
runzero: GetHostedZonesQueries
Represents the Queries record for the operation: getHostedZones
Fields
- oid? string - The current Organization
runzero: GetKeyQueries
Represents the Queries record for the operation: getKey
Fields
- oid? string - The current Organization
runzero: GetOrganizationQueries
Represents the Queries record for the operation: getOrganization
Fields
- oid? string - The current Organization
runzero: GetServiceQueries
Represents the Queries record for the operation: getService
Fields
- oid? string - The current Organization
runzero: GetServicesQueries
Represents the Queries record for the operation: getServices
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
runzero: GetSiteQueries
Represents the Queries record for the operation: getSite
Fields
- oid? string - The current Organization
runzero: GetSitesQueries
Represents the Queries record for the operation: getSites
Fields
- oid? string - The current Organization
runzero: GetTaskChangeReportQueries
Represents the Queries record for the operation: getTaskChangeReport
Fields
- oid? string - The current Organization
runzero: GetTaskLogQueries
Represents the Queries record for the operation: getTaskLog
Fields
- oid? string - The current Organization
runzero: GetTaskQueries
Represents the Queries record for the operation: getTask
Fields
- oid? string - The current Organization
runzero: GetTaskScanDataQueries
Represents the Queries record for the operation: getTaskScanData
Fields
- oid? string - The current Organization
runzero: GetTasksQueries
Represents the Queries record for the operation: getTasks
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
- status? string - an optional status string for filtering results
runzero: GetWirelessLANQueries
Represents the Queries record for the operation: getWirelessLAN
Fields
- oid? string - The current Organization
runzero: GetWirelessLANsQueries
Represents the Queries record for the operation: getWirelessLANs
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
runzero: GoogleWorkspaceCredentialFields
Fields
- universeDomain? string -
- clientEmail? string -
- privateKey? string - base64 encoded private key, beginning with -----BEGIN PRIVATE KEY-----
- 'type? string -
- clientId? string -
- delegate string -
- tokenUri? string -
- clientX509CertUrl? string -
- privateKeyId? string -
- projectId? string -
- authProviderX509CertUrl? string -
- authUri? string -
- customerId? string -
runzero: Group
Fields
- orgDefaultRole? string -
- expiresAt? int -
- userCount? int -
- updatedAt? int -
- name? string -
- orgRoles? record {} -
- description? string -
- createdAt? int -
- id string -
- roleSummary? string -
- createdByEmail? string -
runzero: GroupMapping
Fields
- ssoValue string -
- updatedAt? int -
- groupId string -
- groupName? string -
- ssoAttribute string -
- description? string -
- createdAt? int -
- id string -
- createdByEmail? string -
runzero: GroupPost
Fields
- orgDefaultRole? string -
- expiresAt? int -
- name? string -
- orgRoles? record {} -
- description? string -
runzero: GroupPut
Fields
- orgDefaultRole? string -
- expiresAt? int -
- name? string -
- orgRoles? record {} -
- description? string -
- id? string -
runzero: HealthCheckResponse
A health check response and version
Fields
- version string - Version of the runZero platform
- status string - Health status reported by the platform
runzero: HideTaskQueries
Represents the Queries record for the operation: hideTask
Fields
- oid? string - The current Organization
runzero: HostedZone
A hosted service which performs scan tasks. Hosted zones are only available to Enterprise customers
Fields
- tasksActive? int - The number of tasks executing in the zone
- updatedAt? string - The last modification time of the hosted zone
- explorersTotal? int - The number of explorers available in the zone
- organizationId? string - The ID of the organization the hosted zone is assigned to
- name? string - Name of the hosted zone
- tasksWaiting? int - The number of tasks waiting to execute in the zone
- processorId? string - The processor ID assigned to the hosted zone
- explorersConcurrency? int - The number of concurrent explorer tasks that can be executed
- id string - The ID of the hosted zone
- enabled? boolean - Whether the hosted zone is enabled
runzero: ImportNessusScanDataQueries
Represents the Queries record for the operation: importNessusScanData
Fields
- oid? string - The current Organization
runzero: ImportPacketDataQueries
Represents the Queries record for the operation: importPacketData
Fields
- oid? string - The current Organization
runzero: ImportScanDataQueries
Represents the Queries record for the operation: importScanData
Fields
- oid? string - The current Organization
runzero: ImportTask
Information which describes the task created when asset data is imported
Fields
- name string - Name of the import task
- description? string - Description of the import task
- excludeUnknown boolean(default false) - Instructs the data ingestion process whether to skip assets which do not merge into an existing asset in the asset inventory
- tags? ImportTaskTagsItemsString[] - Arbitrary string tag values which are applied to the asset data import task created
runzero: InsightVMCredentialFields
Fields
- password string -
- apiUrl string -
- insecure? string -
- thumbprints? string -
- username string -
runzero: LDAPCredentialFields
Fields
- password string -
- legacyTls? string -
- baseDn string -
- insecure? string -
- thumbprints? string -
- url string -
- username string -
runzero: License
Fields
- viaReseller? boolean -
- ssoType? string -
- ssoLoginIssuerUrl? string -
- addressPostal? string -
- licenseLiveAssetCount? int -
- createdAt? int -
- subscriptionCanceledAt? int -
- licenseExpiration? int -
- updatedAt? int -
- addressRegion? string -
- ssoLoginMessage? string -
- id? string -
- settings? record {} -
- licenseType? string -
- addressCountry? string -
- ssoLoginLoginUrl? string -
- subscriptionPeriodEnd? int -
- ssoLoginLogoutUrl? string -
- addressCity? string -
- activatedAt? int -
- licenseMaxAssets? int -
- partner? string -
- phone? string -
- subscriptionPeriodStart? int -
- ssoDomain? string -
- addressStreet? string -
- licenseProjectAssetCount? int -
- name? string -
- ssoMode? string -
- subscriptionCancelAt? int -
- ssoDefaultRole? string -
runzero: MECMCredentialFields
Fields
- dbConnectionString string -
runzero: MergeAssetsQueries
Represents the Queries record for the operation: mergeAssets
Fields
- oid? string - The current Organization
runzero: MiradoreCredentialFields
Fields
- hostname string -
- apiKey string -
runzero: MirakiCredentialFields
Fields
- apiUrl string -
- apiKey string -
runzero: NessusCredentialFields
Fields
- secretKey string -
- apiUrl string -
- accessKey string -
- insecure? string -
- thumbprints? string -
runzero: NetboxCredentialFields
Fields
- apiUrl string -
- apiKey string -
runzero: NewAssetImport
Represents a request to import asset data described by the specified custom integration into the specified site.
Assets will be created new or merged according to merge rules defined by the version of the platform you are uploading the asset data file to. Typically, this involves matching network and other unique single or grouped properties.
There is a maximum of 256 custom asset properties that can be applied to any asset. This means that, aside from the per-import asset property limit set on ImportAsset, if a new import sets different custom properties on the same asset, the new properties are combined with the pre-existing ones
Fields
- customIntegrationId string - The unique ID of the registered custom integration which produced the asset data. Uniqueness is not checked/enforced. See /account/custom-integrations api
- assetData record { fileContent byte[], fileName string } - A gzip (not .tar.gz) compressed file containing ImportAsset objects. The file data may be a JSON array of ImportAsset objects, e.g. [{},{},...] or JSONL format, with a single JSON representation of an ImportAsset object on each new line, e.g. {}\n{}\n..
- importTask ImportTask - Information which describes the task created when asset data is imported
- siteId string - The ID of the site assets are to be imported into
runzero: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://console.runzero.com/api/v1.0/account/api/token") - Token URL
runzero: Organization
Fields
- exportTokenLastUsedAt? int -
- deactivatedAt? int -
- downloadTokenCreatedAt? int -
- exportTokenCreatedAt? int -
- createdAt? int -
- description? string -
- serviceCountUdp? int -
- project? boolean -
- exportToken? string -
- clientId? string -
- exportTokenCounter? int -
- assetCount? int -
- inactive? boolean -
- expirationIntegrationAttributes? int -
- updatedAt? int -
- exportTokenLastUsedBy? string -
- expirationAssetsStale? int -
- id string -
- downloadToken? string -
- serviceCount? int -
- serviceCountTcp? int -
- serviceCountArp? int -
- expirationVulnerabilities? int -
- expirationScans? int -
- serviceCountIcmp? int -
- expirationAssetsOffline? int -
- parentId? string -
- name string -
- keepLatestIntegrationAttributes? boolean -
runzero: OrgOptions
Fields
- expirationScans? string -
- expirationAssetsOffline? string -
- expirationIntegrationAttributes? string -
- parentId? string -
- name? string -
- description? string -
- expirationAssetsStale? string -
- keepLatestIntegrationAttributes? string -
- expirationVulnerabilities? string -
runzero: PaloAltoFirewallCredentialFields
Fields
- apiKey string -
runzero: QualysCredentialFields
Fields
- password string -
- apiUrl string -
- username string -
runzero: RemoveAgentQueries
Represents the Queries record for the operation: removeAgent
Fields
- oid? string - The current Organization
runzero: RemoveAssetQueries
Represents the Queries record for the operation: removeAsset
Fields
- oid? string - The current Organization
runzero: RemoveBulkAssetsQueries
Represents the Queries record for the operation: removeBulkAssets
Fields
- oid? string - The current Organization
runzero: RemoveExplorerQueries
Represents the Queries record for the operation: removeExplorer
Fields
- oid? string - The current Organization
runzero: RemoveKeyQueries
Represents the Queries record for the operation: removeKey
Fields
- oid? string - The current Organization
runzero: RemoveServiceQueries
Represents the Queries record for the operation: removeService
Fields
- oid? string - The current Organization
runzero: RemoveSiteQueries
Represents the Queries record for the operation: removeSite
Fields
- oid? string - The current Organization
runzero: RemoveWirelessLANQueries
Represents the Queries record for the operation: removeWirelessLAN
Fields
- oid? string - The current Organization
runzero: RotateKeyQueries
Represents the Queries record for the operation: rotateKey
Fields
- oid? string - The current Organization
runzero: SampleOptions
Options which can be set to create or modify traffic sampling
Fields
- agent? string - ID of the explorer that performs the sampling
- interfaces string - Network interfaces to sample traffic on
- excludes? string - Targets to exclude from sampling
- explorer? string - ID of the explorer that performs the sampling
- targets? string - Targets to include in sampling
- tags? string - Tags to apply to assets discovered by the sampling task
runzero: ScanOptions
Options which can be set to create or modify a scan
Fields
- agent? string - ID of the explorer that performs the scan
- excludes? string - Targets to exclude from the scan
- hostPingProbes? string - Optional host ping probe list as comma separated strings. The example shows possibilities
- scanDescription? string - A description of the scan
- hostPing? string - Whether to ping hosts to detect them before scanning
- targets string - Targets to include in the scan
- scanTemplate? string - ID of the scan template to use
- screenshots? string - Whether to capture screenshots of discovered web services
- maxHostRate? string - Maximum number of packets per second sent to a single host
- scanFrequency? "once"|"hourly"|"daily"|"weekly"|"monthly"|"continuous" - A string time duration value representing execution frequency, if scheduled to repeat
- passes? string - Number of scan passes to run
- subnetPing? string - Whether to ping subnets to find live hosts
- rate? string - Maximum number of packets per second sent overall
- hostedZoneId? string - The string 'auto' will use any available hosted zone. Otherwise, provide the string name (hostedzone1) or UUID ("e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8") of a hosted zone
- maxAttempts? string - Maximum number of attempts for each probe
- tos? string - IP type of service value applied to scan packets
- probes? string - Optional probe list, otherwise all probes are used
- scanStart? string - Unix timestamp value indicating when the template was created
- scanTags? string - Tags to apply to assets discovered by the scan
- tcpPorts? string - TCP ports to scan
- subnetPingNetSize? string - Subnet size used when pinging subnets
- subnetPingSampleRate? string - Share of addresses sampled in each subnet when pinging subnets
- maxGroupSize? string - Maximum number of hosts scanned in a group
- hostedZoneName? string - The string 'auto' will use any available hosted zone. Otherwise, provide the string name (hostedzone1) of the hosted zone
- scanName? string - Name of the scan task
- subnetPingProbes? string - Optional subnet ping probe list as comma separated strings. The example shows possibilities
- maxSockets? string - Maximum number of sockets opened at once
- nameservers? string - DNS nameservers used for lookups
- explorerGroupId? string - ID of the explorer group that performs the scan
- tcpExcludes? string - TCP ports to exclude from the scan
- scanGracePeriod? string - Grace period allowed for the scan to finish
- explorer? string - ID of the explorer that performs the scan
- maxTtl? string - Maximum time-to-live value for scan packets
runzero: ScanTemplate
A scan task template
Fields
- agentId? string - ID of the explorer which may execute the template
- hidden? boolean - A flag indicating whether the item is hidden from common view
- description? string - The description of the template
- createdAt? int - Unix timestamp value indicating when the template was created
- global boolean - Whether the template is globally available to all organizations
- acl record {} - A map of IDs to strings which describe how the template may be accessed. Currently there is no authoritative list of in-use values. See existing templates for examples
- 'type? string - The type of task the template creates
- 'error? string - The error message, if any, of the last task using the template
- clientId? string - ID of the account which owns the template
- cruncherId? string - ID of the runZero cruncher the task is executing on
- updatedAt? int - Unix timestamp value indicating when the template was last modified
- stats? record {} - A map of statistics about the last task executed with the template. Currently there is no authoritative list of in-use values. See existing templates for examples
- recur? boolean - A flag representing whether derived tasks are scheduled to repeat
- id string - ID of the template
- sizeSite? int - The size in assets of the site the last task the template was executed against
- recurLast? int - Unix timestamp representing the last execution if scheduled to repeat
- customIntegrationId? string - The ID of the custom integration source, if the last task executed with this template was an import of Asset Data
- recurLastTaskId? string - The ID of the task that last executed if scheduled to repeat
- hostedZoneId? string - The ID of the hosted zone that ran the last task the template was used with
- params? record { string... } - A number of task parameter values. Currently there is no authoritative list of in-use values. See existing templates for examples
- createdBy? string - The username of the account which created the template
- createdByUserId? string - The ID of the account which created the template
- sizeResults? int - The number of results in the last task the template was used with
- gracePeriod? string - Additional time beyond hard expiration deadline by which the task may still be allowed to execute
- startTime? int - Unix timestamp representing the next execution time
- linkedTaskCount? Signed32 - The number of tasks derived from the template
- recurFrequency? string - A string time duration value representing execution frequency, if scheduled to repeat. You may use values including as once, hourly, daily, weekly, monthly, continuous
- parentId? string - The ID of the parent entity of the task scheduled
- organizationId string - ID of the organization the template is available in
- name? string - The name of the template
- siteId? string - ID of the site the template is being used in
- templateId? string - The ID of the template
- sourceId? string - The numeric ID of the data source, if the task executed with this template is a runZero scan or third party data connection import
- sizeData? int - The total size of result data of the last task the template was used with
- recurNext? int - Unix timestamp representing the next execution if scheduled to repeat
- status? string - The status of the last task using the template
runzero: ScanTemplateOptions
Options which can be set to create a scan template
Fields
- organizationId string - The ID of the organization the template will be created in
- name string - Name of the template
- description? string - Description of the template
- global boolean - Whether the template is globally available to all organizations
- acl record {} - A map of IDs to strings which describe how the template may be accessed. Currently there is no authoritative list of acceptable values. See existing templates for examples
- params? record { string... } - A number of scan parameter values. Currently there is no authoritative list of acceptable values. See existing templates for examples
runzero: Search
Fields
- search string -
runzero: SentinelOneCredentialFields
Fields
- apiUrl string -
- apiKey string -
runzero: Service
Fields
- addresses? ServiceAddresses[] -
- lastSeen? int -
- agentName? string -
- serviceScreenshotLink? string -
- 'type? string -
- lastAgentId? string -
- hw? string -
- lowestRtt? int -
- servicePortsProducts? string[] -
- serviceProtocol? string -
- serviceData? record { string... } -
- id string -
- servicePortsProtocols? string[] -
- addressesExtra? ServiceAddressesExtra[] -
- serviceUpdatedAt? int -
- domains? string[] -
- newestMacVendor? string -
- lowestTtl? int -
- newestMac? string -
- tags? record { string... } -
- siteName? string -
- serviceCountIcmp? int -
- serviceLink? string -
- organizationId? string -
- macs? string[] -
- siteId? string -
- serviceAssetId? string -
- servicePort? string -
- newestMacAge? int -
- firstSeen? int -
- alive? boolean -
- credentials? record { record { boolean... }... } -
- createdAt? int -
- serviceCountUdp? int -
- serviceSummary? string -
- macVendors? string[] -
- serviceAddress? anydata -
- servicePortsUdp? string[] -
- serviceCreatedAt? int -
- updatedAt? int -
- detectedBy? string -
- serviceId string -
- orgName? string -
- comments? string -
- os? string -
- lastTaskId? string -
- serviceTransport? string -
- osVersion? string -
- serviceCount? int -
- serviceCountTcp? int -
- serviceCountArp? int -
- services? record { record { string... }... } -
- servicePortsTcp? string[] -
- names? string[] -
- rtts? record {} -
- attributes? record { string... } -
- serviceVhost? string -
runzero: ServicesPage
Fields
- nextKey? string - The key to use for the next page of results
- services? Service[] -
runzero: ShodanCredentialFields
Fields
- apiKey string -
runzero: Site
Fields
- excludes? string -
- updatedAt? int -
- scope? string -
- name string -
- createdAt? int -
- description? string -
- subnets? record {} -
- id string -
runzero: SiteOptions
Fields
- excludes? string -
- scope? string -
- name string -
- description? string -
- subnets? record {} -
runzero: SNMPv2CommunitiesCredentialFields
Fields
- community string -
runzero: SNMPv3CredentialFields
Fields
- privacyPassphrase? string -
- authPassphrase? string -
- privacyProtocol? string -
- authProtocol? string -
- context? string -
- username string -
runzero: SnowExportAssetsCSVQueries
Represents the Queries record for the operation: snowExportAssetsCSV
Fields
- oid? string - The current Organization
runzero: SnowExportAssetsJSONQueries
Represents the Queries record for the operation: snowExportAssetsJSON
Fields
- oid? string - The current Organization
runzero: SnowExportServicesCSVQueries
Represents the Queries record for the operation: snowExportServicesCSV
Fields
- oid? string - The current Organization
runzero: SnowServiceGraphExportAssetsJSONQueries
Represents the Queries record for the operation: snowServiceGraphExportAssetsJSON
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
runzero: Software
Fields
- softwareUpdatedAt? int -
- softwareServicePort? int -
- softwareSwEdition? string -
- softwareCreatedAt? int -
- softwareServiceAddress? anydata -
- softwareTargetSw? string -
- softwareLanguage? string -
- softwareCpe23? string -
- softwareAssetId? string -
- softwareOrganizationId? string -
- softwareInstalledFrom? string -
- softwareOther? string -
- softwareInstalledSize? int -
- softwareVendor? string -
- softwareId? string -
- softwareTargetHw? string -
- id string -
- softwareVersion? string -
- softwareProduct? string -
- softwareAppId? string -
- softwareUpdate? string -
- softwarePart? string -
- softwareSourceId? int -
- softwareServiceTransport? string -
- softwareEdition? string -
- softwareAttributes? record { string... } -
- softwareInstalledAt? int -
runzero: SoftwarePage
Fields
- software? Software[] -
- nextKey? string - The key to use for the next page of results
runzero: SplunkAssetSyncCreatedJSONQueries
Represents the Queries record for the operation: splunkAssetSyncCreatedJSON
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
- fields? string - an optional list of fields to export, comma-separated
- since? int - an optional unix timestamp to use as a checkpoint
runzero: SplunkAssetSyncUpdatedJSONQueries
Represents the Queries record for the operation: splunkAssetSyncUpdatedJSON
Fields
- search? string - an optional search string for filtering results
- oid? string - The current Organization
- fields? string - an optional list of fields to export, comma-separated
- since? int - an optional unix timestamp to use as a checkpoint
runzero: StopTaskQueries
Represents the Queries record for the operation: stopTask
Fields
- oid? string - The current Organization
runzero: TaniumCredentialFields
Fields
- apiUrl string -
- apiToken string -
runzero: TaskBase
All fields of a Task with none required
Fields
- agentId? string - ID of the explorer that runs the task
- hidden? boolean - Whether the task is hidden from the task list
- description? string - Description of the task
- createdAt? int - Time the task was created, as a Unix timestamp
- 'type? string - Type of the task
- 'error? string - Error message if the task failed
- clientId? string - Client ID associated with the task
- cruncherId? string - ID of the processor that handles the task results
- updatedAt? int - Time the task was last updated, as a Unix timestamp
- stats? record {} - Statistics collected while the task runs
- recur? boolean - Whether the task recurs
- id? string - Unique ID of the task
- recurLast? int - Time the task last recurred, as a Unix timestamp
- customIntegrationId? string - The ID of the custom integration source, if the last task executed with this template was an import of Asset Data
- recurLastTaskId? string - ID of the most recent task created by the recurrence
- hostedZoneId? string - The ID of the Hosted Zone which executes the task. If the
- params? record { string... } - Parameters the task was started with
- createdBy? string - Name of the creator of the task
- createdByUserId? string - ID of the user who created the task
- startTime? int - Time the task starts, as a Unix timestamp
- recurFrequency? string - How often the task recurs
- parentId? string - ID of the parent task
- organizationId? string - ID of the organization the task belongs to
- name? string - Name of the task
- siteId? string - ID of the site the task belongs to
- templateId? string - ID of the scan template the task uses
- sourceId? int - The numeric ID of the data source, if the task executed with this template is a runZero scan or third party data connection import
- recurNext? int - Time of the next recurrence, as a Unix timestamp
- status? string - Current status of the task
runzero: TenableIoCredentialFields
Fields
- secretKey string -
- apiUrl string -
- accessKey string -
runzero: TenableScCredentialFields
Fields
- secretKey string -
- apiUrl string -
- accessKey string -
- insecure? string -
- thumbprints? string -
runzero: UpdateAgentSettingsQueries
Represents the Queries record for the operation: updateAgentSettings
Fields
- oid? string - The current Organization
runzero: UpdateAssetCommentsQueries
Represents the Queries record for the operation: updateAssetComments
Fields
- oid? string - The current Organization
runzero: UpdateAssetCriticalityQueries
Represents the Queries record for the operation: updateAssetCriticality
Fields
- oid? string - The current Organization
runzero: UpdateAssetOwnersQueries
Represents the Queries record for the operation: updateAssetOwners
Fields
- oid? string - The current Organization
runzero: UpdateAssetTagsQueries
Represents the Queries record for the operation: updateAssetTags
Fields
- oid? string - The current Organization
runzero: UpdateBulkAssetCriticalityQueries
Represents the Queries record for the operation: updateBulkAssetCriticality
Fields
- oid? string - The current Organization
runzero: UpdateBulkAssetOwnersQueries
Represents the Queries record for the operation: updateBulkAssetOwners
Fields
- oid? string - The current Organization
runzero: UpdateBulkAssetTagsQueries
Represents the Queries record for the operation: updateBulkAssetTags
Fields
- oid? string - The current Organization
runzero: UpdatedAssetCountResponse
Fields
- updatedAssetCount? int -
runzero: UpdateExplorerSettingsQueries
Represents the Queries record for the operation: updateExplorerSettings
Fields
- oid? string - The current Organization
runzero: UpdateOrganizationQueries
Represents the Queries record for the operation: updateOrganization
Fields
- oid? string - The current Organization
runzero: UpdateSiteQueries
Represents the Queries record for the operation: updateSite
Fields
- oid? string - The current Organization
runzero: UpdateTaskQueries
Represents the Queries record for the operation: updateTask
Fields
- oid? string - The current Organization
runzero: UpgradeAgentQueries
Represents the Queries record for the operation: upgradeAgent
Fields
- oid? string - The current Organization
runzero: UpgradeExplorerQueries
Represents the Queries record for the operation: upgradeExplorer
Fields
- oid? string - The current Organization
runzero: User
Fields
- orgDefaultRole? string -
- termsAgreedAsOf? int -
- lastLoginAt? int -
- lastActionAt? int -
- orgRoles? record {} -
- createdAt? int -
- lastName? string -
- clientId? string -
- inviteTokenExpiration? int -
- ssoOnly? boolean -
- updatedAt? int -
- lastLoginIp? anydata -
- lastActivityAt? int -
- name? string -
- loginFailures? int -
- mfaEnabled? boolean -
- id string -
- resetTokenExpiration? int -
- lastLoginUa? string -
- firstName? string -
- actions? int -
- email? string -
- passwordEnabledAt? int -
- clientAdmin? boolean -
runzero: UserInviteOptions
Fields
- orgDefaultRole? string -
- subject? string -
- orgRoles? record {} -
- lastName? string -
- message? string -
- firstName? string -
- email? string -
- clientAdmin? boolean -
runzero: UserOptions
Fields
- orgDefaultRole? string -
- orgRoles? record {} -
- lastName? string -
- firstName? string -
- email? string -
- clientAdmin? boolean -
runzero: VMwareCredentialFields
Fields
- password string -
- insecure? string -
- thumbprints? string -
- username string -
runzero: VulnerabilitiesPage
Fields
- nextKey? string - The key to use for the next page of results
- vulnerabilities? Vulnerability[] -
runzero: Vulnerability
Fields
- addresses? VulnerabilityAddresses[] -
- lastSeen? int -
- agentName? string -
- vulnerabilityPublishedAt? int -
- 'type? string -
- lastAgentId? string -
- hw? string -
- lowestRtt? int -
- vulnerabilitySeverityScore? decimal -
- vulnerabilityName? string -
- servicePortsProducts? string[] -
- vulnerabilitySeverity? string -
- vulnerabilityFirstDetectedAt? int -
- vulnerabilityCvss2TemporalScore? decimal -
- vulnerabilityServiceAddress? anydata -
- vulnerabilitySolution? string -
- id string -
- servicePortsProtocols? string[] -
- addressesExtra? VulnerabilityAddressesExtra[] -
- vulnerabilityCve? string -
- vulnerabilityRiskScore? decimal -
- vulnerabilityId? string -
- domains? string[] -
- newestMacVendor? string -
- lowestTtl? int -
- newestMac? string -
- vulnerabilityLastDetectedAt? int -
- tags? record { string... } -
- siteName? string -
- serviceCountIcmp? int -
- vulnerabilityAssetId? string -
- vulnerabilityAttributes? record { string... } -
- organizationId? string -
- macs? string[] -
- siteId? string -
- vulnerabilityCategory? string -
- newestMacAge? int -
- vulnerabilityServiceTransport? string -
- firstSeen? int -
- alive? boolean -
- credentials? record { record { boolean... }... } -
- createdAt? int -
- serviceCountUdp? int -
- vulnerabilityDescription? string -
- macVendors? string[] -
- vulnerabilityOrganizationId? string -
- vulnerabilityRisk? string -
- servicePortsUdp? string[] -
- vulnerabilityCreatedAt? int -
- updatedAt? int -
- detectedBy? string -
- vulnerabilityCpe23? string -
- vulnerabilityUpdatedAt? int -
- orgName? string -
- vulnerabilityCvss2BaseScore? decimal -
- comments? string -
- vulnerabilityServicePort? int -
- os? string -
- lastTaskId? string -
- vulnerabilitySourceId? int -
- osVersion? string -
- serviceCount? int -
- vulnerabilityCvss3TemporalScore? decimal -
- serviceCountTcp? int -
- serviceCountArp? int -
- services? record { record { string... }... } -
- servicePortsTcp? string[] -
- vulnerabilityVulnId? string -
- names? string[] -
- rtts? record {} -
- attributes? record { string... } -
- vulnerabilityCvss3BaseScore? decimal -
runzero: Wireless
Fields
- lastSeen? int -
- lastTaskId? string -
- data? record { string... } -
- agentName? string -
- essid? string -
- bssid? string -
- createdAt? int -
- 'type? string -
- interface? string -
- lastAgentId? string -
- siteName? string -
- encryption? string -
- channels? string -
- vendor? string -
- organizationId? string -
- siteId? string -
- id string -
- family? string -
- orgName? string -
- signal? int -
- authentication? string -
runzero: WirelessPage
Fields
- nextKey? string - The key to use for the next page of results
- wireless? Wireless[] -
runzero: WizCredentialFields
Fields
- apiUrl string -
- authUrl string -
- clientSecret string -
- clientId string -
runzero: X509CredentialFields
Fields
- x509Certificate string -
- privateKey string -
Union types
runzero: ExportWirelessResponse
ExportWirelessResponse
runzero: VulnerabilityAddressesExtra
VulnerabilityAddressesExtra
runzero: CredentialFields
CredentialFields
runzero: VulnerabilityAddresses
VulnerabilityAddresses
runzero: ExportVulnerabilitiesResponse
ExportVulnerabilitiesResponse
runzero: AssetAddressesExtra
AssetAddressesExtra
runzero: AssetAddresses
AssetAddresses
runzero: ExportAssetsResponse
ExportAssetsResponse
runzero: ExportEventsResponse
ExportEventsResponse
runzero: ExportServicesResponse
ExportServicesResponse
runzero: ServiceAddresses
ServiceAddresses
runzero: ServiceAddressesExtra
ServiceAddressesExtra
runzero: CertificateSanIpAddresses
CertificateSanIpAddresses
runzero: ExportSoftwareResponse
ExportSoftwareResponse
Array types
Anydata types
runzero: SanIpv6Address
SanIpv6Address
runzero: SanIpv4Address
SanIpv4Address
runzero: AddressIpv4
AddressIpv4
runzero: AddressIpv6
AddressIpv6
runzero: AddressIpv4Alt1
AddressIpv4Alt1
runzero: AddressIpv4Alt2
AddressIpv4Alt2
runzero: AddressExtraIpv4Alt2
AddressExtraIpv4Alt2
runzero: AddressExtraIpv4Alt1
AddressExtraIpv4Alt1
runzero: AddressExtraIpv6
AddressExtraIpv6
runzero: AddressExtraIpv4
AddressExtraIpv4
runzero: AddressExtraIpv6Alt1
AddressExtraIpv6Alt1
runzero: AddressExtraIpv6Alt2
AddressExtraIpv6Alt2
runzero: AddressIpv6Alt2
AddressIpv6Alt2
runzero: AddressIpv6Alt1
AddressIpv6Alt1
String types
runzero: ImportTaskTagsItemsString
ImportTaskTagsItemsString
Simple name reference types
runzero: TaskOptions
TaskOptions
Options which can be set to create or modify a task
runzero: ExplorerPatchedSettings
ExplorerPatchedSettings
runzero: Explorer
Explorer
A deployed service which performs scan tasks. Explorers may be referred to by their legacy name, Agents
runzero: NewCustomIntegration
NewCustomIntegration
runzero: Task
Task
A task object
Import
import ballerinax/runzero;Other versions
1.0.0
Metadata
Released date: 1 day ago
Version: 1.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 1
Weekly downloads
Keywords
Vendor/runZero
Area/Security & Identity
Type/Connector
Contributors