search
DocsSupportDashboard

Target

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

hashtag
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/listarrow-up-right

hashtag
Query Parameters

Name
Type
Description

sort

Integer

0 = Name (default)

sort_desc

Integer

0 = No (default)

1 = Yes

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

hashtag
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/listarrow-up-right

hashtag
Query Parameters

Name
Type
Description

target_id*

Integer

hashtag
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/listarrow-up-right

hashtag
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.

PreviousDiscoveryNextScan

Last updated