LogoLogo
DocsSupportDashboard
  • Introduction
    • Data Types
    • Target Filtering
    • Scan Selection
    • Pagination & Sorting
    • Permissions
    • Appendix
  • Authentication
  • Webhooks
  • Events
  • Appendix
    • Targets Filter
    • Date Match
    • IP Range
  • Endpoints
    • Discovery
    • Target
    • Scan
    • Issue
    • Tag
    • Port
    • DNS
    • HTTP
    • Whois
    • Technology
    • Website
    • Acknowledged
    • Event
    • Dark Web
    • Integration
    • PCI
    • Report
    • User
    • Account
    • Security
    • File
    • Work
Powered by GitBook

© 2024 Halo Security

On this page
  • Get a list of acknowledged hostnames.
  • Add a hostname acknowledgment.
  • Delete a hostname acknowledgment.
  • Get a list of acknowledged elements.
  • Add an app acknowledgment.
  • Get information about a specific acknowledgement.
  • Delete an element acknowledgment.
  • Get a list of acknowledged issues.
  • Get information about a specific acknowledged issue.
  • Add an issue to acknowledged list.
  • Delete an acknowledged issue.

Was this helpful?

  1. Endpoints

Acknowledged

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

PreviousWebsiteNextEvent

Last updated 2 years ago

Was this helpful?

Get a list of acknowledged hostnames.

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

Returns a paginated list of acknowledged hostnames.

{
    "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

Query Parameters

Name
Type
Description

host*

String

type*

String

global

discovery

cookie

script

form

cert

download

link

traffic

comment

String

{
    "success": 1
}
{
    "code": 0,
    "message": "type not valid"
}
{
    "code": 0,
    "message": "host required"
}
{
    "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

Query Parameters

Name
Type
Description

host*

String

type

String

global

discovery

cookie

script

form

cert

download

link

traffic

{
    "success": 1
}
{
    "code": 0,
    "message": "host required"
}
{
    "code": 0,
    "message": "nothing deleted"
}

Get a list of acknowledged elements.

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

Query Parameters

Name
Type
Description

type*

Integer

Type of element to list

{
    "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"
            }
        }
    ]
}
{
    "code": 0,
    "message": "type required"
}
{
    "code": 0,
    "message": "type not valid"
}

Add an app acknowledgment.

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

Requires the security_acknowledge_add permission.

Learn about permissions: Permissions

Query Parameters

Name
Type
Description

type*

Integer

Type of element to add

{
    "success": 1
}
{
    "code": 0,
    "message": "type required"
}
{
    "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

{
    "success": 1,
    "ack_element": {
        "comment": "test",
        "target_id": 0,
        "created_date": "2022-05-27 17:49",
        "created_by": "user@example.com"
    }
}

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

Query Parameters

Name
Type
Description

id*

Integer

ID of the acknowledgement to delete

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

Get a list of acknowledged issues.

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

{
    "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": "user@example.com",
                "last_found_scan_id": "202201011200J344j0mFFFFZv0J0000"
            }
        }
    ]
}

Get information about a specific acknowledged issue.

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

Query Parameters

Name
Type
Description

id*

integer

ID of the acknowledged issue.

{
    "ack_issue": {
        "reason": 1,
        "issue_id": 12345,
        "target_id": 0,
        "id": 1234,
        "created_date": "2022-01-01 12:00",
        "created_by": "user@example.com"
    },
    "success": 1
}
{
    "code": 400,
    "message": "id required"
}
{
    "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

Query Parameters

Name
Type
Description

issue_id*

integer

ID of the issue to add.

{
    "success": 1,
    "id": 12345
}
{
    "code": 0,
    "message": "issue_id required"
}
{
    "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

Query Parameters

Name
Type
Description

id*

integer

ID of the acknowledged issue to delete.

{
    "success": 1
}
{
    "code": 400,
    "message": "id required"
}
{
    "code": 404,
    "message": "acknowledged issue not found"
}

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

See the for information about acceptable element types.

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

https://www.halosecurity.com/user/security/awk/hosts
https://www.halosecurity.com/user/security/awk/hosts
https://www.halosecurity.com/user/security/awk/hosts
Appendix
Appendix
https://www.halosecurity.com/user/security/awk/apps
Appendix
https://www.halosecurity.com/user/security/awk/apps
https://www.halosecurity.com/user/security/awk/apps
https://www.halosecurity.com/user/security/awk/issues
https://www.halosecurity.com/user/security/awk/issues
https://www.halosecurity.com/user/security/awk/issues
https://www.halosecurity.com/user/security/awk/issues