API Reference for device/exchangehybrid/MalwareFilteringServer

Model ref.: device/exchangehybrid/MalwareFilteringServer

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "UpdateFrequency": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "UpdateFrequency", 
               "title": "UpdateFrequency", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "The UpdateFrequency parameter specifies the frequency interval in minutes to check for malware scanning engine updates. Valid input for this parameter is an integer between 1 and 38880 (27 days). The default value is 60 (one hour). The locations to check for updates are specified by the PrimaryUpdatePath and SecondaryUpdatePath parameters."
          }, 
          "WhenCreatedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreatedUTC", 
               "title": "WhenCreatedUTC", 
               "format": "date-time", 
               "required": true, 
               "readonly": false, 
               "type": "string"
          }, 
          "OrganizationId": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "OrganizationId", 
               "title": "OrganizationId", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "ForceRescan": {
               "__type_requested": "System.Boolean", 
               "required": true, 
               "name": "ForceRescan", 
               "title": "ForceRescan", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "description": "The ForceRescan parameter specifies that messages should be scanned by the malware agent, even if the message was already scanned by Exchange Online Protection. Valid input for this parameter is $true or $false. The default value is $false."
          }, 
          "ScanTimeout": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "ScanTimeout", 
               "title": "ScanTimeout", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "The ScanTimeout parameter specifies the timeout interval in seconds for messages that can't be scanned by the malware filter. Valid input for this parameter is an integer between 10 and 900. The default value is 300 (5 minutes)."
          }, 
          "PSShowComputerName": {
               "__type_requested": "System.Boolean", 
               "required": false, 
               "name": "PSShowComputerName", 
               "title": "PSShowComputerName", 
               "__type_mapping_type": "Boolean", 
               "readonly": true, 
               "type": "boolean"
          }, 
          "MinimumSuccessfulEngineScans": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "MinimumSuccessfulEngineScans", 
               "title": "MinimumSuccessfulEngineScans", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "This parameter is reserved for internal Microsoft use."
          }, 
          "ObjectClass": {
               "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", 
               "required": true, 
               "name": "ObjectClass", 
               "title": "ObjectClass", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array"
          }, 
          "UpdateTimeout": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "UpdateTimeout", 
               "title": "UpdateTimeout", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "The UpdateTimeout parameter specifies the timeout interval in seconds to use when checking for malware scanning engine updates. Valid input for this parameter is an integer between 60 and 300. The default value is 150 seconds (2.5 minutes).\nIf the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter value, the location specified by the SecondaryUpdatePath parameter is used."
          }, 
          "PSComputerName": {
               "__type_requested": "System.String", 
               "required": false, 
               "name": "PSComputerName", 
               "title": "PSComputerName", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "DeferWaitTime": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "DeferWaitTime", 
               "title": "DeferWaitTime", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "The DeferWaitTime parameter specifies the time period in minutes to increase the interval to resubmit messages for malware filtering in an effort to reduce the workload on the server.\nFor example, the first retry after the original failed scan occurs after the interval specified by the DeferWaitTime parameter. The second retry after the first retry occurs after two times the value of the DeferWaitTime parameter. The third retry after the second retry occurs after three times the value of the DeferWaitTime parameter, and so on. The maximum number of retries is controlled by the DeferAttempts parameter.\nValid input for this parameter is an integer between 0 and 15. The default value is 5. This means the first resubmit occurs 5 minutes after the original failed scan, the second retry occurs 10 minutes after the first retry, the third retry occurs 15 minutes after the second retry, and so on. The value 0 means messages are resubmitted for malware filtering after any failed scanning attempts without any delay."
          }, 
          "Identity": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "Identity", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "description": "The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example:\nName\nFQDN\nDistinguished name (DN)\nExchange Legacy DN"
          }, 
          "DistinguishedName": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "DistinguishedName", 
               "title": "DistinguishedName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "OriginatingServer": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "OriginatingServer", 
               "title": "OriginatingServer", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "Name": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "Name", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "Fqdn": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "Fqdn", 
               "title": "Fqdn", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "PrimaryUpdatePath": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "PrimaryUpdatePath", 
               "title": "PrimaryUpdatePath", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "description": "The PrimaryUpdatePath parameter specifies where to download malware scanning engine updates. The default value is http://forefrontdl.microsoft.com/server/scanengineupdate. The location specified by the PrimaryUpdatePath parameter is always tried first."
          }, 
          "WhenCreated": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenCreated", 
               "title": "WhenCreated", 
               "format": "date-time", 
               "required": true, 
               "readonly": false, 
               "type": "string"
          }, 
          "BypassFiltering": {
               "__type_requested": "System.Boolean", 
               "required": true, 
               "name": "BypassFiltering", 
               "title": "BypassFiltering", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "description": "The BypassFiltering parameter temporarily bypasses malware filtering without disabling the Malware agent on the server. The Malware agent is still active, and the agent is still called for every message, but no malware filtering is actually performed. This allows you to temporarily disable and then enable malware filtering on the server without disrupting mail flow by restarting the Microsoft Exchange Transport service. Valid input for this parameter is $true or $false. The default value is $false."
          }, 
          "ExchangeVersion": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "ExchangeVersion", 
               "title": "ExchangeVersion", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "SecondaryUpdatePath": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "SecondaryUpdatePath", 
               "title": "SecondaryUpdatePath", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "description": "The SecondaryUpdatePath parameter specifies an alternate download location for malware scanning engine updates. The default values is blank ($null). This means no alternate download location is specified.\nThe alternate download location is used when the location specified by the PrimaryUpdatePath parameter is unavailable for the time period specified by the UpdateTimeout parameter. On the next malware scanning engine update, the location specified by the PrimaryUpdate path parameter is tried first."
          }, 
          "IsValid": {
               "__type_requested": "System.Boolean", 
               "required": true, 
               "name": "IsValid", 
               "title": "IsValid", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean"
          }, 
          "DeferAttempts": {
               "__type_requested": "System.Int32", 
               "required": true, 
               "name": "DeferAttempts", 
               "title": "DeferAttempts", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "description": "The DeferAttempts parameter specifies the maximum number of times to defer a message that can't be scanned by the Malware agent. Valid input for this parameter is an integer between 1 and 5. The default value is 3.\nAfter the maximum number of deferrals is reached, the action taken by the Malware agent depends on the error. For scan timeouts and engine errors, the action is to fail the message and return a non-delivery report (NDR) to the sender immediately after the last defer attempt. For all other errors, the message is retried for up to 48 hours, with each retry attempt taking place one hour longer than the last one. For example, starting after the last defer attempt, the first retry attempt will occur in 1 hour, the next retry attempt will occur 2 hours after that, the next retry attempt will occur 3 hours after the second retry attempt, and so on for up to 48 hours. After 48 hours have elapsed, the action is to fail the message and return a non-delivery report (NDR) to the sender."
          }, 
          "WhenChanged": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChanged", 
               "title": "WhenChanged", 
               "format": "date-time", 
               "required": true, 
               "readonly": false, 
               "type": "string"
          }, 
          "WhenChangedUTC": {
               "__type_requested": "System.DateTime", 
               "__type_mapping_type": "DateTime", 
               "name": "WhenChangedUTC", 
               "title": "WhenChangedUTC", 
               "format": "date-time", 
               "required": true, 
               "readonly": false, 
               "type": "string"
          }, 
          "ScanErrorAction": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "ScanErrorAction", 
               "title": "ScanErrorAction", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "description": "The ScanErrorAction parameter specifies the action to take when a message can't be scanned by the malware filter. Valid values for this parameter are Block or Allow. The default value is Block."
          }, 
          "ObjectState": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "ObjectState", 
               "title": "ObjectState", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "RunspaceId": {
               "__type_requested": "System.Guid", 
               "required": false, 
               "name": "RunspaceId", 
               "title": "RunspaceId", 
               "__type_mapping_type": "String", 
               "readonly": true, 
               "type": "string"
          }, 
          "Guid": {
               "__type_requested": "System.Guid", 
               "required": true, 
               "name": "Guid", 
               "title": "Guid", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "Id": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "Id", 
               "title": "Id", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }, 
          "ObjectCategory": {
               "__type_requested": "System.String", 
               "required": true, 
               "name": "ObjectCategory", 
               "title": "ObjectCategory", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string"
          }
     }, 
     "schema_version": "15312"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/exchangehybrid/MalwareFilteringServer/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/exchangehybrid/MalwareFilteringServer device/exchangehybrid/MalwareFilteringServer schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/exchangehybrid/MalwareFilteringServer/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/MalwareFilteringServer/[pkid1]", "/api/v0/device/exchangehybrid/MalwareFilteringServer/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/exchangehybrid/MalwareFilteringServer	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchangehybrid/MalwareFilteringServer/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/exchangehybrid/MalwareFilteringServer	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/exchangehybrid/MalwareFilteringServer/[pkid1]", "/api/device/exchangehybrid/MalwareFilteringServer/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/MalwareFilteringServer; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/exchangehybrid/MalwareFilteringServer/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/exchangehybrid/MalwareFilteringServer/[pkid1]", "/api/device/exchangehybrid/MalwareFilteringServer/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of device/exchangehybrid/MalwareFilteringServer and the JSON format can be used to import instances of device/exchangehybrid/MalwareFilteringServer.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/exchangehybrid/MalwareFilteringServer:

 GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/MalwareFilteringServer	POST	/api/device/exchangehybrid/MalwareFilteringServer/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/exchangehybrid/MalwareFilteringServer	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/exchangehybrid/MalwareFilteringServer/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/exchangehybrid/MalwareFilteringServer/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/exchangehybrid/MalwareFilteringServer/	hierarchy=[hierarchy] format=json schema=true	The device/exchangehybrid/MalwareFilteringServer schema and all instances as JSON.

(The list will return 0 to 3 device/exchangehybrid/MalwareFilteringServer instances)

GET http://[host]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/exchangehybrid/MalwareFilteringServer/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "15312", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangehybrid/MalwareFilteringServer", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/exchangehybrid/MalwareFilteringServer/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/exchangehybrid/MalwareFilteringServer", 
          "model_specific_actions": [
               "get", 
               "list", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Name", 
                    "title": "Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/exchangehybrid/MalwareFilteringServer.	GET	/api/device/exchangehybrid/MalwareFilteringServer/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/exchangehybrid/MalwareFilteringServer as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/exchangehybrid/MalwareFilteringServer

GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/MalwareFilteringServer	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangehybrid/MalwareFilteringServer; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of device/exchangehybrid/MalwareFilteringServer and the JSON format can be used to import instances of device/exchangehybrid/MalwareFilteringServer.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]	hierarchy=[hierarchy]	The device/exchangehybrid/MalwareFilteringServer instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/exchangehybrid/MalwareFilteringServer.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/exchangehybrid/MalwareFilteringServer/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/exchangehybrid/MalwareFilteringServer

GET http://[host-proxy]/api/device/exchangehybrid/MalwareFilteringServer/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/exchangehybrid/MalwareFilteringServer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Purge