Description

The addScheduleStoredFileSHAList operation handles configuration related to ScheduleStoredFileSHAList model. 
Scheduler job to generate a compressed zip file with list of file SHA(name) with its type, size and timestamp. It will be stored on FTD and can be downloaded once this job SUCCEEDED

HTTP request

POST /api/fdm/v6/action/storedfileshalist

Data Parameters

Parameter Required Type Description
scheduleType False string ScheduleType can only be IMMEDIATE
user False string Requested user name
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
forceOperation False boolean Force operation is not applicable
jobHistoryUuid False string UUID to track the progress of this job. However, it is not being used anywhere as scheduleType only 'IMMEDIATE' is supported for now.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
ipAddress False string Ip address of the requester (Default)
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
jobName False string User readable jobName to uniquely identify a job
type True string schedulestoredfileshalist

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "forceOperation": true,
        "id": "string",
        "ipAddress": "string",
        "jobHistoryUuid": "string",
        "jobName": "string",
        "scheduleType": "NONE",
        "type": "schedulestoredfileshalist",
        "user": "string",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/action/storedfileshalist"
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 add_schedule_stored_file_sha_list(client, body):
    return client.FileAndMalwarePolicy.addScheduleStoredFileSHAList(
        body=body
    ).response().result


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

    body = {'forceOperation': True,
 'ipAddress': 'string',
 'jobHistoryUuid': 'string',
 'jobName': 'string',
 'scheduleType': 'NONE',
 'type': 'schedulestoredfileshalist',
 'user': 'string'}

    add_schedule_stored_file_sha_list(client, body)