Agents
# Agent Detail
Agent Detail; Agent Name, Agent Status, Agent Type, Agent Created Time, Agent Platform, Agent Mitigation Devices, Agent Execution Users, Agent Custom Attacker and Agent Attack Modules with their enabled state and configuration
get/v1/agents/{Id}
Request
- Base URLhttps://api.picussecurity.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Idinteger required
Agent ID (URI parameter)
Response
AgentDetailReturnSwagger
Example response
{
"Agent": {
"affected_platforms": [
{
"architecture": "32-bit",
"name": "Windows Server 2022"
}
],
"attack_modules": [
{
"config": {
"email": {
"connection": {
"auth_method": "browser_login",
"client_method": "IMAP",
"encryption": "UseSSL",
"host": "imap.corp.local",
"mail": "picus@corp.local",
"port": 993,
"timeout": 30
},
"dest_mail": "target@corp.local",
"dest_name": "Target User",
"timing": {
"attack_interval": 60
}
},
"exfiltration": {
"smtp": {
"encryption": "StartTLS",
"host": "smtp.corp.local",
"mail": "picus@corp.local",
"port": 587
}
},
"lateral": {
"remote_domain": "CORP",
"remote_host_name": "SRV-DC-01",
"remote_user_name": "svc-picus"
},
"nat": {
"http_port": 80,
"https_port": 443,
"ip": "1.1.1.2"
},
"url_filtering": {
"urls": [
{
"url": "http://example.com"
}
]
},
"wats": {
"protocol": "https",
"url": "https://wats.corp.local",
"waf_type": "ModSecurity"
}
},
"delay_seconds": 30,
"name": "File Download"
}
],
"created_at": 1650284604358,
"custom_attacker": {
"id": 7,
"ip": "10.0.4.21",
"name": "DC-Attacker-01"
},
"devices": [
{
"name": "FortiWeb",
"product_platform": "FGWVM",
"product_version": "6.3.7"
}
],
"execution_users": [
{
"id": 1,
"user_type": "privileged",
"username": "CORP\\svc-picus-adm"
}
],
"id": 1,
"ip": "1.1.1.1",
"name": "Agent-1",
"nat_ip": "0.0.0.0",
"platform_architecture": "64-bit",
"platform_name": "Windows 10",
"status": "alive | dead | expired",
"type": "QuickEmail | Browser | Installable Agent | Windows | Linux | MacOS",
"version": "3.4.0.0"
}
}Changes
No recorded changes to this operation across all 6 revisions of this API.