Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
RemoteSiteSetting
RemoteSiteSetting extends the Metadata metadata type and inherits its fullName field.
Declarative Metadata File Suffix and Directory Location
RemoteSiteSetting components are stored in the remoteSiteSettings directory of the corresponding package directory. The file name matches the unique name of the remote site setting, and the extension is .remoteSite.
Version
RemoteSiteSetting components are available in API version 19.0 and later.
Fields
| Field | Field Type | Description |
|---|---|---|
| description | string | The description explaining what this remote site setting is used for. |
| disableProtocolSecurity | boolean | Required. Indicates whether code within Salesforce
can access the remote site regardless of whether the user's
connection is over HTTP or HTTPS (true) or not (false). When true, code
within Salesforce can pass data from an HTTPS session to an HTTP session,
and vice versa.
Only set to true if you understand the security implications. |
| fullName | string | The
name can only contain characters, letters, and the underscore
(_) character. The name must start with a letter, and can’t end
with an underscore or contain two consecutive underscore
characters. Inherited from the Metadata component, this field isn’t defined in the WSDL for this component. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call. |
| isActive | boolean | Required. Indicates if the remote site setting is active (true) or not (false). |
| url | string | Required. The URL for the remote site. |
Declarative Metadata Sample Definition
A sample XML definition of a remote site setting is shown in this code block.
<?xml version="1.0" encoding="UTF-8"?>
<RemoteSiteSetting xmlns="http://soap.sforce.com/2006/04/metadata">
<description>Used for Apex callout to mapping web service</description>
<disableProtocolSecurity>false</disableProtocolSecurity>
<isActive>true</isActive>
<url>https://www.maptestsite.net/mapping1</url>
</RemoteSiteSetting>