Migrate SIMs between Workspaces | emnify Documentation

Migrate SIMs from one workspace to another. The calling user must have admin permissions on the target Workspace and the source Workspaces. The target Workspace must be an enterprise Workspace.

The request fails if one or more SIMs don’t meet the requirements for migration.

Only 500 SIMs can be migrated at once.

SIMs in status ACTIVATED are suspended during migration.

Migrate SIMs from one workspace to another. The calling user must have admin permissions on the target Workspace and the source Workspaces. The target Workspace must be an enterprise Workspace. <Warning> The request fails if one or more SIMs don't meet the requirements for migration. </Warning> <Note> Only 500 SIMs can be migrated at once. </Note> <Info> SIMs in status `ACTIVATED` are suspended during migration. </Info>

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. Cannot be used in combination with the iccids or the iccid_range field. The list may include up to 500 SIMs.

iccidslist of stringsOptional

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

iccid_rangeobjectOptional

ICCID range to migrate. All SIMs withing the range must belong to the source Workspace. Cannot be used in combination with the iccids or the sims field. The range may include up to 500 ICCIDs.

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_runbooleanOptional

If set to true, the API returns a summary of the changes that would be performed without executing the migration. Defaults to true.

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 or null

The allowed_sim_statuses option specified in the request

1	import requests
2
3	url = "https://cdn.emnify.net/api/v1/sim/migration/workspace"
4
5	headers = {
6	"Authorization": "Bearer <token>",
7	"Content-Type": "application/json"
8	}
9
10	response = requests.post(url, headers=headers)
11
12	print(response.json())

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	}

Authentication

Request

Response

Errors