Migrate SIMs between Workspaces

POST

https://cdn.emnify.net/api/v1/sim/migration/workspace

POST

/api/v1/sim/migration/workspace

$ curl -X POST https://cdn.emnify.net/api/v1/sim/migration/workspace \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "target_workspace": {
>     "id": 1
>   },
>   "iccids": [
>     "1234567890123456789",
>     "1234567890123456790"
>   ],
>   "allowed_sim_statuses": [
>     {
>       "id": 1
>     }
>   ],
>   "dry_run": false,
>   "auto_detach_devices": true
> }'

1 {
2   "sim_count": 2,
3   "dry_run": false,
4   "target_workspace": {
5     "id": 98,
6     "name": "My Target Workspace"
7   },
8   "auto_detach_devices": true,
9   "sims": [
10     {
11       "status": {
12         "id": 1,
13         "description": "ACTIVATED"
14       },
15       "id": 1,
16       "iccid": "1234567890123456789",
17       "iccid_with_luhn": "12345678901234567891",
18       "endpoint": {
19         "id": 75,
20         "name": "My Device"
21       },
22       "source_workspace": {
23         "id": 53,
24         "name": "My Workspace"
25       }
26     },
27     {
28       "status": {
29         "id": 2,
30         "description": "SUSPENDED"
31       },
32       "id": 24,
33       "iccid": "1234567890123456790",
34       "iccid_with_luhn": "12345678901234567901",
35       "source_workspace": {
36         "id": 53,
37         "name": "My Workspace"
38       }
39     }
40   ]
41 }

Migrate SIMs from one Workspace to another. ## Requirements - The calling user must have **Administrator** permissions on both the target and source Workspaces - The target Workspace must be an enterprise Workspace - Only 500 SIMs can be migrated per request - You must provide exactly one of: `sims`, `iccids`, or `iccid_range` <Note> This endpoint requires authentication with [user credentials](/developers/auth/user-credentials), as application tokens are scoped to a single Workspace. </Note> ## Behavior - **Dry run mode**: The `dry_run` parameter defaults to `true`. Set it to `false` to execute the migration. - **Activated SIMs**: SIMs in status `ACTIVATED` are automatically suspended during migration. - **Attached devices**: If SIMs are attached to devices, set `auto_detach_devices: true` or the request fails. <Warning> The request fails if one or more SIMs don't meet the requirements for migration. Check the `errors` array in the response for details. </Warning>

Migrate SIMs from one Workspace to another.

Requirements

The calling user must have Administrator permissions on both the target and source Workspaces
The target Workspace must be an enterprise Workspace
Only 500 SIMs can be migrated per request
You must provide exactly one of: sims, iccids, or iccid_range

This endpoint requires authentication with user credentials, as application tokens are scoped to a single Workspace.

Behavior

Dry run mode: The dry_run parameter defaults to true. Set it to false to execute the migration.
Activated SIMs: SIMs in status ACTIVATED are automatically suspended during migration.
Attached devices: If SIMs are attached to devices, set auto_detach_devices: true or the request fails.

The request fails if one or more SIMs don’t meet the requirements for migration. Check the errors array in the response for details.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.

target_workspaceobjectRequired

Target Workspace to migrate SIMs to. Must be an enterprise Workspace. The calling user must have Administrator permissions on the target Workspace.

simslist of objectsOptional

List of SIMs to migrate. The list may include up to 500 SIMs. <Info> Cannot be used in combination with the `iccids` or the `iccid_range` field. </Info>

iccidslist of stringsOptional

List of ICCIDs to migrate. All SIMs must belong to the source Workspace. The list may include up to 500 ICCIDs. <Info> Cannot be used in combination with the `sims` or the `iccid_range` field. </Info>

iccid_rangeobjectOptional

ICCID range to migrate. All SIMs within the range must belong to the source Workspace. The range may include up to 500 ICCIDs. The `end` value must be greater than or equal to the `start` value. <Info> Cannot be used in combination with the `iccids` or the `sims` field. </Info>

allowed_sim_statuseslist of objectsOptional

List of SIM statuses that are allowed to be migrated. The request is rejected if a SIM has a status that isn't in this list. If not provided, all SIM statuses are allowed.

dry_runbooleanOptionalDefaults to true

Controls whether the migration is executed or simulated. - `true` (default): Returns a preview of SIMs that would be migrated without making changes - `false`: Executes the migration <Tip> Always test with a dry run first to verify the SIMs match your expectations. </Tip>

auto_detach_devicesbooleanOptional

If set to true, the SIMs automatically detach from the devices before being migrated. Otherwise, the request is rejected if one or more SIMs are attached to devices.

Response

Successful migration request. If dry_run was set to false, the migration is processed. If dry_run was set to true, the response contains a summary of the changes that would be executed.

sim_countdouble

The amount of SIMs to be migrated

dry_runboolean

The dry_run option specified in the request

target_workspaceobject

The target_workspace specified in the request

auto_detach_devicesboolean

The auto_detach_devices option specified in the request

simslist of objects

List of SIMs to be migrated

allowed_sim_statuseslist of objects

The allowed_sim_statuses option specified in the request

Errors

400

Bad Request Error

404

Not Found Error

409

Conflict Error

$	curl -X POST https://cdn.emnify.net/api/v1/sim/migration/workspace \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"target_workspace": {
>	"id": 1
>	},
>	"iccids": [
>	"1234567890123456789",
>	"1234567890123456790"
>	],
>	"allowed_sim_statuses": [
>	{
>	"id": 1
>	}
>	],
>	"dry_run": false,
>	"auto_detach_devices": true
>	}'

1	{
2	"sim_count": 2,
3	"dry_run": false,
4	"target_workspace": {
5	"id": 98,
6	"name": "My Target Workspace"
7	},
8	"auto_detach_devices": true,
9	"sims": [
10	{
11	"status": {
12	"id": 1,
13	"description": "ACTIVATED"
14	},
15	"id": 1,
16	"iccid": "1234567890123456789",
17	"iccid_with_luhn": "12345678901234567891",
18	"endpoint": {
19	"id": 75,
20	"name": "My Device"
21	},
22	"source_workspace": {
23	"id": 53,
24	"name": "My Workspace"
25	}
26	},
27	{
28	"status": {
29	"id": 2,
30	"description": "SUSPENDED"
31	},
32	"id": 24,
33	"iccid": "1234567890123456790",
34	"iccid_with_luhn": "12345678901234567901",
35	"source_workspace": {
36	"id": 53,
37	"name": "My Workspace"
38	}
39	}
40	]
41	}