Fetch a List of Sensors in Your Account
Shows a list of sensors in your account.
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
filter |
Optional |
string |
Filter the sensors list by providing a query using Qualys syntax. Refer to the “How to Search” topic in the online help for assistance with creating your query. |
|
pageNumber |
Optional |
integer |
The page to be returned. Page numbers start with 1. |
|
pageSize |
Optional |
integer |
The number of records per page to be included in the response. |
|
sort |
Optional |
string |
Sort the results using a Qualys token. For example, created:desc. Refer to the “Sortable tokens” topic in the online help for more information. |
SampleSample
API request
curl -X GET
"<qualys_base_url>/csapi/v1.3/sensors?filter=sensorType%3AGENERAL&pageNumber=1&pageSize=50"
-H "accept: application/json"
-H "Authorization: Bearer <token>"
Response
{ "data": [ { "uuid": "13b7a4cd-693c-4fe5-87d5-98fcf3f0b8a5", "activationUuid": "39b63fbb-3e3a-4905-829faaae794079fc", "hostname": "ip-10-82-8-106", "customerUuid": "1ab79f42-6cc3-757c-83d9-b0562c8a6dc8", "dockerVersion": "20.10.12", "ipv4": "10.82.8.106", "os": "Ubuntu 21.10", "ipv6": "fe80::8d3:acff:fecc:477b", "sensorVersion": "1.21.0-0", "platform": "LINUX_SENSOR", "lastCheckedIn": "1669619781067", "label": [ { "key": "build-date", "value": "Tue Nov 22 08:31:36 UTC 2022" }, { "key": "name", "value": "test Sensor Image" }, { "key": "vendor", "value": "test, Inc" }, { "key": "Base_image_name", "value": "arthq.intranet.test.com:5006/secure/oraclelinux:7" }, { "key": "image-source", "value": "SJC-POD01" }, { "key": "VersionInfo", "value": "Qualys Sensor Version 1.21.0-0" }, { "key": "jira-id", "value": "BI-122" }, { "key": "maintainer", "value": "DevOps <[email protected]>" } ], "privileged": "false", "macAddress": "0a:d3:ac:cc:47:7b", "vulnSigVersion": null, "hostUuid": "8621d2c6-e434-4530-8726-ecbca083eb92", "configurationProfile": null, "status": "Running", "registry": "docker.io", "sha": "7cf7650df563c7d11ce9b4ee9c7250254682eb8ccf796c7943d2dc2498e9264c", "sensorId": "7cf7650df563", "name": "test-container-sensor", "created": "1669617635000", "imageId": "95940c047e5a", "imageSha": "95940c047e5a934f470dfe3ac7e97b2ef33f3a695ac75ba609e3e1f9d7afa7d1", "binaryVersion": null, "containerIpv4": null, "containerIpv6": null, "containerMacAddress": "", "sensorType": "GENERAL", "containerRuntime": "DOCKER", "containerRuntimeVersion": "20.10.12", "architecture": "x86_64", "associatedSensorProfile": "00000000-0000-0000-0000-000000000000", "associatedSensorProfileName": "Default" }, { "uuid": "f1edef37-8d72-4f5d-87ed-9d6da981cffe", "activationUuid": "39b63fbb-3e3a-4905-829faaae794079fc", "hostname": "test-virtual-machine", "customerUuid": "1ab79f42-6cc3-757c-83d9-b0562c8a6dc8", "dockerVersion": "20.10.18", "ipv4": "10.115.145.155", "os": "Ubuntu 18.04.6 LTS", "ipv6": "fe80::78a0:a7a0:2424:609b", "sensorVersion": "1.21.0-0", "platform": "LINUX_SENSOR", "lastCheckedIn": "1669619814324", "label": [ { "key": "build-date", "value": "Tue Nov 22 08:31:36 UTC 2022" }, { "key": "name", "value": "test Sensor Image" }, { "key": "vendor", "value": "test, Inc" }, { "key": "Base_image_name", "value": "arthq.intranet.test.com:5006/secure/oraclelinux:7" }, { "key": "image-source", "value": "SJC-POD01" }, ], "privileged": "false", "macAddress": "00:50:56:aa:1f:17", "vulnSigVersion": null, "hostUuid": "630050dd-0110-0002-8170-0050568cd03b", "configurationProfile": null, "status": "Running", "registry": "docker.io", "sha": "4ad04dc3cab81d70fd7205cfb223d50ccc9b4e61d39514930ce2cce1fcf6454a", "sensorId": "4ad04dc3cab8", "name": "test-container-sensor", "created": "1669285071000", "imageId": "95940c047e5a", "imageSha": "95940c047e5a934f470dfe3ac7e97b2ef33f3a695ac75ba609e3e1f9d7afa7d1", "binaryVersion": null, "containerIpv4": null, "containerIpv6": null, "containerMacAddress": "", "sensorType": "GENERAL", "containerRuntime": "DOCKER", "containerRuntimeVersion": "20.10.18", "architecture": "x86_64", "associatedSensorProfile": "6963d471-7598-4d4d-b95ce540c75745b2", "associatedSensorProfileName": "General-test2""tags": { "uuid": "f9021ce1-73ce-4f9c-83bb-9118c8a8961e", "id": 141753860, "name": "Tag4", "backgroundColor": "#000000", "foregroundColor": "#000000", "icon": "", "criticalityScore": 0, "tagType": null },"clusterUid": null},], "count": 2 }