How to get the current sandbox-name programmatically (dynamically) via APEX?

Question

Now after all mere subscribers has per default a lot of sandboxes available, I need a way to programmatically (dynamically) get the sandbox-name of the sandbox org where the actual code is executed.

Just for clarification: I'm not looking for the name of the org, but the name of the sandbox, which are two different things.

One example purpose for this requirement is to tag notification emails, so that it's clear which sandbox-org has created it. For sure I don't want to hardcode it. Also I don't want to use a custom setting.

If found a few unclean approaches like

• UserInfo.getUserName().substringAfterLast('.'); ==> this is not reliable, username might have been changed or a system-user might act. But this comes closest to what I need.

• use of Organization.IsSandbox ==> not good enough, does not tell me which of the 25+ possible sandboxes it is. Only that's not production. I need more

• use of Organization.Name ==> all the same for all sandboxes

• use of Organization.InstanceName ==> provides the server name like CS83, very nice, but not good enough

I think there is no officially supported way to get it... but I'm not 100% sure...

Is there any approach to "hack" that sandbox name out of the guts of the platform? I need no sample code, just an idea or a concept is good enough for me.

Answer 1

After Spring'16 release there is an ability to specify an Apex class which executes every time the sandbox is copied. See SandboxPostCopy Interface. You can get the sandbox name from SandboxContext and store it in a custom setting. Notice the example indicates this method signature exists: SandboxContext.sandboxName().

global class HelloWorld implements SandboxPostCopy {
    global void runApexClass(SandboxContext context) {
        System.debug('Hello Tester Pester ' + context.organizationId() + ' 
                  ' + context.sandboxId() + context.sandboxName());
    }
}

Answer 2

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 3

One possible way is screen scraping. Take a look at this answer on how to scrape screen using http request. screen scrape Salesforce with REST GET call from Apex

Please note 2 things

1) This approach seems fragile
2) You can use it from JavaScript and Apex

There is idea posted for for this feature. https://success.salesforce.com/ideaView?id=08730000000Dld9AAC

So, seems like we will have to leave with workarounds mentioned in OP + the one i mentioned.

Answer 4

The DomainParser class is the best way to find the name of the actual sandbox you are working in. (https://help.salesforce.com/s/articleView?id=release-notes.rn_apex_domain_classes.htm&release=236&type=5)

I think there may be some confusion from looking at previous answers...

context.SandboxName() will give you the Organization name as listed in the Company Information section. In my experience this mirrors prod in all sandboxes, and is certainly what I get when I try the above example.

I've tested Fabiens answer above and this will give you the name of the actual sandbox you are in as it is listed in the Sandboxes section in production. This is what I was looking for and I'd imagine its what most people are looking for when they visit this question