HomeDocumentationAPI Reference
Log In
API Reference

Edit autodrift profile

put
https://{sandfly-api-host}/v4/resultprofiles/autodrift/

Edit an autodrift profile. Optionally edit different parts of the profile by setting the objects non-null; null objects (or keys left out) indicate that that portion of the profile will not be modified.

Path Params
integer
required

Result profile ID to edit.

Body Params
string | null
required

The name of the auto-drift result profile. If null or an empty string, the name will remain unchanged.

string | null

A description of the auto-drift result profile. If null, will not change the existing description. If an empty string, will erase the existing description.

string | null

A user-provided note to record in the profile's history log.

scope
object
required

Scope definition for autodrift profiles.

model_hosts
object
required

The hosts to use as the model (i.e. template) hosts for expected results.

covered_hosts
object
required

The hosts that this profile should detect drift on (and optionally whitelist) after the results from the model host(s) are gathered.

gather_options
object
required

When present, this profile will enter gather mode and run gather schedules as configured. If null, no gather schedule will be created and the profile will immediately enter enforcing mode.

schedule_options
object
required

When present, the new profile will automatically have a scan schedule associated with it that scans the covered hosts with the selected sandflies for drift detection. If null, no scan schedule will be created.

Responses

Updated 3 months ago

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

Updated 3 months ago