Impostazioni generiche

Recupero di tutte le impostazioni generiche

Richiesta

Definizione

GET /api/v1/settings/generic

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Response

Codici di stato

Codice di stato	Messaggio
200	"List of generic settings"
403	"Forbidden"

Body

Attributi

• data.settings.mailer.host string

  Host del server di posta elettronica utilizzato.

• data.settings.mailer.password string

  Password dell'indirizzo di posta elettronica utilizzato.

• data.settings.mailer.port integer

  Porta del server di posta elettronica utilizzato.

• data.settings.mailer.ssl boolean

  Se true, l'invio avviene con il protocollo SSL.

• data.settings.mailer.username string

  Indirizzo di posta utilizzato.

• data.settings.retention.audit_retention_days integer

  Numero di giorni per cui le attività registrate vengono conservate.

• data.settings.retention.deleted_rules_retention_days integer

  Numero di giorni per cui le regole eliminate vengono conservate e rese visibili.

• data.settings.retention.handled_alerts_retention_days integer

  Numero di giorni per cui gli alert già gestiti vengono conservati e tenuti visibili.

• data.settings.retention.hourly_trends_retention_days integer

  Numero di giorni per cui i trend orari vengono conservati e tenuti visibili.

• data.settings.retention.http_traffic_retention_days integer

  Numero di giorni per cui le transazioni vengono conservate e rese visibili.

Esempio

{
"data": {
    "settings": {
    "mailer": {
        "host": "smtps.xxxx.it",
        "password": "xxxxx",
        "port": 465,
        "ssl": true,
        "username": "test@test.it"
    },
    "retention": {
        "audit_retention_days": 90,
        "deleted_rules_retention_days": 90,
        "handled_alerts_retention_days": 90,
        "hourly_trends_retention_days": 365,
        "http_traffic_retention_days": 7
    }
    }
},
"message": "List of generic settings",
"status": "ok"
}

Modifica delle impostazioni generiche

Richiesta

Definizione

PUT /api/v1/settings/generic

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Corpo della richiesta

{
  "mailer": {
    "port": 587,
    "ssl": false
  },
  "retention": {
    "audit_retention_days": 120,
    "http_traffic_retention_days": 14
  }
}

Risposta

Codici di stato

Codicie di stato	Messaggio
200	"Generic settings updated"
400	"Generic error"
400	"Error updating generic settings"
403	"Forbidden"

Corpo

{
  "data": {
    "settings": {
      "mailer": {
        "host": "smtps.xxxxx.it",
        "password": "",
        "port": 587,
        "ssl": false,
        "username": "test@test.it"
      },
      "retention": {
        "audit_retention_days": 120,
        "deleted_rules_retention_days": 90,
        "handled_alerts_retention_days": 90,
        "hourly_trends_retention_days": 365,
        "http_traffic_retention_days": 14
      }
    }
  },
  "message": "Generic settings updated",
  "status": "ok"
}