Add Whitelist Rule

post https://{sandfly-api-host}/v4/whitelistrules

Add a whitelist rule.

Query Params

allowmerge

boolean

allow this whitelist to be merged into an existing whitelist if the conditions are the same

Body Params

Whitelist rule config.

sandfly

string

required

Name of the sandfly this rule relates to.

all_hosts

boolean

Defaults to false

Does this rule apply to all hosts. If true, host_ids and host_tags will be ignored.

host_ids

array of strings

Defaults to

A list of host IDs that will have this rule applied.

host_ids

host_tags

array of strings

Defaults to

A list of host tags. If a host matches any tag, it will have this rule applied.

host_tags

rule_op

string

Defaults to and

rules

array of strings

Defaults to

At least one rule is required if this isn't a sandfly exclusion whitelist.

rules

exclude_sandfly

boolean

Defaults to false

If true, this sandfly will not run on configured hosts and disregard any rules.

active

boolean

Defaults to true

If true, the whitelist rule is enabled. If false, the whitelist will not be applied to results.

comment

string

A descriptive comment about this whitelist rule.

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://sandfly-api-host/v4/whitelistrules \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "all_hosts": false,
8
  "rule_op": "and",
9
  "exclude_sandfly": false,
10
  "active": true
11
}
12
'

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

application/json

200Existing Whitelist rule updated. The response will include the ID of the existing whitelist that was updated based on merging this new whitelist request into an identical existing whitelist.

201Whitelist rule created. If merge was allowed, there was no existing whitelist rule found to merge this rule into.

401Error adding whitelist rule.

defaultUnexpected error