Target

The Target endpoint allows you to list all targets, get details about targets, and update details of specific targets.

Get a list of targets.

GET https://api.halosecurity.com/api/v1/target/list.json

Returns a paginated list of targets.

https://app.halosecurity.com/user/security/targets/list

Query Parameters

Name	Type	Description
sort	Integer	0 = Name (default)
sort_desc	Integer	0 = No (default) 1 = Yes

200: OK

{
    "list": [
        {
            "target": {
                "target_name": "example",
                "target_id": 1,
                "target": "www.example.com"
            }
        }
    ]
}

Get the details of a target.

GET https://api.halosecurity.com/api/v1/target/get.json

Returns the details of a target.

https://app.halosecurity.com/user/security/targets/list

Query Parameters

Name	Type	Description
target_id*	Integer

200: OK

{
    "target": {
        "recent_scan_ids": [
            "id1",
            "id2",
            "id3",
            "id4",
            "id5"
        ],
        "target_name": "example",
        "date_created": "0000-00-00 00:00",
        "ip": "0.0.0.0",
        "target_id": 1,
        "target": "www.example.com",
        "geo": "US-CA",
        "scan_id": "id0",
        "scan_frequency": 1,
        "scan_hour": 1,
        "next_scan_date": "0000-00-00 00:00",
        "scan_pci": 0,
        "scan_network": 0,
        "scan_website": 0
    }
}

404: Not Found

{
    "code": 404,
    "message": "target not found"
}

Update details of a target.

GET https://api.halosecurity.com/api/v1/target/update.json

Update details of a target. Requires the security_target_update permission.

Learn about permissions: Permissions

https://app.halosecurity.com/user/security/targets/list

Query Parameters

Name	Type	Description
target_id*	Integer
name	String
tag	String	Multiple. Sets only these tags.
tag_add	String	Multiple. Add tags to existing.
tag_remove	String	Multiple. Remove tags from existing.
next_scan_date	DateTime	YYYY-MM-DD HH24:MI UTC
scan_hour	Integer	Hour of day to scan (0-23). -1 for random.

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "next_scan_date not valid"
}

404: Not Found

{     
    "code": 404,    
    "message": "target not found" 
}