---
schema_version: "1"
id: 16cd2544550ad277c8b0e786bcd38230d2ff92c755ef971130e7163f8b8e9b6a
title: RemoteProxy
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_remoteproxy.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_remoteproxy.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5d2f97ed559faae7a338c1f20a8835d967290e0816f472a2dc99d1c82afec790
description: 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. Available in Tooling API version 37.0 and later.
---
# 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. Available in Tooling API version 37.0 and later.

## Supported SOAP Calls

create(), query(), retrieve() update()

## Supported REST HTTP Methods

GET

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d285163e80">Field</th>

              <th class="featureTableHeader  " id="d285163e83">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">Description</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The description explaining what this remote site setting
                    is used for.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">EndpointUrl</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. The URL of the remote site.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">FullName</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Group, Nillable</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">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. <p class="p">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.</p>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">IsActive</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Defaulted on create, Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Indicates whether the remote site setting is
                    active (<samp class="ph systemoutput">true</samp>) or not
                    (<samp class="ph systemoutput">false</samp>).</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">ManageableState</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">ManageableState enumerated list</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates the manageable state of the specified component that is contained
                    in a package: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">beta</samp></li>

                      <li class="li"><samp class="codeph nolang">deleted</samp></li>

                      <li class="li"><samp class="codeph nolang" id="d7363e259-d7429e373"><a name="d7363e259-d7429e373"><!-- --></a>deprecated</samp></li>

                      <li class="li"><samp class="codeph nolang">deprecatedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">installed</samp></li>

                      <li class="li"><samp class="codeph nolang">installedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">released</samp></li>

                      <li class="li"><samp class="codeph nolang">unmanaged</samp></li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">This field is available in API version 38.0 and later.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">Metadata</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">complexvalue</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Nillable, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Metadata that defines the remote site setting.<p class="p">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.</p>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">NamespacePrefix</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">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 <samp class="codeph nolang">namespacePrefix__componentName</samp>
                    notation.The namespace prefix can have one of the
                    following values:<ul class="ul bulletList">
                      <li class="li">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.</li>

                      <li class="li">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.</li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">ProtocolMismatch</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Defaulted on create, Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. Indicates whether code within Salesforce can access the remote site regardless of whether the
                    user's connection is over HTTP or HTTPS
                    (<samp class="ph systemoutput">true</samp>) or not
                    (<samp class="ph systemoutput">false</samp>). When
                    <samp class="ph systemoutput">true</samp>, code within Salesforce can pass data between HTTPS and HTTP sessions.<div class="box message warn">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_warning.png" alt="Warning">
                            <div class="mediaBd">
                              <h4 class="mbs">Warning</h4>
                              <p>Only set to
                                <samp class="ph systemoutput">true</samp> if you
                                understand the security
                                implications.
                              </p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>This field corresponds to
                                the <span class="keyword parmname">disableProtocolSecurity</span>
                                field in the Metadata API type.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d285163e80" data-title="Field"><span class="keyword parmname">SiteName</span></td>

              <td class="entry" headers="d285163e83" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Required. The name of the remote site.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>