Get a result profile

get https://{sandfly-api-host}/v4/resultprofiles/{id}

Get details of a result profile by ID.

Responses

Response body

object

associations

object

required

Individual hosts and tags to which to apply this result profile.

hosts

array of objects

required

hosts*

object

host_id

string

required

mode

string

required

Whether this result profile association will suppress alerts (whitelist), create alerts (drift), or both on the associated hosts.

whitelist drift both

hash_type

string

required

The type of hash, permissive or moderate, to use to apply this result profile to the associated host(s)

permissive moderate

tags

array of objects

required

tags*

object

tag

string

required

mode

string

required

Whether this result profile association will suppress alerts (whitelist), create alerts (drift), or both on the associated hosts.

whitelist drift both

hash_type

string

required

The type of hash, permissive or moderate, to use to apply this result profile to the associated host(s)

permissive moderate

host_info

array of objects

required

host_info*

object

string

The host ID of this host.

host_sequence_id

integer

Sequence host ID of this host.

hostname

string

The hostname (target address) of this host.

node_name

string

The OS node name of this host.

date_last_seen

date-time

The date this host was last successfully connected to.

last_seen_ip_addr

string

The IP address this host was last seen at.

mode

string

Whether this result profile association will suppress alerts (whitelist), create alerts (drift), or both on the associated hosts.

whitelist drift both

hash_type

string

The type of hash, permissive or moderate, to use to apply this result profile to the associated host(s)

permissive moderate

history

array of objects

required

history*

object

time

string

Timestamp of when the history event occurred.

username

string

The username of the person who performed this event.

event

string

Server-generated description of the event.

user_note

string

Notes the user provided when performing the action.

sandflies

array of objects

required

The sandflies for which this result profiles has results for.

sandflies*

object

name

string

required

Name of the sandfly.

description

string

required

Description of the sandfly.

whitelist_results

boolean

required

Indicates if the profile has results for whitelisting this sandfly.

drift_results

boolean

required

Indicates if the profile has results to use for drift detection on this sandfly.

type

string

required

Sandfly type.

custom

boolean

required

Indicates if this is a custom sandfly.

active

boolean

required

Indicates if the sandfly is active.

tags

array of strings

required

List of tags associated with the sandfly.

tags*

hosts_covered_whitelist

integer

The number of distinct hosts, either directly or via tags, that this result profile applies to in 'whitelist' mode.

hosts_covered_drift

integer

The number of distinct hosts, either directly or via tags, that this result profile applies to in 'drift' mode.

total_sandflies

integer

The number of distinct sandflies that this result profile includes results for.

integer

Unique ID assigned by the server for this result profile.

name

string

required

Display name of this result profile.

description

string

Description of this result profile.

create_date

string

Date this result profile was created.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandfly-api-host/v4/resultprofiles/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Result profile details retrieved.

404Result profile not found.

defaultUnexpected error