Tenable Scanner Tasks API
The Scanner Tasks API from Tenable — 4 operation(s) for scanner tasks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/tenable-scanner-tasks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Tenable Platform & Settings Scanner Tasks API
version: 1.0.0
servers:
- url: https://cloud.tenable.com
tags:
- name: Scanner Tasks
x-displayName: Scanner Tasks
paths:
/scanners/{scanner_uuid}/directives:
post:
summary: Send instructions to scanner
description: 'Create instructions for a single scanner to perform.
Requires the Scan Manager [40] user role. See Roles.'
operationId: io-scanners-directive
tags:
- Scanner Tasks
parameters:
- description: The UUID of the scanner.
required: true
name: scanner_uuid
in: path
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
allOf:
- type: object
required:
- type
properties:
type:
type: string
description: The type of instruction to perform. To restart the scanner service, choose `restart`. To modify settings, choose `settings`.
enum:
- restart
- settings
- $ref: '#/components/schemas/Scanner_Tasks_scanner-directive'
responses:
'200':
description: Returned if the directive task was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_response-scanner-directive'
examples:
response:
value:
container_uuid: 4496ea88-1d4d-43e8-b373-973b0870fd7d
uuid: 61cadb4c-a245-40d3-a77f-6a9001e8def4
sensor_uuid: 51f6a2bf-c2ea-478d-bffd-0a81cfe4529a
owner_uuid: 2e9cecda-3821-4032-a093-ddd0cbd8b9b9
type: settings
status: pending
created: 1652937372838
modified: 1652937372838
results_blob_size: 0
options:
settings:
- setting: backend_log_level
value: debug
ttl: 604800
id: 61cadb4c-a245-40d3-a77f-6a9001e8def4
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have the required permissions to send a directive to the scanner.
'404':
description: Returned if the specified scanner was not found.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Scanner_Tasks_cloud: []
/scanners/bulk/directives:
post:
summary: Send instructions to multiple scanners
description: 'Create instructions for multiple scanners to perform.
Requires the Scan Manager [40] user role. See Roles.'
operationId: io-scanners-directive-bulk
tags:
- Scanner Tasks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_bulk-scanner-directive'
responses:
'200':
description: Returned if the bulk directive task was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_response-bulk-scanner-directive'
examples:
response:
value:
- container_uuid: 5496ea88-1d4d-43e8-b373-973b0870fd7d
uuid: ca9a4400-b443-4f9f-92e5-bcc78eaf1480
sensor_uuid: 52f6a2bf-c2ea-478d-bffd-0a81cfe4529a
owner_uuid: 2b9cecda-3821-4032-a093-ddd0cbd8b9b9
type: settings
status: pending
created: 1658774368372
modified: 1658774368372
results_blob_size: 0
options:
settings:
- setting: backend_log_level
value: normal
- setting: plugin_load_performance_mode
value: medium
id: cd9a4400-b443-4f9f-92e5-bcc78eaf1480
ttl: 604800
- container_uuid: 1496ea88-1d4d-43e8-b373-973b0870fd7d
uuid: c29a4400-b443-4f9f-92e5-bcc78eaf1480
sensor_uuid: a3c5be7e-cd13-497d-8d09-b7404bb34f58
owner_uuid: 2b9cecda-3821-4032-a093-ddd0cbd8b9b9
type: settings
status: pending
created: 1658774368372
modified: 1658774368372
results_blob_size: 0
options:
settings:
- setting: backend_log_level
value: normal
- setting: plugin_load_performance_mode
value: medium
id: cb9a4400-b443-4f9f-92e5-bcc78eaf1480
ttl: 604800
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have the required permissions to send directives to the scanners.
'404':
description: Returned if the specified scanner or scanners were not found.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Scanner_Tasks_cloud: []
/scanners/{scanner_id}/scans/{scan_uuid}/control:
post:
summary: Allow control of running scans
description: 'Allows control of scans that are currently running on a scanner.
Requires the Scan Manager [40] user role. See Roles.'
operationId: scanners-control-scans
tags:
- Scanner Tasks
parameters:
- description: The ID of the scanner.
required: true
name: scanner_id
in: path
schema:
type: integer
format: int32
- description: The UUID of the scan.
required: true
name: scan_uuid
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
action:
type: string
description: An action to perform on a scan. Valid values are `stop`, `pause`, and `resume`.
enum:
- stop
- pause
- resume
required:
- action
responses:
'200':
description: Returned if the specified action was completed successfully.
content:
application/json:
schema: {}
examples:
response:
value: {}
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to perform the specified action.
'404':
description: Returned if the specified scan or scanner was not found.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Scanner_Tasks_cloud: []
/scanners/{scanner_id}/link:
put:
summary: Toggle scanner link state
description: 'Enables or disables the link state of the scanner identified by `scanner_id`.
Requires the Scan Manager [40] user role. See Roles.'
operationId: scanners-toggle-link-state
tags:
- Scanner Tasks
parameters:
- description: The ID of the scanner.
required: true
name: scanner_id
in: path
schema:
type: integer
format: int32
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
link:
type: integer
description: Pass `1` enable the link. Pass `0` to disable.
format: int32
required:
- link
responses:
'200':
description: Returned if the link state of the scanner was updated successfully.
content:
application/json:
schema: {}
examples:
response:
value: {}
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you attempt to edit a cloud scanner where you do not have edit permissions.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Scanner_Tasks_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Scanner_Tasks_cloud: []
components:
schemas:
Scanner_Tasks_ErrorResponse:
type: object
properties:
statusCode:
type: integer
description: The HTTP status code of the error.
error:
type: integer
description: The standard HTTP error name.
message:
type: string
description: A brief message about the cause of the error.
Scanner_Tasks_scanner-directive:
type: object
properties:
options:
type: object
description: Specifies the instructions you wish to send to the scanner. The `options` object is different depending on whether you want to restart the scanner service or change settings for the scanner.
oneOf:
- title: Restart Scanner Service (OPTION 1)
type: object
description: The options for the restart scanner service operation.
properties:
hard:
type: boolean
description: Indicates whether or not to perform a hard restart of the scanner service. A hard restart will inform the scanner service to restart immediately regardless of what it is doing.
idle:
type: boolean
description: Indicates whether or not to restart the scanner service when the scanning engine is idle.
- title: Change Settings (OPTION 2)
type: object
description: The settings to change.
properties:
settings:
type: array
description: An array of objects where each object is one individual setting or instruction to perform. Each object contains a `setting` property to specify the setting and a `value` property to specify the value for setting. For example, `{"setting":"backend_log_level","value":"debug"}`.
items:
type: object
properties:
setting:
description: The setting to send to the scanner. Supported settings are `backend_log_level`, `auto_update`, and `auto_update_delay`. For information about these settings and a list of possible values to use with the settings, see [Advanced Settings](https://docs.tenable.com/nessus/Content/SettingsAdvanced.htm) in the Nessus User Guide.
type: string
enum:
- backend_log_level
- auto_update
- auto_update_delay
value:
oneOf:
- title: Single String Value
type: string
- title: Single Integer Value
type: integer
description: The value to use for the specified setting. Choose either a single string value or a single integer value to use for the value.
example:
- 'no'
Scanner_Tasks_response-bulk-scanner-directive:
type: array
items:
$ref: '#/components/schemas/Scanner_Tasks_response-scanner-directive'
Scanner_Tasks_bulk-scanner-directive:
type: object
properties:
all_scanners:
type: string
description: Indicates whether or not to send the directives to all scanners.
enum:
- 'true'
- 'false'
scanners:
type: array
description: An array of scanner UUIDs to send the directives to.
items:
type: string
directive:
type: object
description: Specifies the instructions you wish to send to the scanners. The `directive` object is different depending on whether you want to restart the scanners' service or change settings for the scanners.
allOf:
- type: object
required:
- type
properties:
type:
type: string
description: The type of instruction to perform. To restart the scanner service, choose `restart`. To modify settings, choose `settings`.
enum:
- restart
- settings
- $ref: '#/components/schemas/Scanner_Tasks_scanner-directive'
Scanner_Tasks_response-scanner-directive:
type: object
properties:
container_uuid:
type: string
format: UUID
description: The UUID of the container where the task is operating.
uuid:
type: string
format: UUID
description: The UUID of the directive task.
sensor_uuid:
type: string
format: UUID
description: The UUID of the scanner (sensor).
owner_uuid:
type: string
format: UUID
description: The UUID of the owner.
type:
type: string
description: The type of instruction, either `restart` or `settings`.
status:
type: string
description: The status of the scan task. For a list of scan statuses and their descriptions, see [Scan Status](doc:scan-status-tio).
enum:
- pending
- running
- completed
- failed
- canceled
created:
type: integer
format: int64
description: The creation date of the directive in unix time milliseconds.
modified:
type: integer
format: int64
description: The date the directive was last modified in unix time milliseconds.
results_blob_size:
type: integer
description: The size of the log that the scanner returns when performing a log directive. This value is always `0` for non-log directives.
options:
$ref: '#/components/schemas/Scanner_Tasks_response-directive-option'
ttl:
type: integer
description: The time to live for the directive. The status is updated to `failed` if the directive is not executed within the TTL time frame.
id:
type: string
format: UUID
description: The UUID of the directive task.
Scanner_Tasks_response-directive-option:
type: object
description: The instructions to perform.
properties:
settings:
type: array
description: An array of objects where each object is one individual setting or instruction to perform. Each object contains a `setting` property to specify the setting and a `value` property to specify the value for setting. For example, `{"setting":"backend_log_level","value":"debug"}`.
items:
type: object
properties:
setting:
description: The setting that was sent in the directive to the scanner.
type: string
value:
description: The value of the setting.
type: string
securitySchemes:
Access_Control_API_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Access_Control_Groups_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Access_Control_Permissions_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Access_Control_Roles_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Access_Control_Users_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
access-groups_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
access-groups_v2_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
activity-log_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
agents_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Agent_Config_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
agent-exclusions_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
agent-groups_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
agent-bulk-operations_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Cloud_Connectors_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
credentials_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
exclusions_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
networks_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
OT_Connectors_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
permissions_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Profiles_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
recast-rules_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Scanners_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Scanner_Config_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Scanner_Groups_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Scanner_Profiles_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
Scanner_Tasks_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
server_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
tags_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
target-groups_cloud:
type: apiKey
in: header
name: X-ApiKeys
description: Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY
x-readme:
proxy-enabled: false
samples-languages:
- python
- curl
- node
- powershell
- ruby
- javascript
- objectivec
- java
- php
- csharp
- go
- swift
- kotlin