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 Shared Collections API

The Shared Collections API from Tenable — 5 operation(s) for shared collections.

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

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

This API exposes 10 operations across 5 paths, and defines 12 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.

10 operations 5 paths 12 schemas 2 DELETE4 GET3 POST1 PUT

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 Shared Collections 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 10

Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shared Collections 10
POST
/shared-collections
Create shared collection
shared-collections-create body → 200400401403429500
GET
/shared-collections
List shared collections
shared-collections-list → 200401403429500
GET
/shared-collections/{shared_collection_id}
Get shared collection details
shared-collections-details 1 param → 200401403404429500
PUT
/shared-collections/{shared_collection_id}
Update shared collection
shared-collections-update 1 param body → 200400401403404429500
DELETE
/shared-collections/{shared_collection_id}
Delete shared collection
shared-collections-delete 1 param → 200401403404429500
POST
/shared-collections/_byName
Get shared collection details by name
shared-collections-details-by-name body → 200400401404429500
GET
/shared-collections/request-status/{request_status_id}
Get job status
shared-collections-job-status 1 param → 200401403404429500
POST
/shared-collections/{shared_collection_id}/scan-configs
Add scan configs to shared collection
shared-collections-config-add 1 param body → 200400401403404429500
GET
/shared-collections/{shared_collection_id}/scan-configs
List scan configs in shared collection
shared-collections-config-list 4 params → 200204400401403404429500
DELETE
/shared-collections/{shared_collection_id}/scan-configs
Remove scan configs from shared collection
shared-collections-configs-remove 1 param body → 200401403404429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Shared_Collections_scan-object-list (24 properties), Shared_Collections_request-status-response-body (6 properties), Shared_Collections_shared-collection-object (4 properties), Shared_Collections_acl-object (4 properties). Each schema is shown below with its type and property counts.

Shared_Collections_PaginationResponse
object
An object containing pagination information for the current result set.
3 properties
Shared_Collections_request-create-acl-object
object
The access control list (ACL) object that defines the access to a shared collection for a given user or group.
4 properties 3 required
Shared_Collections_settings-rrules
string
The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=O…
Shared_Collections_request-update-shared-collection
object
3 properties 2 required
Shared_Collections_acl-object
object
The access control list (ACL) object that defines the permissions for a shared collection for a given user or group.
4 properties 3 required
Shared_Collections_async-api-response-body
object
2 properties
Shared_Collections_scan-object-list
object
24 properties
Shared_Collections_ErrorResponse
object
3 properties
Shared_Collections_request-create-shared-collection
object
3 properties 2 required
Shared_Collections_request-status-response-body
object
6 properties
Shared_Collections_shared-collection-object
object
4 properties 4 required
Shared_Collections_request-update-acl-object
object
The access control list (ACL) object that defines the access to a shared collection for a given user or group.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tenable-shared-collections-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