RemoteProxy

Represents a set of remote site settings that allows you to access an external site from Salesforce. Use RemoteProxy when accessing external sites called by Visualforce pages, Apex callouts, or JavaScript codes using XmlHttpRequest in an s-control or custom button. To be accessible, an external site must have its settings defined with RemoteProxy or registered in the Remote Site Settings page.

Version 

Introduced in API version 37.0.

Supported SOAP API Calls 

create(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

GET, HEAD, PATCH, POST, Query

Fields 

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The description explaining what this remote site setting is used for.

EndpointUrl 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The URL of the remote site.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 37.0

• Description: The unique name used as the remote site identifier for API access. The name can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Required. Indicates whether the remote site setting is active (true) or not (false).

• Default value: false

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

This field is available in API version 38.0 and later.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 37.0

• Description: Metadata that defines the remote site setting.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix of up to 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.The namespace prefix can have one of the following values:

• In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.

• In organizations that are not Developer Edition organizations, NamespacePrefix is set only for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

ProtocolMismatch 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 37.0

• Description: 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 between HTTPS and HTTP sessions.

• Default value: false

  Only set to true if you understand the security implications.

  Warning

  This field corresponds to the disableProtocolSecurity field in the Metadata API type.

  Note

SiteName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The name of the remote site.