api/3-administration-license

License License

api/3-administration

Console Commands Information Properties Settings

api/3-asset groups-{id}-assets-{asset Id}

Asset Group Asset Asset Group Asset

api/3-asset groups-{id}-assets

Asset Group Assets Asset Group Assets Asset Group Assets

api/3-asset groups-{id}-search criteria

Asset Group Search Criteria Asset Group Search Criteria

api/3-asset groups-{id}-tags-{tag Id}

Resources and operations for managing asset groups Resources and operations for managing asset groups

api/3-asset groups-{id}-tags

Asset Group Tags Asset Group Tags Asset Group Tags

api/3-asset groups-{id}-users-{user Id}

Asset Group User Asset Group User

api/3-asset groups-{id}-users

Asset Group Users Asset Group Users

api/3-asset groups-{id}

Asset Group Asset Group Asset Group

api/3-asset groups

Asset Groups Asset Groups

api/3-assets-{asset Id}/policies-{policy Id}-groups/{group Id}

Policy Rules or Groups Directly Under Policy Group For Asset Policy Rules Under Policy Group For Asset

api/3-assets-{asset Id}/policies-{policy Id}

Policy Rules or Groups Directly Under Policy For Asset Policy Rules For Asset

api/3-assets-{asset Id}/policies

Policies For Asset

api/3-assets-{id}-services-{protocol}/{port}-web applications

Asset Service Web Applications Asset Service Web Application

api/3-assets-{id}-services-{protocol}/{port}

Asset Service Asset Service Configurations Asset Service Databases Asset Service User Groups Asset Service Users Asset Service Vulnerabilities

api/3-assets-{id}-services

api/3-assets-{id}-tags-{tag Id}

Asset Tag Asset Tag

api/3-assets-{id}-tags

api/3-assets-{id}-vulnerabilities-{vulnerability Id}-validations-{validation Id}

Asset Vulnerability Validation Asset Vulnerability Validation

api/3-assets-{id}-vulnerabilities-{vulnerability Id}-validations

Asset Vulnerability Validations Asset Vulnerability Validations

api/3-assets-{id}-vulnerabilities-{vulnerability Id}

Asset Vulnerability Asset Vulnerability Solution

api/3-assets-{id}-vulnerabilities

Asset Vulnerabilities

api/3-assets-{id}

Asset Asset Asset Databases Asset Files Asset Policy Overrides Asset Software Asset User Groups Asset Users

Assets Asset Search

api/3-authentication sources-{id}

Authentication Source Authentication Source Users

api/3-authentication sources

Authentication Sources

api/3-discovery connections-{id}

Discovery Connection Discovery Connection Reconnect

api/3-discovery connections

Discovery Connections

api/3-exploits-{id}

Exploit Exploitable Vulnerabilities

api/3-malware kits-{id}

Malware Kit Malware Kit Vulnerabilities

api/3-malware kits

api/3-operating systems

Operating Systems Operating System

api/3-policies-{policy Id}-assets

Policy Asset Results Policy Asset Result

api/3-policies-{policy Id}-groups-{group Id}-assets

Assets Compliance For Policy Rules Under Policy Group Asset Compliance For Policy Rules Under Policy Group

api/3-policies-{policy Id}-groups-{group Id}

Policy Group Policy Rules or Groups Directly Under Policy Group Policy Rules Under Policy Group

api/3-policies-{policy Id}-groups

api/3-policies-{policy Id}-rules-{rule Id}-assets-{asset Id}

Asset Compliance For Policy Rule Policy Rule Proof For Asset

api/3-policies-{policy Id}-rules-{rule Id}-assets

Assets Compliance For Policy Rule

api/3-policies-{policy Id}-rules-{rule Id}

Policy Rule Policy Rule Controls Policy Rule Rationale Policy Rule Remediation

api/3-policies-{policy Id}-rules

Policy Rules Disabled Policy Rules

api/3-policies-{policy Id}

Policies Policy Rules or Groups Directly Under Policy

api/3-policy overrides-{id}-expires

Policy Override Expiration Policy Override Expiration

api/3-policy overrides-{id}

Policy Override Policy Override Policy Override Status

api/3-policy overrides

Policy Overrides Policy Overrides

api/3-privileges-{id}

Privilege Users With Privilege

api/3-privileges

api/3-report templates

Report Templates Report Template

api/3-reports-{id}-history-{instance}

Report History Report History Report Download

api/3-reports-{id}-history

Report Histories

api/3-reports-{id}

Report Report Report Report Generation

Reports Reports

api/3-roles-{id}

Role Role Role Users With Role

api/3-scan engine pools-{id}-engines-{engine Id}

Engine Pool Engines Engine Pool Engines

api/3-scan engine pools-{id}-engines

Engine Pool Engines Engine Pool Engines

api/3-scan engine pools-{id}

Engine Pool Engine Pool Engine Pool Engine Pool Sites

api/3-scan engine pools

Engine Pools Engine Pools

api/3-scan engines-shared secret

Scan Engine Shared Secret Scan Engine Shared Secret Scan Engine Shared Secret Scan Engine Shared Secret Time to live

api/3-scan engines-{id}

Scan Engine Scan Engine Scan Engine Assigned Engine Pools Scan Engine Scans Scan Engine Sites

api/3-scan engines

Scan Engines Scan Engines

api/3-scan templates-{id}

Scan Template Scan Template Scan Template

api/3-scan templates

Scan Templates Scan Templates

api/3-scans-{id}

Scan Scan Status

api/3-shared credentials-{id}

Shared Credential Shared Credential Shared Credential

api/3-shared credentials

Shared Credentials Shared Credentials Shared Credentials

api/3-sites-{id}-alerts-smtp-{alert Id}

Site SMTP Alert Site SMTP Alert Site SMTP Alert

api/3-sites-{id}-alerts-smtp

Site SMTP Alerts Site SMTP Alerts Site SMTP Alerts Site SMTP Alerts

api/3-sites-{id}-alerts-snmp-{alert Id}

Site SNMP Alert Site SNMP Alert Site SNMP Alert

api/3-sites-{id}-alerts-snmp

Site SNMP Alerts Site SNMP Alerts Site SNMP Alerts Site SNMP Alerts

api/3-sites-{id}-alerts-syslog-{alert Id}

Site Syslog Alert Site Syslog Alert Site Syslog Alert

api/3-sites-{id}-alerts-syslog

Site Syslog Alerts Site Syslog Alerts Site Syslog Alerts Site Syslog Alerts

api/3-sites-{id}-alerts

Site Alerts Site Alerts

api/3-sites-{id}-assets

Site Assets Site Assets Assets Site Asset

api/3-sites-{id}-discovery connection

Site Discovery Connection Site Discovery Connection

api/3-sites-{id}-discovery search criteria

Site Discovery Search Criteria Site Discovery Search Criteria

api/3-sites-{id}-excluded asset groups

Site Excluded Asset Groups Site Excluded Asset Groups Site Excluded Asset Groups Site Excluded Asset Group

api/3-sites-{id}-excluded targets

Site Excluded Targets Site Excluded Targets Site Excluded Targets Site Excluded Targets

api/3-sites-{id}-included asset groups

Site Included Asset Groups Site Included Asset Groups Site Included Asset Groups Site Included Asset Group

api/3-sites-{id}-included targets

Site Included Targets Site Included Targets Site Included Targets Site Included Targets

api/3-sites-{id}-organization

Site Organization Information Site Organization Information

api/3-sites-{id}-scan engine

Site Scan Engine Site Scan Engine

api/3-sites-{id}-scan schedules-{schedule Id}

Site Scan Schedule Site Scan Schedule Site Scan Schedule

api/3-sites-{id}-scan schedules

Site Scan Schedules Site Scan Schedules Site Scan Schedules Site Scan Schedules

api/3-sites-{id}-scan template

Site Scan Template Site Scan Template

api/3-sites-{id}-scans

Site Scans Site Scans

api/3-sites-{id}-shared credentials

Assigned Shared Credentials Assigned Shared Credential Enablement

api/3-sites-{id}-site credentials-{credential Id}

Site Scan Credential Site Scan Credential Site Scan Credential Site Credential Enablement

api/3-sites-{id}-site credentials

Site Scan Credentials Site Scan Credentials Site Scan Credentials Site Scan Credentials

api/3-sites-{id}-tags-{tag Id}

Site Tag Site Tag

api/3-sites-{id}-tags

Site Tags Site Tags

api/3-sites-{id}-users

Site Users Access Site Users Access Site Users Access Site User Access

api/3-sites-{id}-web authentication

Web Authentication HTML Forms Web Authentication HTTP Headers

api/3-sites-{id}

Software Software

api/3-solutions-{id}

Solution Solution Prerequisites Superseded Solutions Superseding Solutions

api/3-solutions

api/3-sonar queries-{id}

Sonar Query Sonar Query Sonar Query Sonar Query Assets

api/3-sonar queries

Sonar Queries Sonar Queries Sonar Query Search

api/3-tags-{id}-asset groups-{asset Group Id}

Tag Asset Group Tag Asset Group

api/3-tags-{id}-asset groups

Tag Asset Groups Tag Asset Groups Tag Asset Groups

api/3-tags-{id}-assets-{asset Id}

Tag Asset Tag Asset

api/3-tags-{id}-assets

api/3-tags-{id}-search criteria

Tag Search Criteria Tag Search Criteria Tag Search Criteria

api/3-tags-{id}-sites-{site Id}

Tag Site Tag Site

api/3-tags-{id}-sites

Tag Sites Tag Sites Tag Sites

api/3-tags-{id}

api/3-users-{id}-2FA

TwoFactor Authentication TwoFactor Authentication TwoFactor Authentication

api/3-users-{id}-asset groups-{asset Group Id}

Asset Group Access Asset Group Access

api/3-users-{id}-asset groups

Asset Groups Access Asset Groups Access Asset Groups Access

api/3-users-{id}-sites-{site Id}

Site Access Site Access

api/3-users-{id}-sites

Sites Access Sites Access Sites Access

api/3-users-{id}

User User User Unlock Account Password Reset User Privileges

api/3-vulnerabilities-{id}

Vulnerability Vulnerability Affected Assets Vulnerability Checks Vulnerability Exploits Vulnerability Malware Kits Vulnerability References Vulnerability Solutions

api/3-vulnerabilities

Vulnerabilities

api/3-vulnerability categories-{id}

Category Category Vulnerabilities

api/3-vulnerability categories

api/3-vulnerability checks

api/3-vulnerability exceptions-{id}-expires

Exception Expiration Exception Expiration

api/3-vulnerability exceptions-{id}

Exception Exception Exception Status

api/3-vulnerability exceptions

Exceptions Exceptions

api/3-vulnerability references-{id}

Reference Reference Vulnerabilities

api/3-vulnerability references

Resources Agents Policy Compliance Summaries Report Formats Check Types

api/3-administration-license

License License

api/3-administration

Console Commands Information Properties Settings

api/3-asset groups-{id}-assets-{asset Id}

Asset Group Asset Asset Group Asset

api/3-asset groups-{id}-assets

Asset Group Assets Asset Group Assets Asset Group Assets

api/3-asset groups-{id}-search criteria

Asset Group Search Criteria Asset Group Search Criteria

api/3-asset groups-{id}-tags-{tag Id}

Resources and operations for managing asset groups Resources and operations for managing asset groups

api/3-asset groups-{id}-tags

Asset Group Tags Asset Group Tags Asset Group Tags

api/3-asset groups-{id}-users-{user Id}

Asset Group User Asset Group User

api/3-asset groups-{id}-users

Asset Group Users Asset Group Users

api/3-asset groups-{id}

Asset Group Asset Group Asset Group

api/3-asset groups

Asset Groups Asset Groups

api/3-assets-{asset Id}/policies-{policy Id}-groups/{group Id}

Policy Rules or Groups Directly Under Policy Group For Asset Policy Rules Under Policy Group For Asset

api/3-assets-{asset Id}/policies-{policy Id}

Policy Rules or Groups Directly Under Policy For Asset Policy Rules For Asset

api/3-assets-{asset Id}/policies

Policies For Asset

api/3-assets-{id}-services-{protocol}/{port}-web applications

Asset Service Web Applications Asset Service Web Application

api/3-assets-{id}-services-{protocol}/{port}

Asset Service Asset Service Configurations Asset Service Databases Asset Service User Groups Asset Service Users Asset Service Vulnerabilities

api/3-assets-{id}-services

api/3-assets-{id}-tags-{tag Id}

Asset Tag Asset Tag

api/3-assets-{id}-tags

api/3-assets-{id}-vulnerabilities-{vulnerability Id}-validations-{validation Id}

Asset Vulnerability Validation Asset Vulnerability Validation

api/3-assets-{id}-vulnerabilities-{vulnerability Id}-validations

Asset Vulnerability Validations Asset Vulnerability Validations

api/3-assets-{id}-vulnerabilities-{vulnerability Id}

Asset Vulnerability Asset Vulnerability Solution

api/3-assets-{id}-vulnerabilities

Asset Vulnerabilities

api/3-assets-{id}

Asset Asset Asset Databases Asset Files Asset Policy Overrides Asset Software Asset User Groups Asset Users

Assets Asset Search

api/3-authentication sources-{id}

Authentication Source Authentication Source Users

api/3-authentication sources

Authentication Sources

api/3-discovery connections-{id}

Discovery Connection Discovery Connection Reconnect

api/3-discovery connections

Discovery Connections

api/3-exploits-{id}

Exploit Exploitable Vulnerabilities

api/3-malware kits-{id}

Malware Kit Malware Kit Vulnerabilities

api/3-malware kits

api/3-operating systems

Operating Systems Operating System

api/3-policies-{policy Id}-assets

Policy Asset Results Policy Asset Result

api/3-policies-{policy Id}-groups-{group Id}-assets

Assets Compliance For Policy Rules Under Policy Group Asset Compliance For Policy Rules Under Policy Group

api/3-policies-{policy Id}-groups-{group Id}

Policy Group Policy Rules or Groups Directly Under Policy Group Policy Rules Under Policy Group

api/3-policies-{policy Id}-groups

api/3-policies-{policy Id}-rules-{rule Id}-assets-{asset Id}

Asset Compliance For Policy Rule Policy Rule Proof For Asset

api/3-policies-{policy Id}-rules-{rule Id}-assets

Assets Compliance For Policy Rule

api/3-policies-{policy Id}-rules-{rule Id}

Policy Rule Policy Rule Controls Policy Rule Rationale Policy Rule Remediation

api/3-policies-{policy Id}-rules

Policy Rules Disabled Policy Rules

api/3-policies-{policy Id}

Policies Policy Rules or Groups Directly Under Policy

api/3-policy overrides-{id}-expires

Policy Override Expiration Policy Override Expiration

api/3-policy overrides-{id}

Policy Override Policy Override Policy Override Status

api/3-policy overrides

Policy Overrides Policy Overrides

api/3-privileges-{id}

Privilege Users With Privilege

api/3-privileges

api/3-report templates

Report Templates Report Template

api/3-reports-{id}-history-{instance}

Report History Report History Report Download

api/3-reports-{id}-history

Report Histories

api/3-reports-{id}

Report Report Report Report Generation

Reports Reports

api/3-roles-{id}

Role Role Role Users With Role

api/3-scan engine pools-{id}-engines-{engine Id}

Engine Pool Engines Engine Pool Engines

api/3-scan engine pools-{id}-engines

Engine Pool Engines Engine Pool Engines

api/3-scan engine pools-{id}

Engine Pool Engine Pool Engine Pool Engine Pool Sites

api/3-scan engine pools

Engine Pools Engine Pools

api/3-scan engines-shared secret

Scan Engine Shared Secret Scan Engine Shared Secret Scan Engine Shared Secret Scan Engine Shared Secret Time to live

api/3-scan engines-{id}

Scan Engine Scan Engine Scan Engine Assigned Engine Pools Scan Engine Scans Scan Engine Sites

api/3-scan engines

Scan Engines Scan Engines

api/3-scan templates-{id}

Scan Template Scan Template Scan Template

api/3-scan templates

Scan Templates Scan Templates

api/3-scans-{id}

Scan Scan Status

api/3-shared credentials-{id}

Shared Credential Shared Credential Shared Credential

api/3-shared credentials

Shared Credentials Shared Credentials Shared Credentials

api/3-sites-{id}-alerts-smtp-{alert Id}

Site SMTP Alert Site SMTP Alert Site SMTP Alert

api/3-sites-{id}-alerts-smtp

Site SMTP Alerts Site SMTP Alerts Site SMTP Alerts Site SMTP Alerts

api/3-sites-{id}-alerts-snmp-{alert Id}

Site SNMP Alert Site SNMP Alert Site SNMP Alert

api/3-sites-{id}-alerts-snmp

Site SNMP Alerts Site SNMP Alerts Site SNMP Alerts Site SNMP Alerts

api/3-sites-{id}-alerts-syslog-{alert Id}

Site Syslog Alert Site Syslog Alert Site Syslog Alert

api/3-sites-{id}-alerts-syslog

Site Syslog Alerts Site Syslog Alerts Site Syslog Alerts Site Syslog Alerts

api/3-sites-{id}-alerts

Site Alerts Site Alerts

api/3-sites-{id}-assets

Site Assets Site Assets Assets Site Asset

api/3-sites-{id}-discovery connection

Site Discovery Connection Site Discovery Connection

api/3-sites-{id}-discovery search criteria

Site Discovery Search Criteria Site Discovery Search Criteria

api/3-sites-{id}-excluded asset groups

Site Excluded Asset Groups Site Excluded Asset Groups Site Excluded Asset Groups Site Excluded Asset Group

api/3-sites-{id}-excluded targets

Site Excluded Targets Site Excluded Targets Site Excluded Targets Site Excluded Targets

api/3-sites-{id}-included asset groups

Site Included Asset Groups Site Included Asset Groups Site Included Asset Groups Site Included Asset Group

api/3-sites-{id}-included targets

Site Included Targets Site Included Targets Site Included Targets Site Included Targets

api/3-sites-{id}-organization

Site Organization Information Site Organization Information

api/3-sites-{id}-scan engine

Site Scan Engine Site Scan Engine

api/3-sites-{id}-scan schedules-{schedule Id}

Site Scan Schedule Site Scan Schedule Site Scan Schedule

api/3-sites-{id}-scan schedules

Site Scan Schedules Site Scan Schedules Site Scan Schedules Site Scan Schedules

api/3-sites-{id}-scan template

Site Scan Template Site Scan Template

api/3-sites-{id}-scans

Site Scans Site Scans

api/3-sites-{id}-shared credentials

Assigned Shared Credentials Assigned Shared Credential Enablement

api/3-sites-{id}-site credentials-{credential Id}

Site Scan Credential Site Scan Credential Site Scan Credential Site Credential Enablement

api/3-sites-{id}-site credentials

Site Scan Credentials Site Scan Credentials Site Scan Credentials Site Scan Credentials

api/3-sites-{id}-tags-{tag Id}

Site Tag Site Tag

api/3-sites-{id}-tags

Site Tags Site Tags

api/3-sites-{id}-users

Site Users Access Site Users Access Site Users Access Site User Access

api/3-sites-{id}-web authentication

Web Authentication HTML Forms Web Authentication HTTP Headers

api/3-sites-{id}

Software Software

api/3-solutions-{id}

Solution Solution Prerequisites Superseded Solutions Superseding Solutions

api/3-solutions

api/3-sonar queries-{id}

Sonar Query Sonar Query Sonar Query Sonar Query Assets

api/3-sonar queries

Sonar Queries Sonar Queries Sonar Query Search

api/3-tags-{id}-asset groups-{asset Group Id}

Tag Asset Group Tag Asset Group

api/3-tags-{id}-asset groups

Tag Asset Groups Tag Asset Groups Tag Asset Groups

api/3-tags-{id}-assets-{asset Id}

Tag Asset Tag Asset

api/3-tags-{id}-assets

api/3-tags-{id}-search criteria

Tag Search Criteria Tag Search Criteria Tag Search Criteria

api/3-tags-{id}-sites-{site Id}

Tag Site Tag Site

api/3-tags-{id}-sites

Tag Sites Tag Sites Tag Sites

api/3-tags-{id}

api/3-users-{id}-2FA

TwoFactor Authentication TwoFactor Authentication TwoFactor Authentication

api/3-users-{id}-asset groups-{asset Group Id}

Asset Group Access Asset Group Access

api/3-users-{id}-asset groups

Asset Groups Access Asset Groups Access Asset Groups Access

api/3-users-{id}-sites-{site Id}

Site Access Site Access

api/3-users-{id}-sites

Sites Access Sites Access Sites Access

api/3-users-{id}

User User User Unlock Account Password Reset User Privileges

api/3-vulnerabilities-{id}

Vulnerability Vulnerability Affected Assets Vulnerability Checks Vulnerability Exploits Vulnerability Malware Kits Vulnerability References Vulnerability Solutions

api/3-vulnerabilities

Vulnerabilities

api/3-vulnerability categories-{id}

Category Category Vulnerabilities

api/3-vulnerability categories

api/3-vulnerability checks

api/3-vulnerability exceptions-{id}-expires

Exception Expiration Exception Expiration

api/3-vulnerability exceptions-{id}

Exception Exception Exception Status

api/3-vulnerability exceptions

Exceptions Exceptions

api/3-vulnerability references-{id}

Reference Reference Vulnerabilities

api/3-vulnerability references

Resources Agents Policy Compliance Summaries Report Formats Check Types

Home InsightVM API api/3-roles-{id}Role

Role

GET {{baseUrl}}/api/3/roles/:id

Retrieves the details of a role.

HEADERS

Key	Datatype	Required	Description
`Content-Type`	null