Firewall

Recupero di tutti i firewall

Richiesta

Definizione

GET /api/v1/settings/firewalls

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Parametri query string

Parametro	Tipo	Richiesto	Descrizione
name	string	No	Recupera i firewall il cui nome corrisponde alla stringa inserita.

Risposta

Codici di stato

Codice di stato	Messaggio
200	"List of firewalls"
403	"Forbidden"

Body

Attributi

• data.settings.firewalls.name string

  Nome assegnato al firewall.

• data.settings.firewalls.description string

  Descrizione associata al firewall.

• data.settings.firewalls.settings.enabled_as_waf boolean

  Indica se il firewall è abilitato come WAF (varia in base alla tipologia).

• data.settings.firewalls.settings.enabled_as_fw boolean

  Indica se il firewall è abilitato come firewall di rete (varia in base alla tipologia).

• data.settings.firewalls.type string

  Tipo di firewall.

Esempio

{
"data": {
    "firewalls": [
    {
        "description": "",
        "name": "waf_test",
        "settings": {
        "enabled_as_waf": true
        },
        "type": "modsecurity_feed"
    },
    {
        "description": "",
        "name": "fw_test",
        "settings": {
        "enabled_as_fw": true
        },
        "type": "generic_blacklist_feed"
    }
    ]
},
"message": "List of firewalls",
"status": "ok"
}

Recupero di uno specifico firewall in base al nome

Richiesta

Definizione

GET /api/v1/settings/firewalls/{firewall_name}

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Firewall retrieved"
400	"Error retrieving firewall"
403	"Forbidden"

Corpo

{
  "data": {
    "firewall": {
      "description": "new description",
      "name": "fw_test",
      "settings": {
        "enabled_as_fw": true
      },
      "type": "generic_blacklist_feed"
    }
  },
  "message": "Firewall retrieved",
  "status": "ok"
}

Creazione di un firewall Oplon

Richiesta

Definizione

POST /api/v1/settings/firewalls

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "firewall": {
    "description": "test description oplon",
    "name": "new_name",
    "settings": {
      "address": "10.2.3.4",
      "bl_api_path": "example/of/path",
      "enabled_as_fw": false,
      "enabled_as_waf": false,
      "password": "password",
      "port": 80,
      "username": "user",
      "waf_api_path": "example/of/path",
      "wl_api_path": "example/of/path"
    },
    "type": "oplon_firewall"
  }
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Firewall created"
400	"Error creating firewall"
403	"Forbidden"

Corpo

{
  "data": {
    "firewall": {
      "description": "test description oplon",
      "name": "new_name",
      "settings": {
        "address": "10.2.3.4",
        "bl_api_path": "example/of/path",
        "enabled_as_fw": false,
        "enabled_as_waf": false,
        "password": "password",
        "port": 80,
        "username": "user",
        "waf_api_path": "example/of/path",
        "wl_api_path": "example/of/path"
      },
      "type": "oplon_firewall"
    }
  },
  "message": "Firewall created",
  "status": "ok"
}

Modifica di un firewall

Richiesta

Definizione

PUT /api/v1/settings/firewalls/{nome_firewall}

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "attrs": {
    "description": "new description"
  }
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Firewall updated"
400	"Error updating firewall"
403	"Forbidden"

Corpo

{
  "data": {
    "firewall": {
      "description": "new description",
      "name": "fw_test",
      "settings": {
        "enabled_as_fw": true
      },
      "type": "generic_blacklist_feed"
    }
  },
  "message": "Firewall updated",
  "status": "ok"
}

Eliminazione di un firewall

Richiesta

Definizione

DELETE /api/v1/settings/firewalls/{nome_firewall}

Headers

• Authorization richiesto

  Token di autenticazione con privilegi di lettura della risorsa.

  Bearer {token}

• Content-Type richiesto

  application/json

Corpo della richiesta

{
  "attrs": {
    "description": "new description"
  }
}

Risposta

Codici di stato

Codice di stato	Messaggio
200	"Firewall deleted"
400	"Error deleting firewall"
403	"Forbidden"

Corpo

{
  "data": {
    "firewall": {
      "description": "test description oplon",
      "name": "new_name",
      "settings": {
        "address": "10.2.3.4",
        "bl_api_path": "example/of/path",
        "enabled_as_fw": false,
        "enabled_as_waf": false,
        "password": "password",
        "port": 80,
        "username": "user",
        "waf_api_path": "example/of/path",
        "wl_api_path": "example/of/path"
      },
      "type": "oplon_firewall"
    }
  },
  "message": "Firewall deleted",
  "status": "ok"
}