Passa al contenuto principale

Sorgenti di traffico

Recupero di tutte le sorgenti di traffico​

Richiesta​

Definizione​

GET /api/v1/settings/firewalls

Headers​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura della risorsa.

    Bearer {token}

Risposta​

Codici di stato​

Codice di statoMessaggio
200"List of traffic sources"
403"Forbidden"

Corpo​

  • data.traffic_sources.address string

    Indirizzo IP su cui è attiva la sorgente di traffico.

  • data.traffic_sources.date_format string

    Formato della data dei log.

  • data.traffic_sources.description string

    Descrizione della sorgente di traffico.

  • data.traffic_sources.enabled boolean

    Indica se la sorgente di traffico è attiva.

  • data.traffic_sources.http_source_timezone string

    Timezone associata alla sorgente di traffico.

  • data.traffic_sources.log_format string

    Formato dei log.

  • data.traffic_sources.name string

    Nome assegnato alla sorgente di traffico.

  • data.traffic_sources.port integer

    Porta sulla quale la sorgente di traffico è in ascolto.

  • data.traffic_sources.rule_match_format string

    ...

  • data.traffic_sources.time_format string

    Indica in che formato debba essere mostrata la data dei log.

  • data.traffic_sources.timestamp_format string

    Formato del timestamp dei log.

  • data.traffic_sources.type string

    Tipo di sorgente di traffico.

  • data.traffic_sources.unix_timestamps boolean

    Se true, il formato dei timestamp dei log sarà UNIX.

Recupero di una specifica sorgente di traffico​

Richiesta​

Definizione​

GET /api/v1/settings/traffic_sources/{traffic_source_name}

Headers​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura della risorsa.

    Bearer {token}

Risposta​

Codici di stato​

Codicie di statoMessaggio
200"Traffic source retrieved"
400"Error retrieving traffic source"
403"Forbidden"

Corpo​

{
  "data": {
    "traffic_source": {
      "address": "10.99.99.199",
      "date_format": null,
      "description": "test description nginx",
      "enabled": true,
      "http_source_timezone": null,
      "log_format": null,
      "name": "test_nginx_2",
      "port": 20052,
      "rule_match_format": null,
      "time_format": null,
      "timestamp_format": null,
      "type": "nginx_log",
      "unix_timestamps": false
    }
  },
  "message": "Traffic source retrieved",
  "status": "ok"
}

Creazione di una sorgente di traffico​

Richiesta​

Definizione​

POST /api/v1/settings/traffic_sorces

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura della risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "traffic_source": {
    "address": "10.99.99.196",
    "date_format": "%Y-%m-%d",
    "description": "description test_api_insert",
    "enabled": true,
    "http_source_timezone": "-01:00",
    "log_format": "client_address=%client_address date=%date time=%time",
    "name": "test_api_insert_2",
    "time_format": "%H:%M:%S",
    "type": "custom_log"
  }
}

Risposta​

Codici di stato​

Codice di statoMessaggio
200"Traffic source creation submitted"
400"Error creating traffic source"
403"Forbidden"

Corpo​

{
  "data": {
    "traffic_source": {
      "address": "10.99.99.196",
      "date_format": "%Y-%m-%d",
      "description": "description test_api_insert",
      "enabled": true,
      "http_source_timezone": "-01:00",
      "log_format": "client_address=%client_address date=%date time=%time",
      "name": "test_api_insert_2",
      "port": 20053,
      "rule_match_format": null,
      "time_format": "%H:%M:%S",
      "timestamp_format": null,
      "type": "custom_log",
      "unix_timestamps": null
    }
  },
  "message": "Traffic source creation submitted",
  "status": "ok"
}

Modifica di una sorgente di traffico​

Richiesta​

Definizione​

PUT /api/v1/settings/traffic_sources/{traffic_source_name}

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura della risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "attrs": {
    "address": "10.87.86.85",
    "date_format": "YYYY_MM_dd",
    "http_source_timezone": "GMT+03:08",
    "time_format": "HH_mm_ss.sss"
  }
}

Risposta​

Codici di stato​

Codice di statoMessaggio
200"Traffic source modified"
400"Error updating traffic source"
403"Forbidden"

Corpo​

{
  "data": {
    "traffic_source": {
      "address": "10.87.86.85",
      "date_format": "YYYY_MM_dd",
      "description": "test desciption custom ts",
      "enabled": false,
      "http_source_timezone": "GMT+03:08",
      "log_format": "client_address=%client_address timestamp=%timestamp",
      "name": "test_custom_ts_2",
      "port": 20051,
      "rule_match_format": null,
      "time_format": "HH_mm_ss.sss",
      "timestamp_format": "%Y-%m-%dT%H:%M:%S",
      "type": "custom_log",
      "unix_timestamps": null
    }
  },
  "message": "Traffic source modified",
  "status": "ok"
}

Eliminazione di una sorgente di traffico​

Richiesta​

Definizione​

DELETE /api/v1/settings/traffic_sources/{traffic_source_name}

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura della risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Risposta​

Codici di stato​

Codice di statoMessaggio
200"Traffic source deleted"
400"Error deleting traffic source"
403"Forbidden"

Corpo​

{
  "data": {
    "traffic_source": {
      "address": null,
      "date_format": null,
      "description": null,
      "enabled": null,
      "http_source_timezone": null,
      "log_format": null,
      "name": "test_api_insert_2",
      "port": null,
      "rule_match_format": null,
      "time_format": null,
      "timestamp_format": null,
      "type": null,
      "unix_timestamps": null
    }
  },
  "message": "Traffic source deleted",
  "status": "ok"
}