Acknowledged

The Acknowledged endpoint allows you to list, add, and delete acknowledged hostnames, apps, and issues.

Get a list of acknowledged hostnames.

GET https://api.halosecurity.com/api/v1/ack/host-list.json

Returns a paginated list of acknowledged hostnames.

https://www.halosecurity.com/user/security/awk/hosts

200: OK

{
    "list": [
        {
            "awk_host": {
                "host": "0.0.0.0",
                "comment": "Randomly scans its-self causing massive fps.",
                "created_date": "0000-00-00 00:00",
                "type": 1000,
                "created_by": "example"
            }
        }
    ]
}

Add a hostname acknowledgment.

GET https://api.halosecurity.com/api/v1/ack/host-add.json

Requires the security_acknowledge_add permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/hosts

Query Parameters

Name	Type	Description
host*	String
type*	String	global discovery cookie script form cert download link traffic
comment	String

200: OK

{
    "success": 1
}

400: Bad Request

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

400: Bad Request

{
    "code": 0,
    "message": "host required"
}

400: Bad Request

{
    "code": 0,
    "message": "Host Already Acknowledged"
}

Delete a hostname acknowledgment.

GET https://api.halosecurity.com/api/v1/ack/host-delete.json

Requires the security_acknowledge_delete permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/hosts

Query Parameters

Name	Type	Description
host*	String
type	String	global discovery cookie script form cert download link traffic

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "host required"
}

400: Bad Request

{
    "code": 0,
    "message": "nothing deleted"
}

Get a list of acknowledged elements.

GET https://api.halosecurity.com/api/v1/ack/element-list.json

Returns a paginated list of acknowledged elements. See the Appendix for information about acceptable element types.

See the Appendix for information about acceptable element types.

https://www.halosecurity.com/user/security/awk/apps

Query Parameters

Name	Type	Description
type*	Integer	Type of element to list

200: OK

{
    "request": {
        "target_count": 27,
        "sort": "1"
    },
    "pagination": {
        "total": 0,
        "start": 0,
        "limit": 100
    },
    "list": [
        {
            "awk_app": {
                "name": "Cloudflare",
                "created_date": "0000-00-00 00:00",
                "app_id": 14,
                "created_by": "none"
            }
        }
    ]
}

400: Bad Request

{
    "code": 0,
    "message": "type required"
}

400: Bad Request

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

Add an app acknowledgment.

GET https://api.halosecurity.com/api/v1/ack/element-add.json

Add an acknowledged element. See the Appendix for information about acceptable element types.

Requires the security_acknowledge_add permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/apps

Query Parameters

Name	Type	Description
type*	Integer	Type of element to add

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "type required"
}

400: Bad Request

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

Get information about a specific acknowledgement.

GET https://api.halosecurity.com/api/v1/ack/element-get.json

Query Parameters

Name	Type	Description
id*	Integer	ID of the acknowledgement to get

200: OK

{
    "success": 1,
    "ack_element": {
        "comment": "test",
        "target_id": 0,
        "created_date": "2022-05-27 17:49",
        "created_by": "[e-mail]"
    }
}

Delete an element acknowledgment.

GET https://api.halosecurity.com/api/v1/ack/element-delete.json

Requires the security_acknowledge_delete permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/apps

Query Parameters

Name	Type	Description
id*	Integer	ID of the acknowledgement to delete

200: OK

{
    "success": 1
}

404: Not Found

{
    "code": 404,
    "message": "acknowledged element not found"
}

Get a list of acknowledged issues.

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

https://www.halosecurity.com/user/security/awk/issues

200: OK

{
    "request": {
        "target_count": 1,
        "sort": "1"
    },
    "pagination": {
        "total": 1,
        "start": 0,
        "limit": 100
    },
    "list": [
        {
            "ack_issue": {
                "reason": 1,
                "last_found_date": "2022-01-01 12:00",
                "issue_id": 12345,
                "target_id": 0,
                "id": 1234,
                "created_date": "2022-01-01 12:00",
                "created_by": "[e-mail]",
                "last_found_scan_id": "202201011200J344j0mFFFFZv0J0000"
            }
        }
    ]
}

Get information about a specific acknowledged issue.

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

https://www.halosecurity.com/user/security/awk/issues

Query Parameters

Name	Type	Description
id*	integer	ID of the acknowledged issue.

200: OK

{
    "ack_issue": {
        "reason": 1,
        "issue_id": 12345,
        "target_id": 0,
        "id": 1234,
        "created_date": "2022-01-01 12:00",
        "created_by": "[e-mail]"
    },
    "success": 1
}

400: Bad Request

{
    "code": 400,
    "message": "id required"
}

404: Not Found

{
    "code": 404,
    "message": "acknowledged issue not found"
}

Add an issue to acknowledged list.

GET https://api.halosecurity.com/api/v1/ack/issue-add.json

Requires the security_acknowledge_add permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/issues

Query Parameters

Name	Type	Description
issue_id*	integer	ID of the issue to add.

200: OK

{
    "success": 1,
    "id": 12345
}

400: Bad Request

{
    "code": 0,
    "message": "issue_id required"
}

404: Not Found

{
    "code": 0,
    "message": "issue not found"
}

Delete an acknowledged issue.

GET https://api.halosecurity.com/api/v1/ack/issue-delete.json

Requires the security_acknowledge_delete permission.

Learn about permissions: Permissions

https://www.halosecurity.com/user/security/awk/issues

Query Parameters

Name	Type	Description
id*	integer	ID of the acknowledged issue to delete.

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 400,
    "message": "id required"
}

404: Not Found

{
    "code": 404,
    "message": "acknowledged issue not found"
}