Description

The editCloudEvents operation handles configuration related to CloudEvents model. 
Allows to disable or enable this service or change types of events the device sends to a cloud

HTTP request

PUT /api/fdm/v6/devicesettings/default/cloudservices/events/{objId}

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
enableService False boolean A mandatory boolean value, TRUE or FALSE (default value). The value TRUE enables Cisco Visibility which indicates that the events will be sent to the cloud. FALSE will disable Cisco Visibility that prevents events from being forwarded to the cloud.
eventTypes False [object] The list of event types, which will be sent to a cloud if the service is enabled. Values can be one or more of the following.
FILE_MALWARE - File/Malware events.
INTRUSION - Intrusion events.
CONNECTION_HIGH - High Priority events.
CONNECTION_ALL - All Connection events.
The both CONNECTION_HIGH and CONNECTION_ALL cannot be part of the eventTypes.
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 A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

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 '{
        "enableService": true,
        "eventTypes": [],
        "id": "string",
        "type": "cloudevents",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/devicesettings/default/cloudservices/events/{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_cloud_events(client, obj_id, body):
    return client.CloudServices.editCloudEvents(
        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 = {'enableService': True,
 'eventTypes': [],
 'id': 'string',
 'type': 'cloudevents',
 'version': 'string'}

    edit_cloud_events(client, obj_id, body)