how to get sandbox name in apex?

Question

How to get the name of the sandbox in apex? I know how to determine if the environment is sandbox or production. Is there any metadata available in salesforce to find out the name of the sandbox that is being used (through apex)? If possible through SOQL as well?

Answer 1

There is now an official solution that is out with the Spring' 22 release.
You can use the new getSandboxName() method:

System.Domain d = System.DomainParser.parse(URL.getOrgDomainUrl());
System.debug(d.getSandboxName());

You can get more information about this new method in the Apex Reference Guide here.
There are also so other new and useful methods like getMyDomainName().

Answer 2

Well this may seem like a somewhat simplistic approach but when you create a Sandbox, SF appends the name of the sandbox to the usernames. You could simply query one or more usernames from the User object using SOQL and parse out the common suffix (eg. 'xxx.com.DEV').

Granted this isn't a sure fire way to get the value but might work in a pinch.

Answer 3

If you want it for some setup sandbox activities, for example to set it to custom setting, you can use this one:

UserInfo.getUserName().substringAfterLast('.');

Once it will be set in your custom setting you can use it elsewhere on any user (with or without sandbox name appended).

Answer 4

• If you are using SAML, your sandbox url could be configured like:

  https://sbnamesso--sbname.cs41.my.salesforce.com

Next call could be used:

return URL.getSalesforceBaseUrl().getHost().substringBetween('--','.');

• If we inspect message in the top right corner:

  Sandbox: Full

We could use JS to get sandbox name:

var x = document.getElementsByClassName("subMsg normalImportance");
    if (x.length > 1) {
    alert('Sandbox: ' + x[1].innerHTML);
}

Unfortunately it's working only from UI.

Answer 5

I think you are just looking for the getHost() method on the System URL class. All sandbox pods are cs*, and all production pods are not.

From the docs:

System.debug('Host: ' + URL.getSalesforceBaseUrl().getHost());

So try

public Boolean isSandbox() {
    return URL.getSalesforceBaseUrl().getHost().left(2).equalsignorecase('cs');
}