HomeDocumentationAPI Reference
Log In
API Reference

Update server configurations

put
https://{sandfly-api-host}/v4/config

Update server configurations.

Body Params

Server configuration json object to update

int64
required
1 to 31
Defaults to 30

Number of days to keep alert results and other data.

int64
required
1 to 31
Defaults to 3

Number of days to keep pass results.

int64
required
1 to 9999
Defaults to 90

Number of days to keep "share" URL links generated in the UI.

int64
required
0 to 24
Defaults to 0

Hour of the day, on the 24-hour UTC clock, to perform daily system maintenance tasks.

string

The hostname of the Sandfly server, used for SAML ACS URLs, notification links, and other features that need to reference the server's public URL. Once set, this value cannot be changed back to empty.

string
enum
Defaults to info

Server log verbosity level. Changes take effect immediately unless the SF_LOG_LEVEL environment variable is set, in which case the environment variable takes precedence for the lifetime of the server.

Allowed:
int64
required

Configuration revision number. Must be echoed back to the server. Provides optimistic concurrency control to prevent two users from altering configuration simultaneously.

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