Search user-defined templates
POST {{baseUrl}}/was/v2/user-templates/search?limit=-54086346&offset=-54086346&sort=last_seen:desc,ipv4:asc
Returns a paginated list of user-defined templates that are available to be used for scan configurations.
Requires SCAN OPERATOR [24] user permissions and CAN USE [16] policy permissions. See Permissions.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | The number of records to retrieve. If this parameter is omitted, Tenable.io uses the default value of 10. | |
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:desc would sort results by the name field in descending order. |
If you specify multiple fields, the fields must be separated by commas. For example, name:desc,created_at:asc would first sort results by the name field in descending order and then by the created_at field in ascending order. |
Request Body
{"AND"=>[{"field"=>"folder_name", "operator"=>"match", "value"=>"My Scans"}, {"field"=>"folder_name", "operator"=>"match", "value"=>"My Scans"}], "OR"=>[{"field"=>"folder_name", "operator"=>"match", "value"=>"My Scans"}, {"field"=>"folder_name", "operator"=>"match", "value"=>"My Scans"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"page_number":0,"page_size":4,"order_by":"name","ordering":"asc","sort":[{"name":"name","order":"asc"},{"name":"created_at","order":"desc"},{"name":"updated_at","order":"desc"}],"total_size":90,"data":[{"user_template_id":"78925a87-6a06-3f73-b0f9-d210b42e3b14","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-06-11T15:07:41Z","updated_at":"2020-08-04T13:54:41.726Z","name":"A1_WAS_scan","description":null,"owner_id":"4dc95b60-8821-4280-be08-265ae01882a7","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"d0a1521e-8f8d-4fc6-8553-88be1a838089","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-08-06T12:58:14.027Z","updated_at":"2020-08-06T12:58:14.027Z","name":"another template","description":"things","owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"ab8fd738-b9f1-4e26-a5ff-63835742cd87","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-08-06T13:43:09.815Z","updated_at":"2020-08-06T13:43:09.815Z","name":"a whole new template","description":null,"owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"df3da42d-9423-493a-acb8-7dd14c7cbfdc","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-06-23T11:29:43.718Z","updated_at":"2020-07-27T20:18:28.369Z","name":"blabla - mode","description":null,"owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[{"permissions_id":"49026468-2cf0-43e2-a14d-7c24b3c032b2","entity":"user","entity_id":"65dadc54-5871-449b-98ce-e8cd444967a9","level":"configure"}],"user_permissions":"configure","is_shared":true}],"pagination":{"total":90,"offset":0,"limit":4,"sort":[{"name":"name","order":"asc"},{"name":"created_at","order":"desc"},{"name":"updated_at","order":"desc"}]},"items":[{"user_template_id":"78925a87-6a06-3f73-b0f9-d210b42e3b14","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-06-11T15:07:41Z","updated_at":"2020-08-04T13:54:41.726Z","name":"A1_WAS_scan","description":null,"owner_id":"4dc95b60-8821-4280-be08-265ae01882a7","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"d0a1521e-8f8d-4fc6-8553-88be1a838089","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-08-06T12:58:14.027Z","updated_at":"2020-08-06T12:58:14.027Z","name":"another template","description":"things","owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"ab8fd738-b9f1-4e26-a5ff-63835742cd87","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-08-06T13:43:09.815Z","updated_at":"2020-08-06T13:43:09.815Z","name":"a whole new template","description":null,"owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[],"user_permissions":"configure","is_shared":false},{"user_template_id":"df3da42d-9423-493a-acb8-7dd14c7cbfdc","template_id":"b223f18e-5a94-4e02-b560-77a4a8246cd3","created_at":"2020-06-23T11:29:43.718Z","updated_at":"2020-07-27T20:18:28.369Z","name":"blabla - mode","description":null,"owner_id":"5ff4ad03-f168-4632-90fb-babf376579e9","container_id":"f02b6697-96b8-4b14-8d91-77105e2f7f6a","default_permissions":"no_access","results_visibility":"dashboard","permissions":[{"permissions_id":"49026468-2cf0-43e2-a14d-7c24b3c032b2","entity":"user","entity_id":"65dadc54-5871-449b-98ce-e8cd444967a9","level":"configure"}],"user_permissions":"configure","is_shared":true}]}