Because Tenable APIs use the Representation State Transfer (REST) design pattern, the endpoints within functional categories are organized by resource type. Resource names specify the objects that you can interact with using the API. Collection resources are in plural to indicate multiple resources of the a given type. Single resource names indicate that there is only one resource of a given type.
The documentation provides the following information for each resource:
- HTTP method (
POST
,GET
,PUT
, orDELETE
). - Endpoint URL.
- Required permissions.
- Basic request client code sample in multiple languages (
Python
,cURL
,Node
,Ruby
,JavaScript
,Objective-C
,Java
,PHP
,C#
,Swift
, andGo
). - Input parameters (
HEADER
,PATH
,QUERY
, andBODY
). - Response samples for different response codes (
2xx
,4xx
,5xx
). - Response schema (where applicable).
Unless noted otherwise, the API accepts and produces the application/json
media type.