You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
cartridge_deploy now reminds users to update the site cartridge path in Business Manager (Sites → Manage Sites → [site] → Settings tab → Cartridges) after deploy.
abcd 002 stopped large 2024-12-19 2024-12-20 22:30 Yes
126
126
```
127
127
128
128
The `EOL` column displays `YYYY-MM-DD` normally. When a sandbox expires within 24 hours (or is already expired), the time is also shown as `YYYY-MM-DD HH:mm` (UTC).
129
129
130
+
The `isCloned` column indicates whether a sandbox was created by cloning another sandbox (`Yes`) or not (`No`).
131
+
130
132
---
131
133
132
134
## b2c sandbox create
@@ -216,6 +218,12 @@ b2c sandbox get <SANDBOXID>
216
218
|----------|-------------|----------|
217
219
|`SANDBOXID`| Sandbox ID (UUID or realm-instance, e.g., `zzzv-123`) | Yes |
218
220
221
+
### Flags
222
+
223
+
| Flag | Description | Default |
224
+
|------|-------------|---------|
225
+
|`--clone-details`| Include detailed clone information if the sandbox was created by cloning |`false`|
226
+
219
227
### Examples
220
228
221
229
```bash
@@ -225,6 +233,9 @@ b2c sandbox get abc12345-1234-1234-1234-abc123456789
225
233
# Get sandbox details using realm-instance format
226
234
b2c sandbox get zzzv-123
227
235
236
+
# Get sandbox details with clone information
237
+
b2c sandbox get zzzv-123 --clone-details
238
+
228
239
# Output as JSON
229
240
b2c sandbox get zzzv_123 --json
230
241
```
@@ -239,6 +250,19 @@ Displays detailed information about the sandbox including:
239
250
- Creation time and end-of-life
240
251
- Links to BM and storefront
241
252
253
+
If the sandbox was created by cloning another sandbox, a "Clone Details" section is displayed showing:
254
+
- Cloned From (realm-instance identifier)
255
+
- Source Instance ID (UUID)
256
+
257
+
When the `--clone-details` flag is used, additional clone metadata is included:
On-demand sandbox cloning enables you to create replicas of existing sandboxes in minutes, not hours. It helps teams move faster while reducing risk by providing fully isolated environments for development, testing, and operational workflows.
677
+
678
+
With a single API call, you can provision a fully isolated replica of your sandbox that includes your database, application code, platform configurations, and all configured feature toggles.
679
+
680
+
**Important:** To ensure a consistent and reliable clone, the source sandbox is automatically placed in a protected **Stopped** state during the cloning process. This safeguard guarantees data integrity and configuration consistency. Once cloning is complete, the source sandbox resumes normal operation.
681
+
682
+
Each cloned sandbox is fully isolated, with dedicated compute, storage, and database resources.
683
+
684
+
Clone commands are available both under the `sandbox` topic and the legacy `ods` aliases:
The `Created At` column displays `YYYY-MM-DD HH:mm` when the clone was created within the last 24 hours, otherwise just `YYYY-MM-DD` (all times in UTC).
761
+
762
+
### b2c sandbox clone create
763
+
764
+
Create a new sandbox clone from an existing sandbox. This creates a complete copy of the source sandbox including all data, configuration, and custom code.
765
+
766
+
#### Usage
767
+
768
+
```bash
769
+
b2c sandbox clone create <SANDBOXID>
770
+
```
771
+
772
+
#### Arguments
773
+
774
+
| Argument | Description | Required |
775
+
|----------|-------------|----------|
776
+
|`SANDBOXID`| Sandbox ID (UUID or realm-instance, e.g., `zzzv-123`) to clone from | Yes |
777
+
778
+
#### Flags
779
+
780
+
| Flag | Description | Default |
781
+
|------|-------------|---------|
782
+
|`--target-profile`| Resource profile for the cloned sandbox (`medium`, `large`, `xlarge`, `xxlarge`). Optional. | Source sandbox profile |
783
+
|`--ttl`| Time to live in hours (0 or negative = infinite, minimum 24 hours). Values between 1-23 are not allowed. |`24`|
784
+
|`--emails`| Comma-separated list of notification email addresses ||
785
+
786
+
#### Examples
787
+
788
+
```bash
789
+
# Create a clone with same profile as source sandbox
790
+
b2c sandbox clone create zzzv-123
791
+
792
+
# Create a clone with custom TTL (uses source profile)
793
+
b2c sandbox clone create zzzv-123 --ttl 48
794
+
795
+
# Create a clone with a different profile
796
+
b2c sandbox clone create zzzv-123 --target-profile large
797
+
798
+
# Create a clone with large profile and extended TTL
799
+
b2c sandbox clone create zzzv-123 --target-profile large --ttl 48
b2c sandbox clone get zzzv-123 aaaa-002-1642780893121
819
+
```
820
+
821
+
#### Notes
822
+
823
+
-**Source sandbox will be stopped:** The source sandbox is automatically placed in a **Stopped** state during cloning to ensure data integrity and configuration consistency. It resumes normal operation once cloning is complete.
824
+
- Cloning typically completes in minutes, though duration depends on sandbox size and data volume
825
+
- The cloned sandbox is fully isolated with dedicated compute, storage, and database resources
826
+
- When `--target-profile` is not specified, the API automatically uses the source sandbox's resource profile (no additional API call is made)
827
+
- The TTL must be 0 or negative (infinite), or 24 hours or greater. Values between 1-23 are rejected
828
+
- The clone will be created as a new sandbox instance in the same realm
829
+
830
+
### b2c sandbox clone get
831
+
832
+
Retrieve detailed information about a specific sandbox clone, including status, progress, and metadata.
833
+
834
+
#### Usage
835
+
836
+
```bash
837
+
b2c sandbox clone get <SANDBOXID><CLONEID>
838
+
```
839
+
840
+
#### Arguments
841
+
842
+
| Argument | Description | Required |
843
+
|----------|-------------|----------|
844
+
|`SANDBOXID`| Sandbox ID (UUID or realm-instance, e.g., `zzzv-123`) | Yes |
845
+
|`CLONEID`| Clone ID (e.g., `aaaa-002-1642780893121`) | Yes |
846
+
847
+
#### Examples
848
+
849
+
```bash
850
+
# Get clone details
851
+
b2c sandbox clone get zzzv-123 aaaa-002-1642780893121
852
+
853
+
# Output as JSON
854
+
b2c sandbox clone get zzzv-123 aaaa-002-1642780893121 --json
855
+
```
856
+
857
+
#### Output
858
+
859
+
Displays comprehensive clone information in a formatted table:
For the complete response including all metadata, use the `--json` flag.
881
+
882
+
#### Clone Status Values
883
+
884
+
| Status | Description |
885
+
|--------|-------------|
886
+
|`PENDING`| Clone is queued and waiting to start |
887
+
|`IN_PROGRESS`| Clone operation is currently running |
888
+
|`COMPLETED`| Clone finished successfully |
889
+
|`FAILED`| Clone operation failed |
890
+
891
+
---
892
+
650
893
## Realm-Level Commands
651
894
652
895
Realm commands operate at the **realm** level rather than on an individual sandbox. They are available as both `realm` topic commands and as `sandbox realm` subcommands:
@@ -662,12 +905,12 @@ To run `b2c realm` commands, your user or API client must have **realm‑level a
662
905
663
906
### b2c realm list
664
907
665
-
List realms eligible for sandbox management, optionally including a simple usage summary.
0 commit comments