[Index]
Model ref.: device/exchangehybrid/SenderFilterConfig
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "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" }, "AdminDisplayName": { "__type_requested": "System.String", "required": true, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "InternalMailEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "InternalMailEnabled", "title": "InternalMailEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The InternalMailEnabled parameter enables or disables sender filtering on authenticated connections from authoritative domains in your organization. Valid input for this parameter is $true or $false. The default value is $false." }, "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" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ExternalMailEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ExternalMailEnabled", "title": "ExternalMailEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The ExternalMailEnabled parameter enables or disables sender filtering on unauthenticated connections from external messaging servers. Valid input for this parameter is $true or $false. The default value is $true." }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RecipientBlockedSenderAction": { "__type_requested": "System.String", "required": true, "name": "RecipientBlockedSenderAction", "title": "RecipientBlockedSenderAction", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The RecipientBlockedSenderAction parameter specifies the action that the Sender Filter agent takes on messages received from blocked senders that are defined by SafeList aggregation. SafeList aggregation adds blocked senders that are defined by your users in Microsoft Outlook or Outlook Web App to the Blocked Senders list that's used by the Sender Filter agent.\nValid input for this parameter is Delete or Reject. The default value is Reject." }, "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" }, "BlockedDomains": { "__type_requested": "MultiValuedProperty", "required": true, "name": "BlockedDomains", "title": "BlockedDomains", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The BlockedDomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, the Sender Filter agent takes the action specified by the Action parameter.\nValid input for this parameter is one or more domains or subdomains. Wildcard characters aren't permitted. For example, if you specify the values contoso.com and marketing.contoso.com, only messages from those domains are blocked by the Sender Filter agent. Messages from sales.contoso.com aren't blocked by the Sender Filter agent.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThe maximum number of entries for this parameter is 800." }, "Enabled": { "__type_requested": "System.Boolean", "required": true, "name": "Enabled", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The Enabled parameter enables or disables sender filtering on your Exchange server. Valid input for this parameter is $true or $false. The default value is $true." }, "BlankSenderBlockingEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "BlankSenderBlockingEnabled", "title": "BlankSenderBlockingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The BlankSenderBlockingEnabled parameter blocks or allows messages that don't contain a sender value in the SMTP command MAIL FROM. Valid input for this parameter is $true or $false. The default value is $false." }, "BlockedDomainsAndSubdomains": { "__type_requested": "MultiValuedProperty", "required": true, "name": "BlockedDomainsAndSubdomains", "title": "BlockedDomainsAndSubdomains", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The BlockedDomainsAndSubdomains parameter specifies the domain names to block. When the Sender Filter agent encounters a message from a domain on this list, or from any of the domain's subdomains, the Sender Filter agent takes the action specified by the Action parameter.\nValid input for this parameter is one or more domains. Wildcard characters aren't permitted. For example, if you specify the value contoso.com, messages from contoso.com, sales.contoso.com, and all other subdomains of contoso.com are blocked by the Sender Filter agent.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThe maximum number of entries for this parameter is 800." }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "Action": { "__type_requested": "System.String", "required": true, "name": "Action", "title": "Action", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Action parameter specifies the action that the Sender Filter agent takes on messages from blocked senders or domains. Valid input for this parameter is StampStatus or Reject. The default value is Reject." }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "BlockedSenders": { "__type_requested": "MultiValuedProperty", "required": true, "name": "BlockedSenders", "title": "BlockedSenders", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The BlockedSenders parameter specifies one or more SMTP email addresses to block. When the Sender Filter agent encounters a message from a sender on this list, the Sender Filter agent takes the action specified by the Action parameter.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThe maximum number of entries for this parameter is 800." }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "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" }, "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" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/SenderFilterConfig/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/SenderFilterConfig/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/SenderFilterConfig/[pkid1]", "/api/v0/device/exchangehybrid/SenderFilterConfig/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/SenderFilterConfig/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SenderFilterConfig |
|
{"hrefs": ["/api/device/exchangehybrid/SenderFilterConfig/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SenderFilterConfig |
|
{"hrefs": ["/api/device/exchangehybrid/SenderFilterConfig/[pkid1]", "/api/device/exchangehybrid/SenderFilterConfig/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/SenderFilterConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/SenderFilterConfig/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/SenderFilterConfig/[pkid1]", "/api/device/exchangehybrid/SenderFilterConfig/[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/SenderFilterConfig and the JSON format can be used to import instances of device/exchangehybrid/SenderFilterConfig.
GET http://[host-proxy]/api/device/exchangehybrid/SenderFilterConfig/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/SenderFilterConfig | POST | /api/device/exchangehybrid/SenderFilterConfig/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchangehybrid/SenderFilterConfig/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/SenderFilterConfig/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/SenderFilterConfig/ |
|
The device/exchangehybrid/SenderFilterConfig schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/SenderFilterConfig instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/SenderFilterConfig/?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/SenderFilterConfig/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/SenderFilterConfig", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/SenderFilterConfig/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/SenderFilterConfig/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/SenderFilterConfig/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/SenderFilterConfig/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/SenderFilterConfig/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/SenderFilterConfig/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/SenderFilterConfig/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/SenderFilterConfig", "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/SenderFilterConfig. | GET | /api/device/exchangehybrid/SenderFilterConfig/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/SenderFilterConfig as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/SenderFilterConfig/[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/SenderFilterConfig/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/SenderFilterConfig/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/SenderFilterConfig | 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/SenderFilterConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/SenderFilterConfig/[pkid]/export |
|
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/SenderFilterConfig and the JSON format can be used to import instances of device/exchangehybrid/SenderFilterConfig.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/SenderFilterConfig/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/SenderFilterConfig instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/SenderFilterConfig/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/SenderFilterConfig. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/SenderFilterConfig/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |