How to create remote site settings through apex.

Step 1:

Create a new class for Metadata Service, and copy the contents of attached Metadata Service file. MetadataService

Step 2:

Add the following endpoints to your remote site settings, It is required to callout the web service.

https://c.ap1.visual.force.com

https://ap1.salesforce.com

Note:- Change sub domains of the endpoints according to your org.

Step 3:

Create a visual force page along with its controller class. And use the following code.

public with sharing class MetaController {

public static void createRemoteSiteSettings()
{
    MetadataService.MetadataPort service = createService();
    MetadataService.RemoteSiteSetting remoteSiteSettings = new MetadataService.RemoteSiteSetting();
    remoteSiteSettings.fullName = ‘Test12345’;
    remoteSiteSettings.url = ‘http://www.google.com’;
    remoteSiteSettings.description=’ewf’;
    remoteSiteSettings.isActive=true;
    remoteSiteSettings.disableProtocolSecurity=false;
    MetadataService.AsyncResult[] results = service.create(new List<MetadataService.Metadata> { remoteSiteSettings });
    MetadataService.AsyncResult[] checkResults = service.checkStatus(new List<string> {string.ValueOf(results[0].Id)});
    system.debug(‘chk’ + checkResults );
}

public static MetadataService.MetadataPort createService()
{
    MetadataService.MetadataPort service = new MetadataService.MetadataPort();
    service.SessionHeader = new MetadataService.SessionHeader_element();
    service.SessionHeader.sessionId = UserInfo.getSessionId();
    return service;
}

13 thoughts on “How to create remote site settings through apex.”

John
says:
October 30, 2013 at 3:15 pm


Thanks! Needed this code.
Patlatus
says:
April 1, 2015 at 4:46 pm


Hi,
Cool snippet for creation of remote site setting.
Do you know, however, how to retrieve existing site settings (all or by name)?
1. Pooja
  says:
  October 6, 2017 at 7:38 am
  
  
  You may use financial force MetadataService API its a wrapper over salesforce meta data api. Checkout this link https://github.com/financialforcedev/apex-mdapi/blob/master/apex-mdapi/src/classes/MetadataService.cls
Ankit Sharma
says:
June 5, 2015 at 6:34 pm


Thanks Patlatus.

However, it’s been a long time since I coded on salesforce platform. So I can’t recall at the moment.
RAJU
says:
August 26, 2015 at 7:35 am


Cna u plz share vf page code .my mail id is nagarajuu.c@gmail.com
RAJU
says:
August 26, 2015 at 7:37 am


I dont know how to create remote site settings through apex dyanamically i am new in soap and rest plz help me

nagarajuu.c@gmail.com
Ashish Narang
says:
January 9, 2016 at 12:32 pm


No need to have this code, you can package it directly.
Actual thing I was looking for was – How to add salesforce URL https://ap1.salesforce.com itself as remote site settings through code
1. Renu Arora
  says:
  August 26, 2016 at 5:49 am
  
  
  I had the same query. I have to add the Salesforce url itself to the RemoteSiteSettings. Did you find the answer to your query?
ruban
says:
April 15, 2016 at 11:24 am


Hi Ankit,

Nice snippet.i need this,

But i need test class for the above two classes.
can u please help me?
1. Ankit Sharma
  says:
  May 7, 2016 at 2:05 pm
  
  
  Sorry. I don’t have the test class with me.
Paritosh
says:
July 30, 2017 at 3:39 pm


Thanks you it was very helpful 🙂
winlaeaye
says:
September 22, 2017 at 4:21 am


Can you give me VF page code? Thanks in advance….
Pls send code to this email gccuser201709@gmail.com
Shiva
says:
June 28, 2018 at 9:30 am


I tried to put this code in apex controller and calling it from the lightning and it is throwing me this error.
“Web service callout failed: WebService returned a SOAP Fault: INVALID_SESSION_ID: This session is not valid for use with the API faultcode=sf:INVALID_SESSION_ID faultactor=”
What is c.ap1 in https://c.ap1.visual.force.com here. (Please Suggest)
I replaced my domain name in the place of ap1 in this url “https://ap1.salesforce.com”

How to create remote site settings through apex.