List networks

get

https://cloud.tenable.com/networks

Lists network objects for your organization.

Requires the Administrator [64] user role or the VM.VM_SENSOR.NETWORK.READ custom role privilege. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

A filter condition in the following format: field:operator:value. For network objects, you can only filter on the name field, using the following operators:

eq—The name of the returned network object is equal to the text you specify.
neq—The returned list of network objects excludes the network object where the name is equal to the text you specify.
match—The returned list includes network objects where the name contains the text you specify at least partially.

You can specify multiple f parameters, separated by ampersand (&) characters. If you specify multiple f parameters, use the ft parameter to specify how Tenable Vulnerability Management applies the multiple filter conditions.

string

The operator that Tenable Vulnerability Management applies if multiple `f` parameters are present. The OR operator is the only supported value. If you omit this parameter and multiple f parameters are present, Tenable Vulnerability Management applies the OR operator by default.

limit

int32

The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 50.

offset

int32

The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 0.

sort

string

The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc). For example, name:asc would sort results by the name field in ascending order.

includeDeleted

boolean

Indicates whether Tenable Vulnerability Management includes deleted network objects in the response message. Deleted network objects contain the additional attributes, deleted and deleted_by, which specifies the date (in Unix time) when the network object was deleted and the UUID of the user that deleted the network object.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Returned if the query parameters in your request were invalid.

403

Returned if you do not have sufficient permissions to list network objects.

200Returned if Tenable Vulnerability Management successfully retrieved the list of networks.

429Returned if you attempt to send too many requests in a specific period of time. For more information, see Rate Limiting.

503Returned if a Tenable Vulnerability Management service is unavailable. Wait a moment, and try your request again.