List networks
GET {{baseUrl}}/networks?f=deserunt&ft=deserunt&limit=67454373&offset=67454373&sort=deserunt&includeDeleted=false
Lists network objects for your organization.
Requires ADMINISTRATOR [64] user permissions.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
f | 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.io applies the multiple filter conditions. |
| ft | string | | The operator that Tenable.io 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.io applies the OR operator by default. |
| limit | number | | The number of records to retrieve. If this parameter is omitted, Tenable.io uses the default value of 50. |
| offset | number | | The starting record to retrieve. If this parameter is omitted, Tenable.io 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.io 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. |
RESPONSES
status: OK
{"networks":[{"owner_uuid":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","created":154474408527,"modified":154474408527,"scanner_count":10,"uuid":"00000000-0000-0000-0000-000000000000","name":"Default","is_default":true,"created_by":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","modified_by":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","created_in_seconds":1544744085,"modified_in_seconds":1544744085},{"owner_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","created":1557526802865,"modified":1557526802865,"scanner_count":1,"uuid":"1b17ee49-8f17-4c8f-8536-bff9aff73429","name":"Headquarters","description":"Network devices at Columbia, MD location","is_default":false,"created_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","modified_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","assets_ttl_days":91,"created_in_seconds":1557526802,"modified_in_seconds":1557526802}],"pagination":{"total":2,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}