Tenable.sc API: Tenable.sc Instance

 

This API resource is only usable in Tenable.sc Director.

/sci

Methods
GET

Gets the list of linked Tenable.sc Instances.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
*workingScanners
*totalScanners
*status
*scanners
**name
**description
ip
version
lastSyncTime

Legend

* = always comes back

** = comes back if fields list not specified on GET all 

Example Response
Administrator

Expand
{
	"type" : "regular",
	"response" : [
		{ 
			"name" : "Invalid SC",
			"ip" : "0.0.0.0",
			"version" : "Unknown",
			"status" : "8194",
			"lastSyncTime" : "1574443980",
			"id" : "1",
			"scanners" : [],
			"workingScanners" : 0,
			"totalScanners" : 0
		},
		{
			"name" : "My SC",
			"ip" : "192.0.2.123",
			"version" : "5.13.0",
			"status" : "1",
			"lastSyncTime" : "1574707501",
			"id" : "2",
			"scanners" : [
				{
					"id" : "4064",
					"name" : "ScannerA",
					"description" : "This is a description"
				},
				{
					"id" : "4065",
					"name" : "ScannerB",
					"description" : ""
				},
				{
					"id" : "4066",
					"name" : "Broken Scanner",
					"description" : ""
				}
			],
			"workingScanners" : 2,
			"totalScanners" : 3
		},
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1574707627
}
Organization User

None

POST

Adds a linked Tenable.sc Instance.

Request Parameters
Expand
{
	"name" : <string>,
	"description" : <string> DEFAULT "",
	"context" : <string> DEFAULT "",
	"status" : <number> DEFAULT "-1",
	"createdTime" : <number> DEFAULT "0",
	"modifiedTime" : <number> DEFAULT "0",
	"ip" : <string>,
	"port" : <number>,
	"useProxy" : <boolean> DEFAULT "false",
	"verifyHost" : <boolean> DEFAULT "false",
	"accessKey" : <string>,
	"secretKey" : <string>,
	"lastCommunicationTime" : <number> DEFAULT "0",
	"lastSyncTime" : <number> DEFAULT "0"
}
Example Response
Expand
{
    "type" : "regular",
    "response" : {
        "id" : "22",
        "name" : "Temp Box",
        "description" : "",
        "ip" : "1.2.3.4",
        "port" : "123",
        "useProxy" : "false",
        "verifyHost" : "false",
        "accessKey" : "3124ffd6ca5a4f4ba20557da5b829b2a",
        "secretKey" : "SET",
        "version" : "Unknown",
        "status" : "8192",
		"scanners" : [
        	{
        		"id": "24",
                "name": "ScannerA",
                "description": "123"
            },
            {
                "id": "25",
                "name": "ScannerB",
                "description": "abc"
            },
            {
                "id": "26",
                "name": "ScannerC",
                "description": ""
            }
        ],
        "lastCommunicationTime" : "-1",
        "lastSyncTime" : "-1",
        "createdTime" : "1574782552",
        "modifiedTime" : "1574782552",
        "workingScanners" : 0,
        "totalScanners" : 0
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1574782552
}

/sci/{id}

Methods
GET

Gets the Tenable.sc Instance associated with {id}.

NOTE:  Does not return any scanner information except number of scanners and number of operational scanners

Example Response
Administrator
Expand
{
	"type" : "regular",
	"response" : {
		"id" : "2",
		"name" : "My SC",
		"description" : "This is my SC",
		"ip" : "1.2.3.4",
		"port" : "123",
		"useProxy" : "false",
		"verifyHost" : "false",
		"accessKey" : "8bb3a64f6fb0483ba0769d20779d289c",
		"secretKey" : "SET",
		"version" : "5.13.0",
		"status" : "1",
		"lastCommunicationTime" : "1574785801",
		"lastSyncTime" : "1574785801",
		"createdTime" : "1574107088",
		"modifiedTime" : "1574190265",
		"workingScanners" : 2,
		"totalScanners" : 4
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1574786283
}
Organization User

None

PATCH

Edits the linked Tenable.sc Instance information associated with {id}, changing only the passed in fields.

NOTES:  

  • This does not currently edit the actual Tenable.sc, only to the local information associated to that linked Tenable.sc Instance
  • This will start a "SCI Status Refresh" job to update the local SCI with the remote information
Request Parameters
Expand

name
port
ip
description
accessKey
secretKey
verifyHost
useProxy

(All fields are optional)

See /sci::GET for parameters.

Example Request Payload
Expand
{
	"name" : "Example Name",
	"description" : "Example Description"
}
Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"id" : "42",
		"name" : "Example Name",
		"description" : "Example Description",
		"ip" : "1.2.3.4",
		"port" : "123",
		"useProxy" : "false",
		"verifyHost" : "false",
		"accessKey" : "3124ffd6ca5a4f4ba20557da5b829b2a",
		"secretKey" : "SET",
		"version" : "5.13.0",
		"status" : "8193",
		"lastCommunicationTime" : "1574783102",
		"lastSyncTime" : "1574783102",
		"createdTime" : "1574782552",
		"modifiedTime" : "1574783434",
		"workingScanners" : 1,
		"totalScanners" : 1
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1574783433
}

DELETE

Deletes the link to the Tenable.sc Instance associated with {id}.

NOTE:  This does not delete the actual Tenable.sc, only the local information associated to that linked Tenable.sc Instance

Example Response
Expand
{
	"type" : "regular",
	"response" : "",
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1574785744
}