HomeDocumentationAPI Reference
Log In
API Reference
Start typing to search…

Add Whitelist Rule

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

Add a whitelist rule.

Query Params
boolean

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

Body Params

Whitelist rule config.

string
required

Name of the sandfly this rule relates to.

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
string
enum
Defaults to and
Allowed:
rules
array of strings
Defaults to

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

rules
boolean
Defaults to false

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

boolean
Defaults to true

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

string

A descriptive comment about this whitelist rule.

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago