Tenable Security Center API: Publishing Site

/pubSite

Methods
GET

Gets the list of Publishing Sites.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
type
uri
useProxy
authType
cert
username
password
verifyHost
maxChunkSize
createdTime
modifiedTime

Session user role "1" (Administrator)

organizations

 

Legend

* = always comes back

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

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
    "type" : "regular",
    "response" : [
        {
            "id" : "2",
            "name" : "test",
            "description" : "desc",
            "type" : "HTTP POST",
            "uri" : "http:\/\/192.168.1.1\/test",
            "useProxy" : "false",
            "authType" : "password",
            "cert" : "",
            "username" : "test",
            "password" : "SET",
            "verifyHost" : "true",
            "maxChunkSize" : "0",
            "createdTime" : "1404245619",
            "modifiedTime" : "1404245619"       }
    ],
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1404247733
}
POST

Adds a Publishing Site.

Request Parameters
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "name" : <string>,
    "description" : <string> DEFAULT "",
    "type" : <string> "HTTP POST" | "CMRS",
    "maxChunkSize" : <number> DEFAULT 0,
    "uri" : <string>,
    "useProxy" : <boolean> DEFAULT false,
    "authType" : <string> "certificate" | "password",
    "cert" : SET|NOT_SET,
    "username" : <string>,
    "password" : <string>,
    "verifyHost" : <boolean> DEFAULT true,
    "organizations" : [
        {
            "id" : <number>           "uuid": <uuid>        }...
    ]
...
}

authType "certificate"

1
2
...
    "cert" : <string>...

  authType "password"

1
2
3
...
    "username" : <string>,
    "password" : <string>...
Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    "type" : "regular",
    "response" : [
        {
            "id" : "2",
            "name" : "test",
            "description" : "desc",
            "type" : "HTTP POST",
            "uri" : "http:\/\/192.168.1.1\/test",
            "useProxy" : "false",
            "authType" : "password",
            "cert" : "",
            "username" : "test",
            "password" : "SET",
            "verifyHost" : "true",
            "maxChunkSize" : "0",
            "createdTime" : "1404245619",
            "modifiedTime" : "1404245619",
            "organizations":[
                {
                    "id": "1",
                    "name": "lab",
                    "description": "",
                    "uuid": "A21BF1F3-DAB2-4053-9E84-4EA2722C3851"              }
            ]
        },
    ],
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1404247733
}


/pubSite/{id}

Methods
GET

Gets the Publishing Site associated with {id}.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
type
uri
useProxy
authType
cert
username
password
verifyHost
maxChunkSize
createdTime
modifiedTime

Session user role "1" (Administrator)

organizations

Legend

* = always comes back

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

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "type" : "regular",
    "response" : {
        "id" : "2",
        "name" : "test",
        "description" : "desc",
        "type" : "HTTP POST",
        "uri" : "http:\/\/192.168.1.1\/test",
        "useProxy" : "false",
        "authType" : "password",
        "cert" : "",
        "username" : "test",
        "password" : "SET",
        "verifyHost" : "true",
        "maxChunkSize" : "0",
        "createdTime" : "1404245619",
        "modifiedTime" : "1404245619"   },     "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1404247733
}
PATCH

Edits the Publishing Site associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /PubSite::POST for parameters.

Example Response

See /PubSite/{id}::GET for example response.

DELETE

Deletes the Publishing Site associated with {id}, depending on access and permissions.

Request Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
{
    "type" : "regular",
    "response" : {
        "id" : "2"  },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1401911117
}