Resource URL: /platform/<<version=3>>/protocols/smb/log-level/filters

    Overview: This resource applies the standard collection pattern to SMB log
              filters.

     Methods: GET, POST, DELETE

********************************************************************************

Method GET: Get the current SMB log filters.

       URL: GET /platform/<<version=3>>/protocols/smb/log-level/filters

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }, 
    "filters": {
      "items": {
        "type": "object", 
        "properties": {
          "ip_addrs": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Array of client IP addresses to filter against."
          }, 
          "ops": {
            "items": {
              "enum": [
                "read", 
                "write", 
                "session-setup", 
                "logoff", 
                "flush", 
                "notify", 
                "tree-connect", 
                "tree-disconnect", 
                "create", 
                "delete", 
                "oplock", 
                "locking", 
                "set-info", 
                "query", 
                "close", 
                "create-directory", 
                "delete-directory"
              ], 
              "type": "string", 
              "description": "Valid SMB operations to log"
            }, 
            "type": "array", 
            "description": "Array of SMB operations to filter against."
          }, 
          "id": {
            "type": "integer", 
            "description": "Unique ID of the log filter."
          }, 
          "level": {
            "enum": [
              "always", 
              "error", 
              "warning", 
              "info", 
              "verbose", 
              "debug", 
              "trace"
            ], 
            "type": "string", 
            "description": "Logging level of the filter.", 
            "required": true
          }
        }
      }, 
      "type": "array"
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }
  }
}

********************************************************************************

Method POST: Add an SMB log filter.

        URL: POST /platform/<<version=3>>/protocols/smb/log-level/filters

There are no query arguments for this method.

Required POST request body fields:
level

POST request body schema:
{
  "type": "object", 
  "properties": {
    "ip_addrs": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Array of client IP addresses to filter against."
    }, 
    "ops": {
      "items": {
        "enum": [
          "read", 
          "write", 
          "session-setup", 
          "logoff", 
          "flush", 
          "notify", 
          "tree-connect", 
          "tree-disconnect", 
          "create", 
          "delete", 
          "oplock", 
          "locking", 
          "set-info", 
          "query", 
          "close", 
          "create-directory", 
          "delete-directory"
        ], 
        "type": "string", 
        "description": "Valid SMB operations to log"
      }, 
      "type": "array", 
      "description": "Array of SMB operations to filter against."
    }, 
    "level": {
      "enum": [
        "always", 
        "error", 
        "warning", 
        "info", 
        "verbose", 
        "debug", 
        "trace"
      ], 
      "type": "string", 
      "description": "Logging level of the filter.", 
      "required": true
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "type": "integer", 
      "description": "Unique ID of the log filter."
    }
  }
}

********************************************************************************

Method DELETE: Delete an existing SMB log filter.

          URL: DELETE /platform/<<version=3>>/protocols/smb/log-level/filters

There are no query arguments for this method.

There is no response body for this method.
