Issue

The Issue endpoint returns details about discovered issues.

Get a summary of issues.

GET https://api.halosecurity.com/api/v1/issue/summary.json

Returns a paginated list of issues.

https://app.halosecurity.com/user/security/issues/summary

Query Parameters

Name	Type	Description
sort	String	name (default) severity target-count
sort_desc	Integer	0 = No (default) 1 = Yes
severity	String	Defaults to All Specific Value: 1 Range: 3-5 or >=1
include_target_ids	Integer	0 = No (default) 1 = Yes

200: OK

{
    "list": [
        {
            "target_count": 6,
            "issue": {
                "severity": 2,
                "issue_id": 1126115,
                "name": "Content-Security-Policy Not Implemented"
            },
            "target_ids": [
                111,
                222,
                333
            ]
        }
    ]
}

Get a list of issues.

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

Returns a paginated list of issues.

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

Query Parameters

Name	Type	Description
issue_id	Integer	Filter by issue id
status	String	Filter by status ("new", "investigating", "confirmed", "fixing", "fixed", "ack_false_positive", "ack_acceptable_risk", "active", "ack")
assigned_to	String	Filter by assigned
severity	Integer	Filter by severity
include_ack	Integer	1 = yes

200: OK

{
    "list": [
        {
            "issue": {
                "severity": 1,
                "issue_id": 1,
                "name": "Host Uptime Based on TCP TimeStamp Option"
            },
            "instances": [],
            "target": {
                "target_name": "",
                "target_id": 1,
                "target": "www.example.com"
            },
            "status": {
                "issue_id": 1,
                "target_id": 1,
                "scans_since_found": 0,
                "assigned_to": "[email protected]",
                "status": "new"
            }
        }
    ]
}

Get the details of an issue.

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

Returns the details of an issue.

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

Query Parameters

Name	Type	Description
issue_id*	Integer

200: OK

{
    "target_count": 1,
    "issue": {
        "severity": 1,
        "issue_id": 1,
        "pci": 0,
        "name": "Host Uptime Based on TCP TimeStamp Option",
        "description": "The TCP/IP stack on the host supports the TCP TimeStamp (kind 8) option.\n",
        "cve_ids": [],
        "category": "TCP/IP",
        "type": 1,
        "date_last_modified": "0000-00-00 00:00"
    },
    "target_ids": [
        1
    ]
}

404: Not Found

Get the details for an instance of an issue.

GET https://api.halosecurity.com/api/v1/issue/instance.json

Returns the details for an instance of an issue.

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

Query Parameters

Name	Type	Description
issue_id*	Integer
scan_id*	String
instance*	String

200: OK

{
    "instance": {
        "severity": 2,
        "result": "Based on TCP timestamps obtained via port 80",
        "vulnId": 1,
        "issue_id": 1,
        "first_found_date": "0000-00-00 00:00",
        "port": 0,
        "pci": 0,
        "key": "id1"
    },
    "issue": {
        "severity": 2,
        "issue_id": 1,
        "name": "Host Uptime Based on TCP TimeStamp Option"
    },
    "target": {
        "target_name": "",
        "target_id": 1,
        "target": "www.example.com"
    },
    "status": {
        "issue_id": 1,
        "target_id": 1,
        "scans_since_found": 0,
        "assigned_to": "Nobody",
        "status": "new"
    }
}

400: Bad Request

400: Bad Request

404: Not Found

404: Not Found

Update details of an issue.

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

Update the status and notes of an issue, or assign it to a user ID/email.

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

Query Parameters

Name	Type	Description
issue_id*	Integer
target_id*	Integer
status*	String	"new", "investigating", "confirmed", "fixing", "fixed", "ack_false_positive", "ack_acceptable_risk", "active", "ack"
assigned_to*	String	user_id or email 0 for unassigned
note	String

200: OK

{
    "success": 1
}

400: Bad Request

400: Bad Request

404: Not Found

Get the changes between scans.

GET https://api.halosecurity.com/api/v1/issue/changes.json

Query Parameters

Name	Type	Description
now	String	Defaults to last scan.
ago	String	Defaults to prior scan.
type	String	removed or added
severity	String	Defaults to All Specific Value: 1 Range: 3-5 or >=1
q	String	Query

Get retired issues.

GET https://api.halosecurity.com/api/v1/issue/retired.json

Query Parameters

Name	Type	Description
days	Integer	Defaults to 7.
instance	Integer	1 = Yes (Default) 0 = No
severity	String	Defaults to All Specific Value: 1 Range: 3-5 or >=1