Tenable Security Center API: Sensor Proxy

These endpoints may only be used by administrators.

/sensor-proxy

GET

Methods

Gets the list of Sensor Proxies.

NOTE:This call will return all Sensor Proxies for an Administrator.

Fields Parameter

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

1
?fields=<field>,...

Allowed Fields (Admin User)

*id

**uuid
**name
**description
**enabled

**status
**version

platform

distro
lastLinkedOn
lastCheckinTime
createdTime
modifiedTime

Legend

* = always comes back

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

Request Query Parameters

None

Example Response
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
33
{
    "type": "regular",
    "response": [
        {
                "name": "Sensor Proxy Two",
                "status": "2",
                "version": "1.0.10",
                "platform": "linux",
                "distro": "Oracle Linux Server 8.8",
                "proxy_build": "2024.1021.51949.11",
                "linkedOn": "1231654654",
                "modifiedTime": "1231654685",
                "id": "2",
                "uuid": "xxxxxxxx-xxxx-xxxx-873c-c6b15e2cf0c3"
            },
            {
                "name": "Sidecar 3",
                "status": "2",
                "version": "1.0.10",
                "platform": "linux",
                "distro": "Oracle Linux Server 8.8",
                "proxy_build": "2024.1021.51949.11",
                "linkedOn": "1729708556",
                "modifiedTime": "1730304651",
                "id": "5",
                "uuid": "xxxxxx-916b-11ef-8db5-02420a050005"
            }
    ],
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1727369687
}

/sensor-proxy/search

POST

Methods

Gets the list of specified Sensor Proxies.

Fields Parameter

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

1
?fields=<field>,...

The limit parameter should be an integer greater than 0

1
?limit=<number>,...

The startOffset parameter should be an integer greater than 0

1
?startOffset=<number>,...

The endOffset parameter should be  an integer greater than 0

1
?endOffset=<number>,...

The pagination parameter should a boolean

1
?pagination=<boolean>,...

Allowed Fields

*id

**uuid
**name
**description
**enabled

**status
**version

platform

distro
lastLinkedOn
lastCheckinTime
createdTime
modifiedTime

Legend

* = always comes back

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
    "filters": {
        "and": [
            {
                "property": "linkedOn",
                "operator": "between",
                "value": "all"
            },
            {
                "property": "modifiedTime",
                "operator": "between",
                "value": "all"
            }
        ]
    }
}
Example Response
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "type": "regular",
    "response": {
        "totalRecords": "3",
        "returnedRecords": 3,
        "startOffset": "0",
        "results": [
            {
                "name": "Sensor Proxy Two",
                "status": "2",
                "version": "1.0.10",
                "platform": "linux",
                "distro": "Oracle Linux Server 8.8",
                "proxy_build": "2024.1021.51949.11",
                "linkedOn": "1231654654",
                "modifiedTime": "1231654685",
                "id": "2",
                "uuid": "xxxxxxxx-8a53-416d-873c-c6b15e2cf0c3"
            },
            {
                "name": "Sidecar3",
                "status": "2",
                "version": "1.0.10",
                "platform": "linux",
                "distro": "Oracle Linux Server 8.8",
                "proxy_build": "2024.1021.51949.11",
                "linkedOn": "1729708556",
                "modifiedTime": "1730304651",
                "id": "5",
                "uuid": "xxxxxxxxx-916b-11ef-8db5-02420a050005"
            },
            {
                "name": "Sensor Proxy One",
                "status": "2",
                "version": "2.1.1",
                "platform": "platform1",
                "distro": "distro 1",
                "proxy_build": "build 1",
                "linkedOn": "1231654654",
                "modifiedTime": "1231654655",
                "id": "1",
                "uuid": "aaaa-bbbb-cccc-dddd"
            }
        ]
    },
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1730474777
}

/sensor-proxy/{id}

GET

Methods

Gets the Sensor Proxy associated with {id}.

NOTE: This call will return Sensor Proxy associated with {id} for an Administrator.

Fields Parameter

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

1
?fields=<field>,...

Allowed Fields (Admin User)

*id

**uuid
**name
**description
**enabled

**status
**version

platform

distro
lastLinkedOn
lastCheckinTime
createdTime
modifiedTime

Legend

  • = always comes back

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

Request Query Parameters

None

Example Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "type": "regular",
    "response": {
        "name": "Sensor Proxy Two",
        "status": "2",
        "version": "1.0.10",
        "platform": "linux",
        "distro": "Oracle Linux Server 8.8",
        "proxy_build": "2024.1021.51949.11",
        "linkedOn": "1231654654",
        "modifiedTime": "1231654685",
        "id": "2",
        "uuid": "xxxxxxxx-xxxx-xxxx-873c-c6b15e2cf0c3"
    },
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1727369700
}

PATCH

Edits the Sensor Proxy associated with {id}, changing only the passed in fields.

Request Parameters
1
2
3
4
5
{
    "name": "Sensor Proxy update",
    "description": "description update",
    "enabled": "true" // false
}
Example Response

See /sensor-proxy/{id}::GET

DELETE

Deletes the Sensor Proxy associated with {id}.

Request Parameters

None

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

Attachments:

macro?definition=e2FuY2hvcjp3YXNTY2FubmVyR0VUMX0&locale=en_US&version=2 (image/png)
macro?definition=e2FuY2hvcjp3YXNTY2FubmVyUEFUQ0h9&locale=en_US&version=2 (image/png)
macro?definition=e2FuY2hvcjp3YXNTY2FubmVyREVMRVRFfQ&locale=en_US&version=2 (image/png)