Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tenable Agents API

The Agents API from Tenable — 4 operation(s) for agents.

Tenable Agents API is one of 107 APIs that Tenable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.tenable.com/downloads/api/v2.

6 operations 4 paths 8 schemas 1 DELETE4 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cloud.tenable.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tenable Agents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Example: Bearer {{token}}

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Agents 6
GET
/scanners/null/agents
List agents
agents-list 7 params → 200400401403429500
GET
/scanners/null/agent-groups/{agent_group_id}/agents
List agents by group
agent-group-list-agents 8 params → 200400401403429500
GET
/agents/safe-mode-summary
Get agent safe mode summary
agents-get-safe-mode-summary → 200401403429500
GET
/scanners/null/agents/{agent_id}
Get agent details
agents-get 1 param → 200400401403429500
PATCH
/scanners/null/agents/{agent_id}
Rename agent
io-agents-rename 1 param body → 200400401403404429500
DELETE
/scanners/null/agents/{agent_id}
Unlink agent
agents-delete 1 param → 200400401403404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are agents_response-agent-details (34 properties), agents_response-list-agents (30 properties), agents_safe-mode-summary (5 properties), agents_PaginationResponse (4 properties). Each schema is shown below with its type and property counts.

agents_response-list-agents
object
30 properties
agents_object-health_events
array
An array of the agent's previous health statuses.
agents_PaginationResponse
object
An object containing pagination information for the current result set.
4 properties
agents_object-remote_settings
array
An array of the agent's remote settings.
agents_Response-PaginationSortObject
object
An object specifying how the current result set is sorted, including the property by which the results were sorted and the sort direction.
2 properties
agents_safe-mode-summary
object
5 properties
agents_ErrorResponse
object
3 properties
agents_response-agent-details
object
34 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tenable-agents-api-openapi.yml Raw ↑

Other APIs Tenable publishes across the network.

Tenable About API
Tenable Access Control (API) API
Tenable Access Control (Groups) API
Tenable Access Control (Permissions) API
Tenable Access Control (Roles) API
Tenable Access Control (Users) API
Tenable Access Groups v1 API
Tenable Access Groups v2 API
Tenable Account Groups API
Tenable Accounts API
Tenable Activity Log API
Tenable AD object API