read thedocs.

[ docs // guides & reference ]

Connector setup guides, tool references, auth flows, and platform concepts — everything you need to run StackJack, in one place.

Browse the Docs All Connectors
34 connectors documented // 6,712 tools referenced // setup, auth & platform guides
↓

No pages match that search. Clear it

← All documentation

Telivy Tools

telivy_ · 28 tools · Free 28 Static x-api-key; fixed base https://api-v1.telivy.com; max page size 100; report tools return SAS URLs to blob-stored binaries.

General

Tool Plan Access Description
telivy_get_agent_versions Free Read-only [Telivy] Returns the latest published Telivy deep-scan agent versions for Windows and macOS. Useful when an MSP needs to verify whether endpoints are running outdated agents before triaging scan-status issues.
telivy_get_finding_details Free Read-only [Telivy] Looks up a finding by its short slug (e.g. "open-port", "weak-mfa") and returns the canonical name, description, risk explanation, remediation recommendation, severity, and reference links. Use this to enrich findings surfaced by telivy_get_external_scan_findings or telivy_get_external_scan_finding_detail.
telivy_get_risk_progress_report Free Read-only [Telivy] Returns a time-windowed findings progress report for an assessment, optionally comparing two timestamp groups. Surfaces resolved vs. new vs. ongoing findings between scans. Use telivy_list_external_scans or telivy_list_risk_assessments to discover assessment IDs.
telivy_get_finding_details parameters
Param Type Required Default Description
slug string yes Finding slug as returned by other Telivy tools (e.g. "open-port", "breach-data-exposure").
telivy_get_risk_progress_report parameters
Param Type Required Default Description
compareWithTimestampGroup string no null Optional second timestamp group to compare against. When omitted, progress is reported relative to the assessment's first scan.
currentTimestampGroup string yes Required. The current timestamp group (Telivy-internal scan grouping identifier) for which to report progress.
id string yes The Telivy assessment ID (external-scan or risk-assessment).

External Scans

Tool Plan Access Description
telivy_create_external_scan Free Write [Telivy] Create a new external (attack-surface) scan for a domain. Requires organizationName and domain. Triggers Telivy to begin scanning the domain's public-facing services.
telivy_get_external_scan Free Read-only [Telivy] Returns the full external-scan record including security grades, scan status, last-scan timestamp, and assessment details. Use telivy_list_external_scans to discover IDs.
telivy_get_external_scan_breach_data Free Read-only [Telivy] Returns dark-web/breach data exposures associated with the assessment's domain — leaked passwords, exposed accounts, breach dates, and source of disclosure. Use to support incident response and credential rotation conversations.
telivy_get_external_scan_finding_detail Free Read-only [Telivy] Returns the per-target detail records for a specific finding slug on an external scan (e.g. all hosts/ports affected by an "open-port" finding). Use telivy_get_external_scan_findings to enumerate slugs first.
telivy_get_external_scan_findings Free Read-only [Telivy] Returns all security findings discovered by the external scan (open ports, weak TLS, expired certs, exposed services, breach data, etc.). Each finding includes its slug — pass to telivy_get_external_scan_finding_detail or telivy_get_finding_details for more.
telivy_get_external_scan_report Free Read-only [Telivy] Generates and downloads the external scan report (PDF or DOCX). The binary is uploaded to StackJack blob storage and returned as a short-lived (~3 minute) read-only SAS URL. The agent should fetch the file from the URL within the expiry window — do NOT attempt to decode the URL as content.
telivy_list_external_scans Free Read-only [Telivy] List external (attack-surface) scan assessments. Returns ID, scan status, security grades, and assessment metadata. Use this to discover assessment IDs for downstream tools and to audit which client domains have been scanned.
telivy_rescan_external_scan_devices Free Write [Telivy] Marks all devices associated with the assessment for rescan. Triggers the Telivy deep-scan agent on each endpoint to re-evaluate posture. Operates on agent-deployed devices; pure external scans without agents will no-op.
telivy_uninstall_external_scan_devices Free Destructive [Telivy] DESTRUCTIVE: marks all devices associated with the assessment for agent uninstall. Use only when offboarding a customer or decommissioning the assessment — this revokes Telivy's deep-scan visibility, removes posture data collection from every endpoint in the assessment, and CANNOT be undone without redeploying the agent on each device.
telivy_update_external_scan Free Write [Telivy] Update an external scan's organization metadata (name, domain, client category/status). Pass-through PUT with the same fields used in create. Idempotent: replaying the same body produces the same end-state.
telivy_create_external_scan parameters
Param Type Required Default Description
clientCategory string no null Optional client category. One of: breakfix, it_only, security_only, it_and_security.
clientStatus string no null Optional client status. One of: suspect, lead, client.
domain string yes Primary domain to scan (e.g. "example.com").
extraFieldsJson string no null Optional JSON object of additional fields to merge into the request body for forward compatibility.
organizationName string yes Organization name to associate with the scan.
telivy_get_external_scan parameters
Param Type Required Default Description
id string yes External scan ID.
telivy_get_external_scan_breach_data parameters
Param Type Required Default Description
id string yes External scan ID.
telivy_get_external_scan_finding_detail parameters
Param Type Required Default Description
id string yes External scan ID.
slug string yes Finding slug, e.g. "open-port".
telivy_get_external_scan_findings parameters
Param Type Required Default Description
id string yes External scan ID.
telivy_get_external_scan_report parameters
Param Type Required Default Description
detailed boolean no null Optional. Set true for a detailed report; false for the executive summary. Defaults to Telivy's default (typically false).
format string no "pdf" Output format. One of: pdf, docx. Defaults to pdf.
id string yes External scan ID.
telivy_list_external_scans parameters
Param Type Required Default Description
assessmentSortBy string no null Sort field. One of: organizationName, assessmentStatus, createdAt, updatedAt. Defaults to createdAt.
limit integer no 50 Page size (default 50, max 100).
offset integer no 0 Pagination offset (0-indexed). Default 0.
search string no null Free-text search across organization name, domain, and contact fields.
sortOrder string no null Sort order: ASC or DESC. Defaults to DESC.
telivy_rescan_external_scan_devices parameters
Param Type Required Default Description
id string yes External scan ID.
telivy_uninstall_external_scan_devices parameters
Param Type Required Default Description
id string yes External scan ID.
telivy_update_external_scan parameters
Param Type Required Default Description
clientCategory string no null Optional client category. One of: breakfix, it_only, security_only, it_and_security.
clientStatus string no null Optional client status. One of: suspect, lead, client.
domain string yes Primary domain.
extraFieldsJson string no null Optional JSON object of additional fields to merge into the request body.
id string yes External scan ID.
organizationName string yes Organization name.

Risk Assessments

Tool Plan Access Description
telivy_convert_to_risk_assessment Free Write [Telivy] Convert a Telivy 'application' (incomplete/partial assessment) into a full risk assessment. Use when an external scan has graduated to deep-scan readiness and you want to enable agent deployment + deep-scan reporting.
telivy_create_risk_assessment Free Write [Telivy] Create a new deep-scan risk assessment. Requires organizationName and domain. Optional fields configure light vs full scan, antivirus integration, and PII jurisdiction.
telivy_get_risk_assessment Free Read-only [Telivy] Returns a single risk assessment with full scan status, monitoring config, executive summary, and assessment details. Use telivy_list_risk_assessments to discover IDs.
telivy_get_risk_assessment_device Free Read-only [Telivy] Returns full details for a single deep-scan device — OS, deep-scan findings, encryption status, open ports, security grades, browser-saved passwords, and PII inventory. Use telivy_list_risk_assessment_devices to discover deviceId values.
telivy_get_risk_assessment_domain_change_preview Free Read-only [Telivy] Returns a preview of what would change if the assessment's primary domain were updated — affected scans, agents, and findings. Use before performing a destructive domain change to surface impact.
telivy_get_risk_assessment_gws_users Free Read-only [Telivy] Returns the Google Workspace user inventory for the assessment, including login status, last login timestamps, and 2-Step Verification enrollment per user. Use to find accounts without 2SV before triaging MFA gaps.
telivy_get_risk_assessment_m365_users Free Read-only [Telivy] Returns the Microsoft 365 user inventory for the assessment, including login status, MFA enrollment per user, and recent login failure events. Use to surface MFA-disabled accounts and suspicious login activity.
telivy_get_risk_assessment_pii_summary Free Read-only [Telivy] Returns the PII exposure summary across all deep-scanned devices — counts of SSNs, credit cards, financial records, health records, etc., and per-device distribution. Useful for compliance reporting and risk prioritization.
telivy_get_risk_assessment_report Free Read-only [Telivy] Generates and downloads a risk assessment report. The binary is uploaded to StackJack blob storage and returned as a short-lived (~3 minute) read-only SAS URL. Supported reportType values: executive_security_summary_pdf, telivy_complete_report_pdf, telivy_complete_report_docx, telivy_external_scan_report_pdf, telivy_network_inventory_report_csv, internal_vulnerabilities_top_pdf, internal_vulnerabilities_executive_pdf, internal_vulnerabilities_network_pdf, internal_vulnerabilities_detailed_csv, applications_security_overview_csv, applications_security_detailed_csv, data_security_sensitive_documents_csv, data_security_detailed_risk_xlsx, telivy_passwords_report_csv, telivy_passwords_reuse_report_csv, telivy_dark_web_report_csv, m365_security_report_pdf, m365_security_data_report_xlsx, gws_security_report_pdf, gws_security_data_report_xlsx, legacy_complete_report_pdf.
telivy_get_risk_assessment_scan_status Free Read-only [Telivy] Returns scan completion status across all devices in a risk assessment — counts by status (queued, scanning, completed, failed) and per-device summaries. Use to monitor scan progress before pulling a fresh report.
telivy_list_risk_assessment_devices Free Read-only [Telivy] List all deep-scan devices (endpoints with the Telivy agent installed) belonging to a risk assessment. Each entry includes device ID, hostname, OS, scan timestamps, and high-level scan status. Use telivy_get_risk_assessment_device for full per-device findings.
telivy_list_risk_assessments Free Read-only [Telivy] List risk assessments (deep-scan agent-based assessments). Returns scan status, monitoring frequency, executive summary scores, and assessment metadata. Use to discover assessment IDs for downstream device, user, PII, and report tools.
telivy_rescan_risk_assessment_device Free Write [Telivy] Triggers an out-of-band rescan on a single deep-scan device. Useful after remediation actions (e.g. enabling BitLocker, closing a port) when you want to verify the fix without waiting for the next scheduled scan.
telivy_update_risk_assessment Free Write [Telivy] Update a risk assessment's organization metadata. Pass-through PUT with the same fields used in create. Idempotent: replaying the same body produces the same end-state.
telivy_update_risk_assessment_monitoring_settings Free Write [Telivy] Update the monitoring frequency for a risk assessment. Pass DISABLE to turn off monitoring, or QUARTERLY/MONTHLY/WEEKLY to set a recurring scan cadence. Idempotent: replaying the same body produces the same end-state.
telivy_convert_to_risk_assessment parameters
Param Type Required Default Description
id string yes Application/assessment ID to convert.
telivy_create_risk_assessment parameters
Param Type Required Default Description
antiVirus string no null Optional. Antivirus product the customer uses; surfaces in compatibility checks.
cleanupDomainChange boolean no null Optional. When true, signals to clean up after a domain change. Default false.
clientCategory string no null Optional client category. One of: breakfix, it_only, security_only, it_and_security.
clientStatus string no null Optional client status. One of: suspect, lead, client.
country string no null Optional. PII jurisdiction code. One of: US, CA, UK, ZA, AU, NZ, SG, PL. Defaults to US.
domain string yes Primary domain.
extraFieldsJson string no null Optional JSON object of additional fields to merge into the request body.
isLightScan boolean no null Optional. When true, creates a lightweight scan (faster, less detailed). Default false.
organizationName string yes Organization name.
telivy_get_risk_assessment parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_get_risk_assessment_device parameters
Param Type Required Default Description
deviceId string yes Device ID within the assessment.
id string yes Risk assessment ID.
telivy_get_risk_assessment_domain_change_preview parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_get_risk_assessment_gws_users parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_get_risk_assessment_m365_users parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_get_risk_assessment_pii_summary parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_get_risk_assessment_report parameters
Param Type Required Default Description
id string yes Risk assessment ID.
reportType string no null Report type identifier. See tool description for the full list of supported values.
telivy_get_risk_assessment_scan_status parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_list_risk_assessment_devices parameters
Param Type Required Default Description
id string yes Risk assessment ID.
telivy_list_risk_assessments parameters
Param Type Required Default Description
assessmentSortBy string no null Sort field. One of: organizationName, assessmentStatus, createdAt, updatedAt. Defaults to createdAt.
limit integer no 50 Page size (default 50, max 100).
offset integer no 0 Pagination offset (0-indexed). Default 0.
scanStatusCsv string no null Optional comma-separated scan statuses to filter by. Each value is one of: not_started, in_progress, report_completed, archived.
search string no null Free-text search across organization name, domain, and contact fields.
sortOrder string no null Sort order: ASC or DESC. Defaults to DESC.
telivy_rescan_risk_assessment_device parameters
Param Type Required Default Description
deviceId string yes Device ID within the assessment.
id string yes Risk assessment ID.
telivy_update_risk_assessment parameters
Param Type Required Default Description
antiVirus string no null Optional. Antivirus product the customer uses.
cleanupDomainChange boolean no null Optional. cleanup-domain-change flag.
clientCategory string no null Optional client category. One of: breakfix, it_only, security_only, it_and_security.
clientStatus string no null Optional client status. One of: suspect, lead, client.
country string no null Optional. PII jurisdiction code. One of: US, CA, UK, ZA, AU, NZ, SG, PL.
domain string yes Primary domain.
extraFieldsJson string no null Optional JSON object of additional fields to merge into the request body.
id string yes Risk assessment ID.
isLightScan boolean no null Optional. is-light-scan flag.
organizationName string yes Organization name.
telivy_update_risk_assessment_monitoring_settings parameters
Param Type Required Default Description
id string yes Risk assessment ID.
monitoringFrequency string yes Monitoring frequency. One of: DISABLE, QUARTERLY, MONTHLY, WEEKLY.