Tenable Security Center
Connector for Tenable Security Center API Integration
Capabilities
This connector provides the following capabilities:
- Add A Analysis
- Add A Scan
- Add Asset Group
- Download Scan Results
- Get Asset
- Get Credentials
- Get Policies
- Get Repositories
- Get Scan Results
- Get Scans
- Run Scan
- Get List Queries
- Get Alert
- Get Hosts
Asset Setup
The asset for this connector requires the following inputs:
- Access Key
- Secret Key
Configurations
Tenable SC API Key Authentication
Authenticates using an API Key
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host | string | Required |
access_key | Access key | string | Required |
secret_key | Secret key | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Add Analysis
Processes a query for analysis
Endpoint
- URL: rest/analysis
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
type | string | Optional | Type of the resource |
query | object | Optional | Parameter for Add Analysis |
query.id | number | Optional | Unique identifier |
sortDir | string | Optional | Parameter for Add Analysis |
sortField | string | Optional | Parameter for Add Analysis |
sourceType | string | Optional | Type of the resource |
startOffset | number | Optional | Parameter for Add Analysis |
endOffset | number | Optional | Parameter for Add Analysis |
scanID | number | Optional | Unique identifier |
view | string | Optional | Parameter for Add Analysis |
Input Example
{"json_body":{"type":"vuln","query":{"id":12345},"sortDir":"ASC","sortField":"field1","sourceType":"individual","startOffset":0,"endOffset":100,"scanID":67890,"view":"all"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.totalRecords | string | Output field: response.totalRecords |
response.returnedRecords | number | Output field: response.returnedRecords |
response.startOffset | string | Output field: response.startOffset |
response.endOffset | string | Output field: response.endOffset |
response.matchingDataElementCount | string | Response data |
response.results | array | Result of the operation |
response.results.pluginID | string | Unique identifier |
response.results.severity | object | Result of the operation |
response.results.severity.id | string | Unique identifier |
response.results.severity.name | string | Name of the resource |
response.results.severity.description | string | Result of the operation |
response.results.vprScore | string | Result of the operation |
response.results.vprContext | array | Result of the operation |
response.results.vprContext.id | string | Unique identifier |
response.results.vprContext.name | string | Name of the resource |
response.results.vprContext.value | string | Value for the parameter |
response.results.vprContext.type | string | Type of the resource |
response.results.vprContext.name | string | Name of the resource |
response.results.ip | string | Result of the operation |
response.results.uuid | string | Unique identifier |
response.results.port | string | Result of the operation |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"totalRecords":"1","returnedRecords":1,"startOffset":"0","endOffset":"50","matchingDataElementCount":"-1","results":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1553525692}}
Add Group
Adds a group
Endpoint
- URL: rest/group
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Name of the resource |
description | string | Optional | Parameter for Add Group |
createDefaultObjects | string | Optional | Parameter for Add Group |
repositories | array | Optional | Parameter for Add Group |
repositories.id | number | Optional | Unique identifier |
lces | array | Optional | Parameter for Add Group |
lces.id | number | Optional | Unique identifier |
definingAssets | array | Optional | Parameter for Add Group |
definingAssets.id | number | Optional | Unique identifier |
assets | array | Optional | Parameter for Add Group |
assets.id | number | Optional | Unique identifier |
policies | array | Optional | Parameter for Add Group |
policies.id | number | Optional | Unique identifier |
queries | array | Optional | Parameter for Add Group |
queries.id | number | Optional | Unique identifier |
credentials | array | Optional | Parameter for Add Group |
credentials.id | number | Optional | Unique identifier |
dashboardTabs | array | Optional | Parameter for Add Group |
dashboardTabs.id | number | Optional | Unique identifier |
arcs | array | Optional | Parameter for Add Group |
arcs.id | number | Optional | Unique identifier |
auditFiles | array | Optional | Parameter for Add Group |
auditFiles.id | number | Optional | Unique identifier |
Input Example
{"json_body":{"name":"dummyName","description":"dummyDescription","createDefaultObjects":"false","repositories":[{"id":12345}],"lces":[{"id":67890}],"definingAssets":[{"id":12345}],"assets":[{"id":67890}],"policies":[{"id":12345}],"queries":[{"id":67890}],"credentials":[{"id":12345}],"dashboardTabs":[{"id":67890}],"arcs":[{"id":12345}],"auditFiles":[{"id":67890}]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
response.description | string | Output field: response.description |
response.createdTime | string | Time value |
response.modifiedTime | string | Time value |
response.lces | array | Output field: response.lces |
response.lces.id | string | Unique identifier |
response.lces.name | string | Name of the resource |
response.lces.description | string | Output field: response.lces.description |
response.lces.version | string | Output field: response.lces.version |
response.repositories | array | Output field: response.repositories |
response.repositories.id | string | Unique identifier |
response.repositories.name | string | Name of the resource |
response.repositories.description | string | Output field: response.repositories.description |
response.repositories.lastVulnUpdate | string | Date value |
response.repositories.type | string | Type of the resource |
response.repositories.dataFormat | string | Response data |
response.repositories.uuid | string | Unique identifier |
response.definingAssets | array | Output field: response.definingAssets |
response.definingAssets.id | string | Unique identifier |
response.definingAssets.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"id":"5","name":"Full Access Group test","description":"","createdTime":"1436551970","modifiedTime":"1445892755","lces":[],"repositories":[],"definingAssets":[],"userCount":0,"users":[],"createDefaultObjects":"false","assets":[],"policies":[],"queries":[],"credentials":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1445892755}}
Add Scan
Adds a Scan, depending on access and permissions
Endpoint
- URL: rest/scan
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Name of the resource |
type | string | Optional | Type of the resource |
description | string | Optional | Parameter for Add Scan |
repository | object | Optional | Parameter for Add Scan |
repository.id | number | Optional | Unique identifier |
zone | object | Optional | Parameter for Add Scan |
zone.id | number | Optional | Unique identifier |
dhcpTracking | string | Optional | Parameter for Add Scan |
classifyMitigatedAge | number | Optional | Parameter for Add Scan |
schedule | object | Optional | Parameter for Add Scan |
schedule.type | string | Optional | Type of the resource |
reports | array | Optional | Parameter for Add Scan |
reports.id | number | Optional | Unique identifier |
reports.reportSource | string | Optional | Parameter for Add Scan |
assets | array | Optional | Parameter for Add Scan |
assets.id | number | Optional | Unique identifier |
credentials | array | Optional | Parameter for Add Scan |
credentials.id | number | Optional | Unique identifier |
emailOnLaunch | string | Optional | Parameter for Add Scan |
emailOnFinish | string | Optional | Parameter for Add Scan |
timeoutAction | string | Optional | Parameter for Add Scan |
scanningVirtualHosts | string | Optional | Parameter for Add Scan |
rolloverType | string | Optional | Type of the resource |
ipList | string | Optional | Parameter for Add Scan |
maxScanTime | number | Optional | Time value |
Input Example
{"json_body":{"name":"dummyName","type":"policy","description":"dummyDescription","repository":{"id":12345},"zone":{"id":0},"dhcpTracking":"false","classifyMitigatedAge":0,"schedule":{"type":"template"},"reports":[{"id":67890,"reportSource":"cumulative"}],"assets":[{"id":12345}],"credentials":[{"id":67890}],"emailOnLaunch":"false","emailOnFinish":"false","timeoutAction":"import","scanningVirtualHosts":"false","rolloverType":"template","ipList":"192.168.1.1","maxScanTime":3600}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
response.description | string | Output field: response.description |
response.ipList | string | Output field: response.ipList |
response.type | string | Type of the resource |
response.policyID | string | Unique identifier |
response.pluginID | string | Unique identifier |
response.zoneID | string | Unique identifier |
response.dhcpTracking | string | Output field: response.dhcpTracking |
response.classifyMitigatedAge | string | Output field: response.classifyMitigatedAge |
response.emailOnLaunch | string | Output field: response.emailOnLaunch |
response.emailOnFinish | string | Output field: response.emailOnFinish |
response.timeoutAction | string | Output field: response.timeoutAction |
response.scanningVirtualHosts | string | Output field: response.scanningVirtualHosts |
response.rolloverType | string | Type of the resource |
response.status | string | Status value |
response.createdTime | string | Time value |
response.modifiedTime | string | Time value |
response.maxScanTime | string | Time value |
response.ownerGID | string | Unique identifier |
response.reports | array | Output field: response.reports |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"id":"4","name":"POSTtest","description":"This is a test for POST","ipList":"","type":"policy","policyID":"1000002","pluginID":"-1","zoneID":"-1","dhcpTracking":"false","classifyMitigatedAge":"0","emailOnLaunch":"false","emailOnFinish":"false","timeoutAction":"import","scanningVirtualHosts":"false","rolloverType":"template"},"error_code":0,"error_msg":"","warnings":[],"timestamp":1406815242}}
Download Scan Results
Downloads the Scan Result associated with id
Endpoint
- URL: rest/scanResult/{{id}}/download
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.downloadType | string | Required | Parameters for the Download Scan Results action |
Input Example
{"path_parameters":{"downloadType":"v2"}}
Output
Parameter | Type | Description |
|---|---|---|
file | object | File |
file.file_name | string | Name of the resource |
file.file | string | Output field: file.file |
Output Example
{"file":{"file_name":"Example Name","file":"string"}}
Get Alert
Gets the list of Alerts
Endpoint
- URL: /rest/alert
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.fields | string | Optional | Specify the fields want to include in the response |
Input Example
{"parameters":{"fields":"id"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.status | string | Status value |
response.manageable | array | Output field: response.manageable |
response.manageable.id | string | Unique identifier |
response.manageable.name | string | Name of the resource |
response.manageable.description | string | Output field: response.manageable.description |
response.manageable.status | string | Status value |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 15 Apr 2024 06:31:29 GMT","Server":"Apache","X-Frame-Options":"DENY","Content-Security-Policy":"default-src 'self'; script-src 'self' pendo-io-static.storage.googleapis.com app...","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Expect-CT":"max-age=31536000","Strict-Transport-Security":"max-age=31536000; includeSubDomains","Vary":"x-apikey","Set-Cookie":"TNS_SESSIONID=07ece412570606c2d3fcf7cd39c26812; path=/; secure; Http...
Get Asset
Gets the Asset associated with id or uuid
Endpoint
- URL: rest/asset/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | Parameters for the Get Asset action |
parameters.fields | string | Optional | Parameters for the Get Asset action |
Input Example
{"parameters":{"fields":"field1,field2"},"path_parameters":{"id":"id_or_uuid"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
response.type | string | Type of the resource |
response.description | string | Output field: response.description |
response.tags | string | Output field: response.tags |
response.context | string | Output field: response.context |
response.status | string | Status value |
response.templateID | string | Unique identifier |
response.createdTime | string | Time value |
response.modifiedTime | string | Time value |
response.typeFields | object | Type of the resource |
response.typeFields.combinations | object | Type of the resource |
response.typeFields.combinations.operator | string | Type of the resource |
response.typeFields.combinations.operand1 | object | Type of the resource |
response.typeFields.combinations.operand1.id | string | Unique identifier |
response.typeFields.combinations.operand1.name | string | Name of the resource |
response.typeFields.combinations.operand1.description | string | Type of the resource |
response.typeFields.combinations.operand1.uuid | string | Unique identifier |
response.typeFields.combinations.operand2 | object | Type of the resource |
response.typeFields.combinations.operand2.id | string | Unique identifier |
response.typeFields.combinations.operand2.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"id":"33","name":"test","type":"combination","description":"","tags":"","context":"","status":"0","templateID":"-1","createdTime":"1412171859","modifiedTime":"1412171859","typeFields":{},"repositories":[],"ipCount":0,"groups":[],"assetDataFields":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1412273575}}
Get Credentials
Get the list of credentials
Endpoint
- URL: rest/credentials
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.type | string | Type of the resource |
response.usable.uuid | string | Unique identifier |
response.manageable | array | Output field: response.manageable |
response.manageable.id | string | Unique identifier |
response.manageable.name | string | Name of the resource |
response.manageable.description | string | Output field: response.manageable.description |
response.manageable.type | string | Type of the resource |
response.manageable.uuid | string | Unique identifier |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"usable":[],"manageable":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1408719365}}
Get Hosts
Gets the list of Hosts identified from all scan results that are on Tenable.sc
Endpoint
- URL: /rest/hosts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.limit | number | Optional | The limit parameter should be an integer greater than 0 |
parameters.startOffset | number | Optional | The startOffset parameter should an integer greater than 0 |
parameters.endOffset | number | Optional | The endOffset parameter should an integer greater than 0 |
parameters.pagination | boolean | Optional | The pagination parameter should a boolean |
parameters.fields | string | Optional | Specify the fields want to include in the response |
Input Example
{"parameters":{"limit":5,"startOffset":1,"endOffset":10,"pagination":true,"fields":"id"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | array | Output field: response |
response.id | string | Unique identifier |
response.uuid | string | Unique identifier |
response.tenableUUID | string | Unique identifier |
response.name | string | Name of the resource |
response.ipAddress | string | Output field: response.ipAddress |
response.os | string | Output field: response.os |
response.firstSeen | string | Output field: response.firstSeen |
response.lastSeen | string | Output field: response.lastSeen |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"ok","json_body":{"type":"regular","response":[{},{}],"error_code":0,"error_msg":"","warnings":[],"timestamp":1626889388}}
Get List Queries
Gets the list of Queries
Endpoint
- URL: /rest/query
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.type | string | Optional | Parameters for the Get List Queries action |
parameters.fields | string | Optional | Specify the fields want to include in the response |
Input Example
{"parameters":{"type":"mobile","fields":"id"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.tool | string | Output field: response.usable.tool |
response.usable.type | string | Type of the resource |
response.usable.tags | string | Output field: response.usable.tags |
response.usable.context | string | Output field: response.usable.context |
response.usable.browseColumns | string | Output field: response.usable.browseColumns |
response.usable.browseSortColumn | string | Output field: response.usable.browseSortColumn |
response.usable.browseSortDirection | string | Output field: response.usable.browseSortDirection |
response.usable.createdTime | string | Time value |
response.usable.modifiedTime | string | Time value |
response.usable.status | string | Status value |
response.usable.groups | array | Output field: response.usable.groups |
response.usable.groups.file_name | string | Name of the resource |
response.usable.groups.file | string | Output field: response.usable.groups.file |
response.usable.filters | array | Output field: response.usable.filters |
response.usable.filters.file_name | string | Name of the resource |
response.usable.filters.file | string | Output field: response.usable.filters.file |
response.usable.canUse | string | Output field: response.usable.canUse |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 15 Apr 2024 06:40:02 GMT","Server":"Apache","X-Frame-Options":"DENY","Content-Security-Policy":"default-src 'self'; script-src 'self' pendo-io-static.storage.googleapis.com app...","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Expect-CT":"max-age=31536000","Strict-Transport-Security":"max-age=31536000; includeSubDomains","Vary":"x-apikey","Set-Cookie":"TNS_SESSIONID=f65d532d29c8460000085c28c1f12c58; path=/; secure; Http...
Get Policies
Gets the list of policies
Endpoint
- URL: rest/policy
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.status | string | Status value |
response.usable.uuid | string | Unique identifier |
response.manageable | array | Output field: response.manageable |
response.manageable.id | string | Unique identifier |
response.manageable.name | string | Name of the resource |
response.manageable.description | string | Output field: response.manageable.description |
response.manageable.status | string | Status value |
response.manageable.uuid | string | Unique identifier |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"usable":[],"manageable":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1406233675}}
Get Repositories
Get the list of repositories
Endpoint
- URL: rest/repository
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.type | string | Required | Parameters for the Get Repositories action |
Input Example
{"parameters":{"type":"All"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | array | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
response.description | string | Output field: response.description |
response.dataFormat | string | Response data |
response.uuid | string | Unique identifier |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":[{"id":"37","name":"ag repo1","description":"Copied from QA","dataFormat":"agent","uuid":"A2FF7E13-2C0E-470E-A3C9-E077FE065A54"},{"id":"38","name":"jm ipv4","description":"copied from QA","dataFormat":"IPv4","uuid":"2E950182-08B6-4737-830B-4ACC8F6B92F9"},{"id":"39","name":"ipv6 rep","description":"Copied from QA (name changed)","dataFormat":"IPv6","uuid":"FF00F4D0-5B9F-4A26-998C-19430295284A"}],"error...
Get Scan Results
Gets the list of scan results
Endpoint
- URL: rest/scanResult
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.startTime | number | Optional | Parameters for the Get Scan Results action |
parameters.endTime | number | Optional | Parameters for the Get Scan Results action |
Input Example
{"parameters":{"startTime":1685558400,"endTime":1690560000}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.status | string | Status value |
response.manageable | array | Output field: response.manageable |
response.manageable.id | string | Unique identifier |
response.manageable.name | string | Name of the resource |
response.manageable.description | string | Output field: response.manageable.description |
response.manageable.status | string | Status value |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"usable":[],"manageable":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1407249641}}
Get Scans
Gets the list of scans
Endpoint
- URL: rest/scan
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.usable | array | Output field: response.usable |
response.usable.id | string | Unique identifier |
response.usable.name | string | Name of the resource |
response.usable.description | string | Output field: response.usable.description |
response.usable.uuid | string | Unique identifier |
response.manageable | array | Output field: response.manageable |
response.manageable.id | string | Unique identifier |
response.manageable.name | string | Name of the resource |
response.manageable.description | string | Output field: response.manageable.description |
response.manageable.uuid | string | Unique identifier |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
timestamp | number | Output field: timestamp |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"usable":[],"manageable":[]},"error_code":0,"error_msg":"","warnings":[],"timestamp":1406828340}}
Run Scan
Launches the scan associated with the ID or UUID
Endpoint
- URL: rest/scan/{{id}}/launch
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | string | Required | Parameters for the Run Scan action |
parameters.diagnosticTarget | string | Optional | Parameters for the Run Scan action |
parameters.diagnosticPassword | string | Optional | Parameters for the Run Scan action |
Input Example
{"parameters":{"diagnosticTarget":"192.168.1.1","diagnosticPassword":"dummyPassword"},"path_parameters":{"id":"id"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
type | string | Type of the resource |
response | object | Output field: response |
response.scanID | string | Unique identifier |
response.scanResult | object | Result of the operation |
response.scanResult.initiatorID | string | Unique identifier |
response.scanResult.ownerID | string | Unique identifier |
response.scanResult.scanID | string | Unique identifier |
response.scanResult.resultsSyncID | number | Unique identifier |
response.scanResult.jobID | string | Unique identifier |
response.scanResult.repositoryID | string | Unique identifier |
response.scanResult.name | string | Name of the resource |
response.scanResult.description | string | Result of the operation |
response.scanResult.details | string | Result of the operation |
response.scanResult.status | string | Status value |
response.scanResult.downloadFormat | string | Result of the operation |
response.scanResult.dataFormat | string | Response data |
response.scanResult.resultType | string | Type of the resource |
response.scanResult.id | string | Unique identifier |
error_code | number | Error message if any |
error_msg | string | Error message if any |
warnings | array | Output field: warnings |
warnings.file_name | string | Name of the resource |
warnings.file | string | Output field: warnings.file |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"type":"regular","response":{"scanID":"2","scanResult":{}},"error_code":0,"error_msg":"","warnings":[],"timestamp":1407510276}}
Response Headers
Header | Description | Example |
|---|---|---|
Cache-Control | Directives for caching mechanisms | no-cache, no-store |
Connection | HTTP response header: Connection | Keep-Alive |
Content-Length | The length of the response body in bytes | 3793 |
Content-Security-Policy | HTTP response header: Content-Security-Policy | default-src 'self'; script-src 'self' pendo-io-static.storage.googleapis.com app.pendo.io cdn.pendo.io pendo-static-6165929460760576.storage.googleapis.com data.pendo.io cdn.metarouter.io e.metarouter.io api.amplitude.com cdn.amplitude.com *.cloudfront.net; connect-src 'self' app.pendo.io data.pendo.io pendo-static-6165929460760576.storage.googleapis.com cdn.metarouter.io e.metarouter.io api.amplitude.com cdn.amplitude.com *.cloudfront.net; img-src 'self' data: cdn.pendo.io app.pendo.io pendo-static-6165929460760576.storage.googleapis.com data.pendo.io; style-src 'self' app.pendo.io cdn.pendo.io pendo-static-6165929460760576.storage.googleapis.com; frame-ancestors app.pendo.io; form-action 'self'; block-all-mixed-content; Upgrade-Insecure-Requests: 1; object-src 'none' |
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Mon, 15 Apr 2024 06:40:02 GMT |
Expect-CT | HTTP response header: Expect-CT | max-age=31536000 |
Expires | The date/time after which the response is considered stale | Thu, 19 Nov 1981 08:52:00 GMT |
Keep-Alive | HTTP response header: Keep-Alive | timeout=15, max=100 |
Pragma | HTTP response header: Pragma | no-cache |
SecurityCenter | HTTP response header: SecurityCenter | 5.19.1 |
Server | Information about the software used by the origin server | Apache |
Set-Cookie | HTTP response header: Set-Cookie | TNS_SESSIONID=07ece412570606c2d3fcf7cd39c26812; path=/; secure; HttpOnly; SameSite=Strict |
Strict-Transport-Security | HTTP response header: Strict-Transport-Security | max-age=31536000; includeSubDomains |
Vary | HTTP response header: Vary | x-apikey |
X-Content-Type-Options | HTTP response header: X-Content-Type-Options | nosniff |
X-Frame-Options | HTTP response header: X-Frame-Options | DENY |
X-XSS-Protection | HTTP response header: X-XSS-Protection | 1; mode=block |