Description

The editWebAnalyticsSetting operation handles configuration related to WebAnalyticsSetting model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

PUT /api/fdm/v6/devicesettings/default/webanalyticssettings/{objId}

Data Parameters

Parameter Required Type Description
version False string Alphanumeric string to identify the version of the object
disabled False boolean A Boolean value, TRUE or FALSE, that indicates whether Web Analytics is disabled. If FALSE, the feature is enabled.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string webanalyticssetting

Path Parameters

Parameter Required Type Description
objId True string

Example

curl -X PUT \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "disabled": true,
        "id": "string",
        "type": "webanalyticssetting",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devicesettings/default/webanalyticssettings/{objId}"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def edit_web_analytics_setting(client, obj_id, body):
    return client.WebAnalyticsSetting.editWebAnalyticsSetting(
        objId=obj_id,
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    obj_id = "string"
    body = {'disabled': True,
 'id': 'string',
 'type': 'webanalyticssetting',
 'version': 'string'}

    edit_web_analytics_setting(client, obj_id, body)