Update server configurations

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

Update server configurations.

Body Params

Credentials json blob.

agent_names

string

Comma-separated list of names to use for the Sandfly binary that is sent to target hosts.

config_revision

int64

required

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

data_retention_days

int64

Number of days to keep alert results and other data.

pass_retention_days

int64

Number of days to keep pass results.

shared_url_keep_days

int64

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

elastic_replication

object

ElasticSearch replication settings.

llm_analysis

object

maintenance_hour

int64

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

postgres_replication

object

PostgreSQL replication settings.

sentinel_replication

object

Microsoft Sentinel replication settings.

sso

object

SSO configuration options.

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
29
1
curl --request PUT \
2
     --url https://sandfly-api-host/v4/config \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "elastic_replication": {
8
    "enabled": true
9
  },
10
  "llm_analysis": {
11
    "enabled": true,
12
    "provider": "custom"
13
  },
14
  "postgres_replication": {
15
    "enabled": true
16
  },
17
  "sentinel_replication": {
18
    "enabled": true,
19
    "ssh_enabled": true,
20
    "host_enabled": true,
21
    "alerts_only": true,
22
    "auth_method": "client_secret"
23
  },
24
  "sso": {

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

application/json

200Configuration updated.

400Configuration failed validation. Configuration not updated.

502Testing connectivity to a remote system failed. Configuration not updated.

defaultUnexpected error