Get Agents Without Assets
Use the "/GetAgentsWithOutAssets" API to retrieve the list of CCS agents that exists in the system but do not have assets associated with them.
Authentication
To grant access to users to view or execute RESTful APIs, you must generate an authentication token. To know more about this, refer to this topic - Using token-based authentication for
Control Compliance Suite
RESTful APIs.Authorization Requirements
You must have the following task to execute and use the "/GetAgentsWithOutAssets" API:
- Manage Agents
- View Assets
To use the "/GetAgentsWithOutAssets" API, you must have permission to access the following folder:
- Asset System
Authorization Header
You are required to pass the in the HTTP authorization header.
Bearer Token
Request Method and Content Type
To retrieve the list of a
Control Compliance Suite
agents without assets, create a GET
request and the content data being sent in the HTTP request or response body is formatted as application/json
. API URL
The following table displays the "/GetAgentsWithOutAssets" API description, and the API URL:
Operation Description | Request URL |
Use this API to retrieve the list of CCS agents without assets associated with it. | https://<hostname>:<port number>/ccs/api/v2/Agents/GetAgentsWithOutAssets |
Sample of a "/GetAgentsWithOutAssets" API request and response
Sample of a "/GetAgentsWithOutAssets" API Request:
{ "Offset" : {{offset}}, "numberOfRecords":{{numberOfRecords}} }
Where the following parameters are optional:
- Offset: This is the number of records to be skipped before starting to return the records. (For example, >= 0)
- numberOfRecords: This is the number of records user wants to retrieve. (For example, > 0)
Sample of a "/GetAgentsWithOutAssets" API Response:
{ "TotalAgentsWithOutAssets": <COUNT OF TOTAL AGENT>, "agents": [ { "ID": "6YESf7Dk-5FKG-sncy-cgBx-XjlWJzSmZzrw", "Name": "10.105.154.62", "FQDN": "rhel7x64", "IPAddressList": "10.105.154.62", "DisplayVersion": "12.60.10100.1500", "RegisteredDate": "2023-12-11T15:51:16.477", "RegisteredBy": "root", "DomainOrWorkgroupName": "", "HostName": "rhel7x64", "ProxyName": "10.105.154.62", "OSDetail": "Linux 3.10.0-123.el7.x86_64 x86_64", "AMJTaskStatus": null, "AMJTaskDetailedStatus": null, "Version": "12.60 (2022/09/16 07:36)", "PlatformLongName": "Linux/X64 (64bit)", "PlatformShortName": "lnx-x64", "ManagerName": "", "Content": " SCU(2022-03)", "Type": 1, "RUTaskStatus": null, "Status": null, "ConnStatusDate": null } ] }
Sample of a "/GetAgentsWithOutAssets" API Response where there are no agents without assets that exist in the CCS system:
{ "TotalAgentsWithOutAssets": 0, "Message": "No matching records found.", "agents": [] }