{ "info": { "_postman_id": "2f24a736-e7cd-417d-9a3c-371b9dcaf706", "name": "Soracom SIM Management API", "description": "Manage Soracom Air for Cellular SIMs and Subscribers including session control, plan changes, group binding, and lifecycle operations.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "lastUpdatedBy": "35240", "uid": "35240-2f24a736-e7cd-417d-9a3c-371b9dcaf706" }, "item": [ { "name": "sims", "item": [ { "name": "{sim_id}", "item": [ { "name": "activate", "item": [ { "name": "Activate SIM", "id": "ffd6a755-f311-48b9-a831-0840a7d01e91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/activate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "activate" ], "variable": [ { "id": "9cd97f37-768f-40e5-b362-49e350ac7c11", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Changes status of specified SIM to \"active\"." }, "response": [ { "id": "e95db33f-63c1-4403-9729-56da1b7bb9f0", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/activate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "activate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e95db33f-63c1-4403-9729-56da1b7bb9f0" }, { "id": "7cdf9c62-c76b-41c7-b5e9-08a834f8abbe", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/activate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "activate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7cdf9c62-c76b-41c7-b5e9-08a834f8abbe" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ffd6a755-f311-48b9-a831-0840a7d01e91" } ], "id": "15f9b7ee-f77f-4971-95fd-616029247975", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-15f9b7ee-f77f-4971-95fd-616029247975" }, { "name": "credentials", "item": [ { "name": "arc", "item": [ { "name": "(DEPRECATED) Removes the credentials for Arc from a SIM", "id": "bd7c3823-5da7-492b-99aa-fd4c6345ec1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "id": "2d01a8c1-9485-4f55-b2dd-8009e0b32a33", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "(DEPRECATED) Removes the credentials (public key) for Soracom Arc from the SIM.\n\n**Warning**: Do not use this API.\n" }, "response": [ { "id": "8c4ad099-b6f1-4626-aae7-5d8b95d00a60", "name": "The credentials for Arc have been removed.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "key": "sim_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-8c4ad099-b6f1-4626-aae7-5d8b95d00a60" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bd7c3823-5da7-492b-99aa-fd4c6345ec1c" }, { "name": "(DEPRECATED) Attaches the credentials for Arc to a SIM", "id": "66cbec85-247a-45f9-bb9e-0b44490c28e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"arcClientPeerPublicKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "id": "94404fc9-ad9f-4279-a50c-5a1c5f8858bf", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "(DEPRECATED) Attaches the credentials (public key) for Soracom Arc to the SIM.\n\n**Warning**: Please use the `renewArcSimCredentials` API instead.\n" }, "response": [ { "id": "5d7d9924-d828-4329-bf80-1418bab5a155", "name": "Arc credential attach response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"arcClientPeerPublicKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5d7d9924-d828-4329-bf80-1418bab5a155" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-66cbec85-247a-45f9-bb9e-0b44490c28e6" }, { "name": "Renew the credentials for Arc to a SIM", "id": "a63461f1-4f32-48c8-8dd7-035dfd8a1ef3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"arcClientPeerPublicKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "id": "826ae090-34c2-40ec-880d-87ca8ab7e093", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Attaches Arc credential to a SIM and re-initialize a session at once." }, "response": [ { "id": "f28f9600-3a88-4d73-8cef-b7b8ecd4247c", "name": "Arc credential attach response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"arcClientPeerPublicKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/credentials/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "credentials", "arc" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f28f9600-3a88-4d73-8cef-b7b8ecd4247c" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a63461f1-4f32-48c8-8dd7-035dfd8a1ef3" } ], "id": "a1765acc-4b61-4173-a901-8cc0f8b7ee45", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-a1765acc-4b61-4173-a901-8cc0f8b7ee45" } ], "id": "d11e52e9-d2f0-4668-bd2e-33b8c7cfddf6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d11e52e9-d2f0-4668-bd2e-33b8c7cfddf6" }, { "name": "data", "item": [ { "name": "Get data sent from a SIM to Harvest Data.", "id": "1811330d-610a-4c52-a74f-845120f347dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "data" ], "query": [ { "description": "Start time for the data entries search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the data entries search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "afe07795-4284-46db-9450-22b868be500a", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Returns a list of data entries sent to Harvest Data from a SIM that match certain criteria. If the total number of data entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "85cdbe62-7a03-46c7-86a6-59fc81540cec", "name": "A list of data entries.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "data" ], "query": [ { "description": "Start time for the data entries search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the data entries search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"Device\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"Sim\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-85cdbe62-7a03-46c7-86a6-59fc81540cec" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1811330d-610a-4c52-a74f-845120f347dc" } ], "id": "235305ce-e4f1-4b3e-8375-8bbfec38b1f8", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-235305ce-e4f1-4b3e-8375-8bbfec38b1f8" }, { "name": "deactivate", "item": [ { "name": "Deactivate SIM", "id": "6144e58d-ec2d-47fe-b509-736cb442ce7f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "deactivate" ], "variable": [ { "id": "02257fb8-5789-4084-965c-b2a174b1841b", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Changes status of specified SIM to \"inactive\"." }, "response": [ { "id": "0e790873-7547-4be2-8e73-d0d4c96fde3e", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "deactivate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-0e790873-7547-4be2-8e73-d0d4c96fde3e" }, { "id": "1f852f6f-5284-4aa5-912a-036f71bbe149", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "deactivate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1f852f6f-5284-4aa5-912a-036f71bbe149" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6144e58d-ec2d-47fe-b509-736cb442ce7f" } ], "id": "463bb742-342e-46e3-b1a8-ede32cad03e6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-463bb742-342e-46e3-b1a8-ede32cad03e6" }, { "name": "delete_session", "item": [ { "name": "Delete and reconnect the Session", "id": "1e59ea56-df9c-4cb9-bce0-c2d005c8e346", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "delete_session" ], "variable": [ { "id": "c05e7a98-6bb4-4c16-b3e6-4128a40ae62c", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Deletes and then reconnects the session for the specified SIM.\n\n**Warning**: If you attempt to delete the session for an offline IoT SIM, the following error message will be returned:\n\n```\nError: {\"code\":\"SEM0016\",\"message\":\"The specified subscriber is offline\"}\n```\n" }, "response": [ { "id": "13657e84-f94f-42a0-99d1-48bc7aab2448", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "delete_session" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-13657e84-f94f-42a0-99d1-48bc7aab2448" }, { "id": "702e2ab7-5cbb-456c-9e38-716abb5fd372", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "delete_session" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-702e2ab7-5cbb-456c-9e38-716abb5fd372" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1e59ea56-df9c-4cb9-bce0-c2d005c8e346" } ], "id": "fb0d6e05-11a2-461e-8b0e-da2a8192aaef", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-fb0d6e05-11a2-461e-8b0e-da2a8192aaef" }, { "name": "disable_termination", "item": [ { "name": "Disables termination of the SIM", "id": "02cc8df7-799d-4cc1-aae2-73466bd83662", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "disable_termination" ], "variable": [ { "id": "2765265d-ee53-463b-96cd-23347626b8a4", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Enables termination protection for the specified IoT SIM (disables termination)." }, "response": [ { "id": "70c2ca96-e07c-4fe7-96d9-335f7375ade8", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "disable_termination" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-70c2ca96-e07c-4fe7-96d9-335f7375ade8" }, { "id": "a2a9c1a4-b0da-4552-8251-e83a59d9fa60", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "disable_termination" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a2a9c1a4-b0da-4552-8251-e83a59d9fa60" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-02cc8df7-799d-4cc1-aae2-73466bd83662" } ], "id": "b84ceb0f-cc23-4999-8df2-21a79027dc9f", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-b84ceb0f-cc23-4999-8df2-21a79027dc9f" }, { "name": "downlink", "item": [ { "name": "http", "item": [ { "name": "Send an HTTP request to a device using an IoT SIM", "id": "80ae53a0-1719-4b3c-a7e2-97dd36671629", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"headers\": {\n \"eu__\": \"\"\n },\n \"host\": \"\",\n \"method\": \"GET\",\n \"path\": \"\",\n \"port\": 80,\n \"skipVerify\": false,\n \"ssl\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/http", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "http" ], "variable": [ { "id": "08837967-4b2e-4207-8daa-00e6cbf1ae83", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Sends an HTTP request to a device using an IoT SIM and returns the HTTP response from the device in the API response body.\n" }, "response": [ { "id": "9d4fa906-1d99-457c-82dc-d4720b21bb5d", "name": "The HTTP request to the device was successful. The HTTP status code, headers, and body returned by the device can be checked in the response body.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"headers\": {\n \"eu__\": \"\"\n },\n \"host\": \"\",\n \"method\": \"GET\",\n \"path\": \"\",\n \"port\": 80,\n \"skipVerify\": false,\n \"ssl\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/http", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "http" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"body\": \"\",\n \"headers\": {\n \"deseruntb\": \"\",\n \"labore_9\": \"\"\n },\n \"isBase64Encoded\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9d4fa906-1d99-457c-82dc-d4720b21bb5d" }, { "id": "960abbc0-8808-4d46-9114-807352e327eb", "name": "The specified IoT SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"headers\": {\n \"eu__\": \"\"\n },\n \"host\": \"\",\n \"method\": \"GET\",\n \"path\": \"\",\n \"port\": 80,\n \"skipVerify\": false,\n \"ssl\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/http", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "http" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-960abbc0-8808-4d46-9114-807352e327eb" }, { "id": "bbd5b688-c667-4655-b524-cc8866eea8e7", "name": "- The HTTP request to the device failed for one of the following reasons:\n - Could not establish a network connection with the device.\n - The device refused the HTTP connection.\n\n- The HTTP response from the device was not received for one of the follow", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"headers\": {\n \"eu__\": \"\"\n },\n \"host\": \"\",\n \"method\": \"GET\",\n \"path\": \"\",\n \"port\": 80,\n \"skipVerify\": false,\n \"ssl\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/http", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "http" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bbd5b688-c667-4655-b524-cc8866eea8e7" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-80ae53a0-1719-4b3c-a7e2-97dd36671629" } ], "id": "8474f8e1-be59-467f-b370-9fb1474f599b", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-8474f8e1-be59-467f-b370-9fb1474f599b" }, { "name": "ping", "item": [ { "name": "Sends ping requests to a SIM.", "id": "90813125-9a9e-4354-9e35-865e92461113", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"numberOfPingRequests\": 1,\n \"timeoutSeconds\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/ping", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "ping" ], "variable": [ { "id": "740b41b7-e64f-4c56-bf2e-f8a518da7320", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Sends ICMP ping requests to a SIM." }, "response": [ { "id": "6cc7185d-aa34-4ae4-8d92-446d0e14f7dd", "name": "Result of the ping", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"numberOfPingRequests\": 1,\n \"timeoutSeconds\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/ping", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "ping" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"rtt\": \"\",\n \"stat\": \"\",\n \"success\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6cc7185d-aa34-4ae4-8d92-446d0e14f7dd" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-90813125-9a9e-4354-9e35-865e92461113" } ], "id": "51f4da75-30ae-4cf5-ac31-50bfd87142fe", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-51f4da75-30ae-4cf5-ac31-50bfd87142fe" }, { "name": "rtsp", "item": [ { "name": "Send a command to a RTSP stream to a device using an IoT SIM", "id": "bc5f4457-1f8d-43da-a36e-ece3f1dae9fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "image/jpeg" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "id": "2e753cad-340a-467d-bf6c-6ab0d4d186c9", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Sends a command to a device using an IoT SIM and returns a response based on specified command and options in request.\n\n- An error occurs if the command does not complete within 10 seconds.\n" }, "response": [ { "id": "981911c2-7665-4604-88dc-3e9066589a51", "name": "Command executed successfully. Response body will differ based on command and options in request.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "image/jpeg" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-981911c2-7665-4604-88dc-3e9066589a51" }, { "id": "13b09690-0aec-405e-8540-8cbb57dbf839", "name": "Invalid request.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-13b09690-0aec-405e-8540-8cbb57dbf839" }, { "id": "fc47bb4c-3812-483e-8597-cee90d8acbb4", "name": "Failed to execute command due to authentication error. Please check the authentication information for Soracom API and RTSP server.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fc47bb4c-3812-483e-8597-cee90d8acbb4" }, { "id": "3015a33c-7906-4465-b086-8dcf4826868f", "name": "The specified IoT SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-3015a33c-7906-4465-b086-8dcf4826868f" }, { "id": "59d7a43c-e984-487a-8df4-8ab1d5427caf", "name": "Failed to execute command because the video stream received by Soracom API from the RTSP server is not H.264 encoded. Please verify that the video stream sent by your RTSP server is H.264 encoded.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"snapshot\",\n \"authentication\": {\n \"type\": \"basic\",\n \"username\": \"\",\n \"password\": \"\",\n \"passwordCredentialsId\": \"\"\n },\n \"options\": {\n \"destinations\": {\n \"harvestFiles\": {\n \"filePath\": \"\"\n }\n }\n },\n \"path\": \"\",\n \"port\": 554\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/rtsp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "rtsp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-59d7a43c-e984-487a-8df4-8ab1d5427caf" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bc5f4457-1f8d-43da-a36e-ece3f1dae9fc" } ], "id": "21f3a6af-a9b1-4738-9931-1d30f103895d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-21f3a6af-a9b1-4738-9931-1d30f103895d" }, { "name": "ssh", "item": [ { "name": "Connect to a device using an IoT SIM via SSH and execute a specified command", "id": "710fc23e-5e5a-4804-9db9-8476c63ffb59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"authentication\": {\n \"password\": \"\",\n \"passwordCredentialsId\": \"\",\n \"type\": \"password\"\n },\n \"command\": \"\",\n \"port\": 22\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/ssh", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "ssh" ], "variable": [ { "id": "bb494e4f-009a-4a1d-b729-1d8f1e24e564", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ] }, "description": "Connects to a device using an IoT SIM via SSH, executes a specified command, and returns the standard output and standard error output in the API response body.\n" }, "response": [ { "id": "8927c4ea-e6b2-4469-ba3f-bc4474d65d5b", "name": "The command was executed successfully. The command's exit code, standard output, and standard error output can be checked in the response body.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"authentication\": {\n \"password\": \"\",\n \"passwordCredentialsId\": \"\",\n \"type\": \"password\"\n },\n \"command\": \"\",\n \"port\": 22\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/ssh", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "ssh" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exitcode\": \"\",\n \"isStderrBase64Encoded\": \"\",\n \"isStdoutBase64Encoded\": \"\",\n \"stderr\": \"\",\n \"stdout\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-8927c4ea-e6b2-4469-ba3f-bc4474d65d5b" }, { "id": "0a544dc4-f971-4da0-8181-1d3e530d74b4", "name": "- The command execution failed for one of the following reasons:\n - Could not establish a network connection with the device.\n - The device refused the SSH connection.\n\n- The response from the device was not received for one of the following reasons:\n ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"authentication\": {\n \"password\": \"\",\n \"passwordCredentialsId\": \"\",\n \"type\": \"password\"\n },\n \"command\": \"\",\n \"port\": 22\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/ssh", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "ssh" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-0a544dc4-f971-4da0-8181-1d3e530d74b4" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-710fc23e-5e5a-4804-9db9-8476c63ffb59" } ], "id": "19683e56-8e81-4736-a3ee-5289ca053577", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-19683e56-8e81-4736-a3ee-5289ca053577" }, { "name": "tcp", "item": [ { "name": "Connect to a device using an IoT SIM via TCP and send/receive data", "id": "9f0da97d-0bb9-4258-9bf2-4ba23c8a7cbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "id": "77a560c4-5dd2-4527-a94c-039f093fe85e", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ] }, "description": "Connects to a device using an IoT SIM via TCP, sends specified data, and returns data received from the device.\n\n- The maximum size of sent and received data is 5 MiB each.\n- If sending and receiving data is not completed within the time specified by `timeout`, an error will occur.\n" }, "response": [ { "id": "1a474309-1f6c-4ccb-99bf-55c96fb02740", "name": "Data transmission and response reception were successful. Check the response body for the response from the device.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": \"\",\n \"dataEncoding\": \"string\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1a474309-1f6c-4ccb-99bf-55c96fb02740" }, { "id": "9521da07-31f4-4876-a65b-614dd483fbb6", "name": "Invalid request.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9521da07-31f4-4876-a65b-614dd483fbb6" }, { "id": "9d2dcf27-fb4c-426c-94cf-78877cce6129", "name": "Authentication failed.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9d2dcf27-fb4c-426c-94cf-78877cce6129" }, { "id": "88a178f2-d37e-4feb-9f83-a471c2b36041", "name": "The specified IoT SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-88a178f2-d37e-4feb-9f83-a471c2b36041" }, { "id": "00620553-1711-41f1-ac21-e370e32277f4", "name": "Data transmission and reception failed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"connectionOptions\": {\n \"type\": \"fire_and_forget\"\n },\n \"payloadEncoding\": \"string\",\n \"timeout\": 30\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/tcp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "tcp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-00620553-1711-41f1-ac21-e370e32277f4" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9f0da97d-0bb9-4258-9bf2-4ba23c8a7cbd" } ], "id": "02e442b0-f9c5-407d-aa9c-d87d7aafe1bb", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-02e442b0-f9c5-407d-aa9c-d87d7aafe1bb" }, { "name": "udp", "item": [ { "name": "Send data using IoT SIM via UDP", "id": "db5233a7-e873-421a-a978-e34bf446cd90", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"payloadEncoding\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/udp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "udp" ], "variable": [ { "id": "55a0e4fd-1090-4ed7-984b-736ac291084d", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ] }, "description": "Sends specified data to a device using an IoT SIM via UDP.\n\n**Warning**: Unlike TCP, UDP communication lacks retransmission and sequencing mechanisms, which may lead to packet loss or out-of-order arrival.\n" }, "response": [ { "id": "f125ae6e-acc6-417e-b4ff-08c452ef446f", "name": "The data has been sent to the device.\nHowever, due to the nature of UDP, packet delivery is not guaranteed.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"payloadEncoding\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/udp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "udp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f125ae6e-acc6-417e-b4ff-08c452ef446f" }, { "id": "45976b71-345c-4cfc-a499-959f66a933a7", "name": "Invalid request.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"payloadEncoding\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/udp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "udp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-45976b71-345c-4cfc-a499-959f66a933a7" }, { "id": "fd3d6102-24f6-4cb3-8ada-fff98af96455", "name": "Authentication failed.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"payloadEncoding\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/udp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "udp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fd3d6102-24f6-4cb3-8ada-fff98af96455" }, { "id": "4f0f13e9-9e5d-49bc-a600-4aa724cd8c84", "name": "The specified IoT SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"port\": \"\",\n \"payload\": \"\",\n \"payloadEncoding\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/downlink/udp", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "downlink", "udp" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4f0f13e9-9e5d-49bc-a600-4aa724cd8c84" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-db5233a7-e873-421a-a978-e34bf446cd90" } ], "id": "988e4c77-801a-47f3-a16b-ec82c16d30b4", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-988e4c77-801a-47f3-a16b-ec82c16d30b4" } ], "id": "01acb16c-24fe-4de2-a453-0bbad57b4b54", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-01acb16c-24fe-4de2-a453-0bbad57b4b54" }, { "name": "enable_termination", "item": [ { "name": "Enables termination of the SIM.", "id": "bca71147-3c42-466b-b796-f279a3bf8a86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "enable_termination" ], "variable": [ { "id": "a6a17a93-74fd-4b44-a58e-78ecfbe5d4ba", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Disables termination protection for the specified IoT SIM (enables termination)." }, "response": [ { "id": "dd671253-a72a-4958-9ec2-9909c7ebdd5f", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "enable_termination" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-dd671253-a72a-4958-9ec2-9909c7ebdd5f" }, { "id": "1f479750-6f6c-49d8-8d7d-6b9d07135079", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "enable_termination" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1f479750-6f6c-49d8-8d7d-6b9d07135079" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bca71147-3c42-466b-b796-f279a3bf8a86" } ], "id": "2d0a3af1-aee9-436d-88ff-f19e613a3af8", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-2d0a3af1-aee9-436d-88ff-f19e613a3af8" }, { "name": "events", "item": [ { "name": "sessions", "item": [ { "name": "Retrieves session event history (session history)", "id": "4aa954ab-221e-4e70-a6c9-82a14e890940", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/events/sessions?from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "events", "sessions" ], "query": [ { "description": "Start time (UNIX time in milliseconds) of the period to retrieve the session event history.", "key": "from", "value": "" }, { "description": "End time (UNIX time in milliseconds) of the period to retrieve the session event history.", "key": "to", "value": "" }, { "description": "Maximum number of event histories to retrieve. However, the number of event histories returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "09e4c54c-7a8b-427d-8ced-c4cabbdb212b", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Retrieves event history of session creation/modification/disconnection for the past 32 days for the specified SIM. If the total number of events does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n\nCheck the current session using the [Sim:getSim API](#!/Sim/getSim). To check the current session with this API, check the value of `event` in the latest session history. Refer to [Subscriber Status](/en/docs/air/subscriber-status/) for the meaning of a session.\n" }, "response": [ { "id": "be3f0f44-0060-41ff-84e5-5815c21af672", "name": "A list of session events.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/events/sessions?from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "events", "sessions" ], "query": [ { "description": "Start time (UNIX time in milliseconds) of the period to retrieve the session event history.", "key": "from", "value": "" }, { "description": "End time (UNIX time in milliseconds) of the period to retrieve the session event history.", "key": "to", "value": "" }, { "description": "Maximum number of event histories to retrieve. However, the number of event histories returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apn\": \"\",\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"dns0\": \"\",\n \"dns1\": \"\",\n \"event\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"sessionId\": \"\",\n \"simId\": \"\",\n \"subscription\": \"\",\n \"time\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n {\n \"apn\": \"\",\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"dns0\": \"\",\n \"dns1\": \"\",\n \"event\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"sessionId\": \"\",\n \"simId\": \"\",\n \"subscription\": \"\",\n \"time\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-be3f0f44-0060-41ff-84e5-5815c21af672" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4aa954ab-221e-4e70-a6c9-82a14e890940" } ], "id": "b0bd5013-f44f-4985-8c77-8ff06521f357", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-b0bd5013-f44f-4985-8c77-8ff06521f357" } ], "id": "5a76c64c-8ff6-4505-9f87-7b8ef8322766", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5a76c64c-8ff6-4505-9f87-7b8ef8322766" }, { "name": "packet_capture_sessions", "item": [ { "name": "{session_id}", "item": [ { "name": "stop", "item": [ { "name": "Stops a packet capture session associated with the SIM", "id": "23dc7d5f-6781-43e7-b4c9-8cdde5d2e20f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "id": "d93f1a16-318d-4622-8e75-cce448db205e", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "ebaba536-2569-4ddc-93f7-6efc2c3c9832", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Stops a packet capture session associated with the SIM." }, "response": [ { "id": "ab270268-4ceb-409a-8faa-c06628b874df", "name": "The stopped packet capture session", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"POST_PROCESSING\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ab270268-4ceb-409a-8faa-c06628b874df" }, { "id": "e558c632-4e9a-4356-90c5-1ff45a1b5405", "name": "The packet capture session can be stopped only when its status is CAPTURING", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e558c632-4e9a-4356-90c5-1ff45a1b5405" }, { "id": "a9e6ae09-9e4e-4249-932e-a6ce5e81cc79", "name": "The packet capture session associated with the SIM was not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a9e6ae09-9e4e-4249-932e-a6ce5e81cc79" }, { "id": "a5f74166-f865-4760-8ae9-73a798f3bced", "name": "The packet capture session could not be stopped", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a5f74166-f865-4760-8ae9-73a798f3bced" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-23dc7d5f-6781-43e7-b4c9-8cdde5d2e20f" } ], "id": "758fadf2-4987-4240-9d2f-14a6a2c32b4b", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-758fadf2-4987-4240-9d2f-14a6a2c32b4b" }, { "name": "Deletes a packet capture session associated with the SIM", "id": "c1421b38-f86c-42d6-8ffc-26f4577e4a75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "id": "385e5673-735f-48bb-b524-c27ab6a3f18b", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "fc38ff17-9e9f-46f6-9abd-7560e9ff285d", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Deletes a packet capture session associated with the SIM." }, "response": [ { "id": "6eec93ea-77d8-4009-94b9-34eb0f59349b", "name": "Deleted the packet capture session", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"POST_PROCESSING\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6eec93ea-77d8-4009-94b9-34eb0f59349b" }, { "id": "37c12446-991d-4fb8-bf37-691592c382ae", "name": "Failed to delete the packet capture session associated with the SIM", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-37c12446-991d-4fb8-bf37-691592c382ae" }, { "id": "98325bba-2664-4475-80b6-850eb5cc7679", "name": "The packet capture session associated with the SIM was not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-98325bba-2664-4475-80b6-850eb5cc7679" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c1421b38-f86c-42d6-8ffc-26f4577e4a75" }, { "name": "Gets a packet capture session associated with the SIM", "id": "852a8bc4-a0c2-43c2-b9f8-f756a5403fb7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "id": "5347796c-8fc2-42ef-9577-70121233e551", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "c77b5d64-1a5e-4a11-9dfa-5edf3e42acad", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Gets a packet capture session associated with the SIM." }, "response": [ { "id": "c1b8d545-5238-4b0a-beb6-0b2df0cf2323", "name": "The packet capture session associated with the SIM", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"POST_PROCESSING\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c1b8d545-5238-4b0a-beb6-0b2df0cf2323" }, { "id": "2d66768b-524d-4066-a0b1-65121fba9eba", "name": "The packet capture session associated with the SIM was not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "sim_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-2d66768b-524d-4066-a0b1-65121fba9eba" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-852a8bc4-a0c2-43c2-b9f8-f756a5403fb7" } ], "id": "af89ecca-540d-46a6-8c3b-b76e3f20c27f", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-af89ecca-540d-46a6-8c3b-b76e3f20c27f" }, { "name": "Lists packet capture sessions associated with the SIM", "id": "c5df0681-f0f1-44c7-b0bc-2800fef570ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions?last_evaluated_key=&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "query": [ { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "id": "dd740107-a83d-4afc-9631-6ce43d65eba5", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Lists packet capture sessions associated with the SIM." }, "response": [ { "id": "e5382990-b53c-41dc-88ad-aba653beb2d1", "name": "List of packet capture sessions associated with the SIM", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions?last_evaluated_key=&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "query": [ { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"CAPTURING\",\n \"url\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"ACCEPTED\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e5382990-b53c-41dc-88ad-aba653beb2d1" }, { "id": "b378a2ba-90c3-4ef0-91c6-18d9517b7a54", "name": "No such SIM found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions?last_evaluated_key=&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "query": [ { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b378a2ba-90c3-4ef0-91c6-18d9517b7a54" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c5df0681-f0f1-44c7-b0bc-2800fef570ac" }, { "name": "Creates a packet capture session associated with the SIM", "id": "5e4070af-2147-4ad4-b5bc-82ce3d546eee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"duration\": \"\",\n \"prefix\": \"gqvMx8HoB381M2YNbVb7Cbe40oRYIaZ5JhMeWtcooUS9w1QRZW-aUroDbx0RdLh-plzON1ansv4jkF4l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "variable": [ { "id": "d642e112-b4ca-425a-aa47-f2e59b1242f0", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Creates a packet capture session associated with the SIM." }, "response": [ { "id": "429847af-fb07-42a3-8357-bc913bb8309e", "name": "The packet capture session associated with the SIM", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"duration\": \"\",\n \"prefix\": \"gqvMx8HoB381M2YNbVb7Cbe40oRYIaZ5JhMeWtcooUS9w1QRZW-aUroDbx0RdLh-plzON1ansv4jkF4l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"POST_PROCESSING\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-429847af-fb07-42a3-8357-bc913bb8309e" }, { "id": "02a4ad37-41e5-4398-8f8d-9ace5c38f558", "name": "Failed to create a packet capture session for the specified SIM", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"duration\": \"\",\n \"prefix\": \"gqvMx8HoB381M2YNbVb7Cbe40oRYIaZ5JhMeWtcooUS9w1QRZW-aUroDbx0RdLh-plzON1ansv4jkF4l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-02a4ad37-41e5-4398-8f8d-9ace5c38f558" }, { "id": "a88f73e3-ad04-4812-9c94-919b88cf93df", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"duration\": \"\",\n \"prefix\": \"gqvMx8HoB381M2YNbVb7Cbe40oRYIaZ5JhMeWtcooUS9w1QRZW-aUroDbx0RdLh-plzON1ansv4jkF4l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "packet_capture_sessions" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a88f73e3-ad04-4812-9c94-919b88cf93df" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5e4070af-2147-4ad4-b5bc-82ce3d546eee" } ], "id": "302b1efb-e937-4528-9504-1f7db12685ad", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-302b1efb-e937-4528-9504-1f7db12685ad" }, { "name": "profiles", "item": [ { "name": "{iccid}", "item": [ { "name": "add_subscription", "item": [ { "name": "Adds a new secondary subscription to an IoT SIM", "id": "6760e4c8-fe77-4d4f-9619-66172b0c6fcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"planX1\",\n \"enable\": \"\",\n \"type\": \"virtual\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/add_subscription", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "add_subscription" ], "variable": [ { "id": "7fd10295-2092-4615-9901-5eb06609720b", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "454ca24d-9090-4761-be83-a83ed2551244", "key": "iccid", "value": "", "description": "(Required) ICCID of the target IoT SIM. For IoT SIMs that do not support eUICC, the ICCID and SIM ID are the same." } ] }, "description": "Add a new secondary subscription ([additional subscription](/en/docs/air/subscription-containers/#adding-a-subscription) or [virtual SIM/Subscriber](/en/docs/arc/configuration/#adding-a-virtual-sim-to-an-air-sim)) to the IoT SIM." }, "response": [ { "id": "b6f648af-38f2-4ff5-92b0-b98a8c8f555e", "name": "The updated SIM profile", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"planX1\",\n \"enable\": \"\",\n \"type\": \"virtual\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/add_subscription", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "add_subscription" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non7\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b6f648af-38f2-4ff5-92b0-b98a8c8f555e" }, { "id": "c89c6922-69e9-4eb1-b0ff-37e20a829796", "name": "You specified a subscription that cannot be added. For example, `planP1` cannot be added to an IoT SIM in plan-D.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"planX1\",\n \"enable\": \"\",\n \"type\": \"virtual\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/add_subscription", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "add_subscription" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c89c6922-69e9-4eb1-b0ff-37e20a829796" }, { "id": "46fb2728-30f1-4a96-9592-ea5e30b27adc", "name": "No such IoT SIM with the specified SIM ID and ICCID found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"planX1\",\n \"enable\": \"\",\n \"type\": \"virtual\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/add_subscription", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "add_subscription" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-46fb2728-30f1-4a96-9592-ea5e30b27adc" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6760e4c8-fe77-4d4f-9619-66172b0c6fcf" } ], "id": "4776c97f-f79d-4419-bff8-f2298b232743", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-4776c97f-f79d-4419-bff8-f2298b232743" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "cancel_download", "item": [ { "name": "Cancel the OTA to the subscription container for an additional subscription", "id": "46bbf3be-1f97-4c1c-adbc-a68b629ccf43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/subscribers/:imsi/cancel_download", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "subscribers", ":imsi", "cancel_download" ], "variable": [ { "id": "9ac6053c-7c4b-4898-929b-9edb64603ac0", "key": "sim_id", "value": "", "description": "(Required) The SIM ID of the target SIM." }, { "id": "77e70c36-a3db-4e39-b5c2-ef34111bfd0d", "key": "iccid", "value": "", "description": "(Required) The ICCID of the target subscription container." }, { "id": "4218316e-bcd4-4576-a813-5fcf21e3dde1", "key": "imsi", "value": "", "description": "(Required) The IMSI of the target additional subscription." } ] }, "description": "Cancel the OTA of the additional subscription before the OTA starts. Note that once the IoT SIM goes online and the OTA begins, it cannot be canceled." }, "response": [ { "id": "c3570db0-43ff-47f7-99c0-5723aa29ca4d", "name": "A schema listing subscription containers and containing a map of PLMN codes to subscription containers.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/subscribers/:imsi/cancel_download", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "subscribers", ":imsi", "cancel_download" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" }, { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"containers\": [\n {\n \"containerId\": \"\",\n \"downloaded\": \"\",\n \"subscriber\": {\n \"laboreb\": {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"suspend\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"micro\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"GSM\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\",\n \"tags\": {\n \"occaecat9cc\": \"\",\n \"ea_8f\": \"\",\n \"enim_93\": \"\",\n \"pariatur_4d8\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\n \"do_730\": {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"suspend\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"trio\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"GSM\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\",\n \"tags\": {\n \"dolor_e\": \"\",\n \"amet_4\": \"\",\n \"non_f72\": \"\",\n \"qui_0\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n }\n },\n {\n \"containerId\": \"\",\n \"downloaded\": \"\",\n \"subscriber\": {\n \"tempor2f\": {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"terminate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"micro\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-southeast-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\",\n \"tags\": {\n \"proident_8\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\n \"do7\": {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deleteSession\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"mini\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\",\n \"tags\": {\n \"Ute\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n }\n }\n ],\n \"countryMapping\": {\n \"ut536\": {\n \"mappingRecord\": {\n \"containerId\": \"\",\n \"subscription\": \"\"\n },\n \"plmnCode\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c3570db0-43ff-47f7-99c0-5723aa29ca4d" }, { "id": "a92aa00a-686a-491d-9baa-2913f12846d2", "name": "The specified SIM ID, ICCID, or IMSI does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/subscribers/:imsi/cancel_download", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "subscribers", ":imsi", "cancel_download" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" }, { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a92aa00a-686a-491d-9baa-2913f12846d2" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-46bbf3be-1f97-4c1c-adbc-a68b629ccf43" } ], "id": "fe76f675-3af8-4039-97ee-778366fcfb7a", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-fe76f675-3af8-4039-97ee-778366fcfb7a" }, { "name": "terminate", "item": [ { "name": "Terminates subscription container", "id": "b314d57e-0059-4f82-a9d7-79385c07ce86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/subscribers/:imsi/terminate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "subscribers", ":imsi", "terminate" ], "variable": [ { "id": "3b614624-ac2b-437d-9a7d-ffde569feee1", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target subscription container." }, { "id": "0add2963-3ed1-42b9-afa0-ce44b74ad436", "key": "iccid", "value": "", "description": "(Required) ICCID of the target subscription container." }, { "id": "b6707745-a084-4d04-b46e-a79f10bf1766", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscription container." } ] }, "description": "Terminates subscription container. Currently this API supports only for virtual SIM/Subscribers for Soracom Arc." }, "response": [ { "id": "909fd529-3fbd-45c8-a292-e9186200d042", "name": "The subscription container has been terminated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/profiles/:iccid/subscribers/:imsi/terminate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "profiles", ":iccid", "subscribers", ":imsi", "terminate" ], "variable": [ { "key": "sim_id" }, { "key": "iccid" }, { "key": "imsi" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-909fd529-3fbd-45c8-a292-e9186200d042" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b314d57e-0059-4f82-a9d7-79385c07ce86" } ], "id": "62a378b6-c2aa-4caa-858d-7a15dd4d896b", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-62a378b6-c2aa-4caa-858d-7a15dd4d896b" } ], "id": "91cafaeb-9a72-4997-bb5d-f7ae984db2b6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-91cafaeb-9a72-4997-bb5d-f7ae984db2b6" } ], "id": "27f06a19-677d-467e-9b82-08df5f4615a9", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-27f06a19-677d-467e-9b82-08df5f4615a9" } ], "id": "cc37712b-8b1c-41ef-af00-d7d1740e46c1", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-cc37712b-8b1c-41ef-af00-d7d1740e46c1" } ], "id": "e7af6b4e-9a55-4b16-a5db-21d351c75211", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e7af6b4e-9a55-4b16-a5db-21d351c75211" }, { "name": "register", "item": [ { "name": "Registers an IoT SIM to an operator", "id": "0314e545-06bb-468f-9473-1609bbe9a18b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registrationSecret\": \"\",\n \"groupId\": \"\",\n \"tags\": {\n \"nisi4\": \"\",\n \"non70e\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "register" ], "variable": [ { "id": "1cf142b8-30c2-4775-b732-0c92f439d6a6", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Registers an IoT SIM to an operator." }, "response": [ { "id": "1c55822b-27c7-4a3c-acea-e2b29468b32d", "name": "SIM registration completed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"registrationSecret\": \"\",\n \"groupId\": \"\",\n \"tags\": {\n \"nisi4\": \"\",\n \"non70e\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "register" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1c55822b-27c7-4a3c-acea-e2b29468b32d" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-0314e545-06bb-468f-9473-1609bbe9a18b" } ], "id": "88555405-88ae-4046-b00e-2aa01e89492f", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-88555405-88ae-4046-b00e-2aa01e89492f" }, { "name": "report_local_info", "item": [ { "name": "Gets SIM local information report", "id": "4779f6cd-f8da-4584-bf2c-a6819938db7f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "report_local_info" ], "variable": [ { "id": "2685e8fc-6893-4486-a761-6159f016ba8a", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Gets SIM local information report.\n\n**Alert**: One SMS will be sent to the IoT device per request for SIM local information report. Sending SMS to IoT devices is charged. For more information on fees, refer to the following page\n- [Pricing & Fee Schedule](/en/docs/reference/fees/)\n" }, "response": [ { "id": "2117665e-a88b-475e-9e1e-bfd16ff677c0", "name": "Successful request to update SIM local information report. SIM local information reports are updated asynchronously upon successful reporting from the IoT SIM. Asynchronously updated information can be viewed in the Soracom User Console. For details, see ", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "report_local_info" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-2117665e-a88b-475e-9e1e-bfd16ff677c0" }, { "id": "31af9c10-e4aa-4f94-a8f2-1a59211397d3", "name": "The specified IoT SIM does not support the SIM local information reporting feature.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "report_local_info" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-31af9c10-e4aa-4f94-a8f2-1a59211397d3" }, { "id": "c73d8ab9-3099-4bb3-b92d-9cbc77581b09", "name": "The specified IoT SIM does not exist for the specified coverage type.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "report_local_info" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c73d8ab9-3099-4bb3-b92d-9cbc77581b09" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4779f6cd-f8da-4584-bf2c-a6819938db7f" } ], "id": "dda611c5-f90b-4e3f-b69c-e7b176ce6f79", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-dda611c5-f90b-4e3f-b69c-e7b176ce6f79" }, { "name": "send_sms", "item": [ { "name": "Send an SMS to an IoT SIM", "id": "f01b3bad-3206-4b26-84c9-0529fae13ee0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "send_sms" ], "variable": [ { "id": "25aebbfc-36f7-4b1f-b4e8-5e0bc4aab5ed", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM to which the SMS will be sent. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Sends an SMS to the specified IoT SIM." }, "response": [ { "id": "63b9ea27-f9f0-4409-a236-ab1cd0bbe158", "name": "SMS transmission accepted and completed. Returns the ID assigned to the message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "send_sms" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"messageId\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-63b9ea27-f9f0-4409-a236-ab1cd0bbe158" }, { "id": "530cfbef-3a11-4509-9185-364c8862cfbd", "name": "The specified SIM does not support SMS API.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "send_sms" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-530cfbef-3a11-4509-9185-364c8862cfbd" }, { "id": "025246c5-cb6e-473f-8c79-531c9faf871e", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "send_sms" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-025246c5-cb6e-473f-8c79-531c9faf871e" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f01b3bad-3206-4b26-84c9-0529fae13ee0" } ], "id": "f20878ef-e85f-4384-9359-6fceea5cbfbc", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-f20878ef-e85f-4384-9359-6fceea5cbfbc" }, { "name": "sessions", "item": [ { "name": "arc", "item": [ { "name": "Creates a Soracom Arc session", "id": "a7b91109-a839-4245-a371-c57ba966c2ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/sessions/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "sessions", "arc" ], "variable": [ { "id": "0e1f1157-c122-474f-9497-7278b48e6343", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Creates a Soracom Arc session. If the session already exists, re-create it." }, "response": [ { "id": "d044a419-8159-4f9f-b059-05f886807060", "name": "Arc session created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/sessions/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "sessions", "arc" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d044a419-8159-4f9f-b059-05f886807060" }, { "id": "dc3ad88e-a6b1-4a85-b4a9-b5ba00271e91", "name": "Arc credentials missing", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/sessions/arc", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "sessions", "arc" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-dc3ad88e-a6b1-4a85-b4a9-b5ba00271e91" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a7b91109-a839-4245-a371-c57ba966c2ae" } ], "id": "28bc6012-8fd6-4c6e-b885-a647028d8616", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-28bc6012-8fd6-4c6e-b885-a647028d8616" } ], "id": "5d6d7658-6b35-435a-b5a1-dca6e1ece3b5", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5d6d7658-6b35-435a-b5a1-dca6e1ece3b5" }, { "name": "set_expiry_time", "item": [ { "name": "Sets expiry time of IoT SIM", "id": "a81b44d7-522b-4a77-9d3c-2757e0f9130e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_expiry_time" ], "variable": [ { "id": "2f67b47f-9e7f-45dd-abd7-6e11a5912152", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Sets the expiration date and action for the specified IoT SIM." }, "response": [ { "id": "84ba64a5-b58e-4492-bc64-9be49825ea2d", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_expiry_time" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-84ba64a5-b58e-4492-bc64-9be49825ea2d" }, { "id": "fc59f725-877b-4f04-9888-85ba8eb7e62d", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_expiry_time" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fc59f725-877b-4f04-9888-85ba8eb7e62d" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a81b44d7-522b-4a77-9d3c-2757e0f9130e" } ], "id": "5ea6495b-0c76-434a-894b-de80f17d5385", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5ea6495b-0c76-434a-894b-de80f17d5385" }, { "name": "set_group", "item": [ { "name": "Adds a SIM to a SIM group", "id": "f0717243-f491-402e-a684-ef5310e453c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_group" ], "variable": [ { "id": "a67e9a21-1081-4d1e-8ebb-c782df26b578", "key": "sim_id", "value": "", "description": "(Required) ID of the target SIM. The SIM ID can be obtained using the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Adds a SIM to a SIM group." }, "response": [ { "id": "6769d0bc-6c4f-4923-b364-3d58f93d4b80", "name": "Detailed information of the updated SIM.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_group" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6769d0bc-6c4f-4923-b364-3d58f93d4b80" }, { "id": "7a066a9f-7842-4301-971b-9a349c44c3a3", "name": "The specified SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_group" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7a066a9f-7842-4301-971b-9a349c44c3a3" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f0717243-f491-402e-a684-ef5310e453c2" } ], "id": "70d307e4-2312-4b92-b15d-b425fe7d4ce6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-70d307e4-2312-4b92-b15d-b425fe7d4ce6" }, { "name": "set_imei_lock", "item": [ { "name": "Sets IMEI lock configuration for the SIM", "id": "62642492-6a27-4f1d-9cad-3010bea82da5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_imei_lock" ], "variable": [ { "id": "4cf4de24-0f54-4ba6-b310-9889e38d9be9", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Sets IMEI that the SIM should be locked to." }, "response": [ { "id": "3c2d7b72-c669-4f4c-b2f2-fa56deaa8f0a", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_imei_lock" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-3c2d7b72-c669-4f4c-b2f2-fa56deaa8f0a" }, { "id": "16f555b0-ae6b-4e30-849e-505c099a3cf3", "name": "- The IMEI string is invalid.\n- The IMEI is not specified even though the SIM is offline.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_imei_lock" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-16f555b0-ae6b-4e30-849e-505c099a3cf3" }, { "id": "a8880c55-99c7-4400-abd3-86ec088d0699", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_imei_lock" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a8880c55-99c7-4400-abd3-86ec088d0699" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-62642492-6a27-4f1d-9cad-3010bea82da5" } ], "id": "5c005016-81b7-41a0-a5d8-90b50423d2fe", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5c005016-81b7-41a0-a5d8-90b50423d2fe" }, { "name": "set_to_standby", "item": [ { "name": "Set SIM to standby mode.", "id": "103c8bf7-5d70-4605-8c0f-b4893eaf91ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_to_standby" ], "variable": [ { "id": "b04de75c-9079-4459-9ab8-acc921f23ee0", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Changes status of specified SIM to \"standby\"." }, "response": [ { "id": "af5dd209-2294-40f2-94bb-31e109bfe2f0", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_to_standby" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-af5dd209-2294-40f2-94bb-31e109bfe2f0" }, { "id": "acb2c8ff-7a66-4616-a731-62052c7ef425", "name": "The specified SIM does not support \"standby.\"", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_to_standby" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-acb2c8ff-7a66-4616-a731-62052c7ef425" }, { "id": "966e34fa-4315-4e39-a8c8-dec90be30bf5", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "set_to_standby" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-966e34fa-4315-4e39-a8c8-dec90be30bf5" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-103c8bf7-5d70-4605-8c0f-b4893eaf91ab" } ], "id": "d02c6225-1ad7-4104-a47d-d4620f60a898", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d02c6225-1ad7-4104-a47d-d4620f60a898" }, { "name": "statuses", "item": [ { "name": "history", "item": [ { "name": "List IoT SIM status operation history", "id": "5e321144-497f-4560-9632-6695af2ab56b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/statuses/history?from=&to=&last_evaluated_key=&sort=desc&limit=30", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "statuses", "history" ], "query": [ { "description": "Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `from` is set to the oldest status operation history entry time of the target IoT SIM.", "key": "from", "value": "" }, { "description": "End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit.", "key": "limit", "value": "30" } ], "variable": [ { "id": "4c29fbc8-54c5-48f2-a4c3-829ffeb5a3c2", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "List IoT SIM status operation history. Status operation history entry records what status operations were performed for which IMSI and which subscriptions, along with the operation time. It includes speed class, group ID, IoT SIM status, etc. If the total number of status operation history entry does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response." }, "response": [ { "id": "86a344fd-4926-4930-8383-dbded1e74bff", "name": "A list of status operation history entry of the IoT SIM.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/statuses/history?from=&to=&last_evaluated_key=&sort=desc&limit=30", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "statuses", "history" ], "query": [ { "description": "Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `from` is set to the oldest status operation history entry time of the target IoT SIM.", "key": "from", "value": "" }, { "description": "End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit.", "key": "limit", "value": "30" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"applyDateTimeEpochSec\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"groupId\": \"\",\n \"imsi\": \"\",\n \"isPrimary\": \"\",\n \"primaryImsi\": \"\",\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"\",\n \"subscription\": \"\"\n },\n {\n \"applyDateTimeEpochSec\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"groupId\": \"\",\n \"imsi\": \"\",\n \"isPrimary\": \"\",\n \"primaryImsi\": \"\",\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"\",\n \"subscription\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-86a344fd-4926-4930-8383-dbded1e74bff" }, { "id": "99a40bd5-2d9b-42ff-8cea-ae362493837b", "name": "Bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/statuses/history?from=&to=&last_evaluated_key=&sort=desc&limit=30", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "statuses", "history" ], "query": [ { "description": "Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `from` is set to the oldest status operation history entry time of the target IoT SIM.", "key": "from", "value": "" }, { "description": "End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit.", "key": "limit", "value": "30" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-99a40bd5-2d9b-42ff-8cea-ae362493837b" }, { "id": "bfa64086-2664-4397-95e0-614f98c8504c", "name": "No such SIM found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/statuses/history?from=&to=&last_evaluated_key=&sort=desc&limit=30", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "statuses", "history" ], "query": [ { "description": "Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `from` is set to the oldest status operation history entry time of the target IoT SIM.", "key": "from", "value": "" }, { "description": "End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" }, { "description": "Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit.", "key": "limit", "value": "30" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bfa64086-2664-4397-95e0-614f98c8504c" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5e321144-497f-4560-9632-6695af2ab56b" } ], "id": "4a5e14e1-1884-402c-8c35-7db391214e5d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-4a5e14e1-1884-402c-8c35-7db391214e5d" } ], "id": "e266cd4d-1d69-44de-97fe-6afc8ebcc6ef", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e266cd4d-1d69-44de-97fe-6afc8ebcc6ef" }, { "name": "suspend", "item": [ { "name": "Suspend SIM", "id": "4c3156a3-164d-4b4e-bf94-d56b9a84d6c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/suspend", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "suspend" ], "variable": [ { "id": "3c60aa84-c940-4ac3-b44b-a45d62f75570", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Changes status of specified SIM to \"suspended\"." }, "response": [ { "id": "448b6482-04b1-4865-b736-97b2b0a77615", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/suspend", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "suspend" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-448b6482-04b1-4865-b736-97b2b0a77615" }, { "id": "7c6848e4-3b7b-4388-9a4f-e19afb6ed3dc", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/suspend", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "suspend" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7c6848e4-3b7b-4388-9a4f-e19afb6ed3dc" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4c3156a3-164d-4b4e-bf94-d56b9a84d6c7" } ], "id": "40d67477-ab4e-4407-93b3-8d9088534e30", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-40d67477-ab4e-4407-93b3-8d9088534e30" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Deletes a tag from the specified SIM", "id": "55f05226-7412-49bc-a332-9305dfb48fb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags", ":tag_name" ], "variable": [ { "id": "4c881a26-dc02-490e-82d6-1342af03324d", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." }, { "id": "fbdb1052-8ac6-4b0c-8600-fa0fbbd0db42", "key": "tag_name", "value": "", "description": "(Required) Tag name to be deleted. This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().\n\n**Warning**: If you are using Soracom CLI, do not use URL encoding (percent-encoding).\n" } ] }, "description": "Deletes a tag from the specified IoT SIM." }, "response": [ { "id": "1a0758d8-086a-41a6-b91c-62c9e8e38efe", "name": "Deletion of specified tag complete.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags", ":tag_name" ], "variable": [ { "key": "sim_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1a0758d8-086a-41a6-b91c-62c9e8e38efe" }, { "id": "ff4c89ea-a597-45f9-b256-187a21524a40", "name": "The specified SIM or tag does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags", ":tag_name" ], "variable": [ { "key": "sim_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ff4c89ea-a597-45f9-b256-187a21524a40" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-55f05226-7412-49bc-a332-9305dfb48fb0" } ], "id": "93937126-ffcb-4d32-8819-cd173a3dbee6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-93937126-ffcb-4d32-8819-cd173a3dbee6" }, { "name": "Bulk Add or Update tags for an IoT SIM", "id": "13a957b4-eeb2-4f4a-b90e-2543e94bec7e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags" ], "variable": [ { "id": "2f8cc42d-9ac0-4370-a589-1d0641739c8f", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Adds or updates tags for the specified IoT SIM.\n\nThe name of the IoT SIM is registered as a tag with the key `name`.\n" }, "response": [ { "id": "7cc03eec-0874-4a5f-9538-43a52ce005bd", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7cc03eec-0874-4a5f-9538-43a52ce005bd" }, { "id": "9a213dcf-e1ee-4317-a2d4-3af23055cf07", "name": "No such SIM found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "tags" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9a213dcf-e1ee-4317-a2d4-3af23055cf07" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-13a957b4-eeb2-4f4a-b90e-2543e94bec7e" } ], "id": "cf775bbd-4fd3-4134-91a0-603af96114e7", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-cf775bbd-4fd3-4134-91a0-603af96114e7" }, { "name": "terminate", "item": [ { "name": "Terminate an IoT SIM", "id": "fb06b3de-73c7-473f-bc2f-cae46b4e3b09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "terminate" ], "variable": [ { "id": "bff6f845-42f1-4925-a24a-5e1e15a5afb3", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Terminates the specified IoT SIM. Please use the [Sim:enableSimTermination API](#!/Sim/enableSimTermination) in advance to enable termination (remove termination protection).\n" }, "response": [ { "id": "e3ecbe7d-a182-432b-a613-edfc6a972d39", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "terminate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e3ecbe7d-a182-432b-a613-edfc6a972d39" }, { "id": "e8d97d74-03fd-4a49-bef3-c8885e9e246b", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "terminate" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e8d97d74-03fd-4a49-bef3-c8885e9e246b" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fb06b3de-73c7-473f-bc2f-cae46b4e3b09" } ], "id": "b766b2ae-0d09-4f67-a72c-58be2acd535a", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-b766b2ae-0d09-4f67-a72c-58be2acd535a" }, { "name": "testing", "item": [ { "name": "usage", "item": [ { "name": "Get usage of IoT SIM in testing status", "id": "57fab2ed-7e5a-4612-ab9d-5144682de234", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/testing/usage", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "testing", "usage" ], "variable": [ { "id": "74a9ff5d-dbd6-44ca-8961-a6cd5eccab6b", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM." } ] }, "description": "Retrieves the usage information of \"testing\" status of the IoT SIM. Data can only be retrieved while the IoT SIM is in \"testing\" status." }, "response": [ { "id": "857b9966-2445-4a28-9676-b3346b1eb290", "name": "Usage information of the IoT SIM in testing status.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/testing/usage", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "testing", "usage" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"startedTime\": \"\",\n \"endedTime\": \"\",\n \"usage\": {\n \"dataBytes\": \"\",\n \"numberOfSms\": \"\"\n },\n \"usageLimit\": {\n \"days\": \"\",\n \"dataBytes\": \"\",\n \"numberOfSms\": \"\",\n \"nextStatus\": \"suspended\",\n \"statusTransitionDelayDays\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-857b9966-2445-4a28-9676-b3346b1eb290" }, { "id": "79811285-dbd7-4802-86f4-58d3b2213f20", "name": "No testing usage information found for the target IoT SIM.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/testing/usage", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "testing", "usage" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-79811285-dbd7-4802-86f4-58d3b2213f20" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-57fab2ed-7e5a-4612-ab9d-5144682de234" } ], "id": "80b47967-e1a6-4507-b82a-fccf176e5951", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-80b47967-e1a6-4507-b82a-fccf176e5951" } ], "id": "f12fdd4a-6c6c-4672-bf6e-b7d7d439e500", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-f12fdd4a-6c6c-4672-bf6e-b7d7d439e500" }, { "name": "unset_expiry_time", "item": [ { "name": "Deletes expiry time of the SIM", "id": "4dab7fc6-a202-4c85-bf8e-78874f10b5a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_expiry_time" ], "variable": [ { "id": "3677dd16-3709-4fb0-8c41-b2e43e3bf9fc", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Deletes expiry time of specified SIM and changes it to indefinite." }, "response": [ { "id": "02407a72-13af-4159-a554-e54313fd2967", "name": "Change of specified SIM's expiry time to indefinite complete.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_expiry_time" ], "variable": [ { "key": "sim_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-02407a72-13af-4159-a554-e54313fd2967" }, { "id": "ce9cd5e2-95ae-4dd5-938a-01400e7b2f28", "name": "The specified SIM does not exist or the SIM does not have an expiry time.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_expiry_time" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ce9cd5e2-95ae-4dd5-938a-01400e7b2f28" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4dab7fc6-a202-4c85-bf8e-78874f10b5a4" } ], "id": "30928437-8496-4817-9e55-8db346e2678d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-30928437-8496-4817-9e55-8db346e2678d" }, { "name": "unset_group", "item": [ { "name": "Removes a SIM from a SIM group", "id": "e4a9b4f3-178a-4844-9c1e-d9a0e6e7dff4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_group" ], "variable": [ { "id": "46bb9f8b-13a6-42bc-88e6-bd811b77946b", "key": "sim_id", "value": "", "description": "(Required) ID of the target SIM. The SIM ID can be obtained using the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Removes a SIM from a SIM group." }, "response": [ { "id": "607252b1-87fb-44df-b5f7-84c9b3fec5ba", "name": "Detailed information of the updated SIM.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_group" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-607252b1-87fb-44df-b5f7-84c9b3fec5ba" }, { "id": "ec5def08-f918-432a-a784-eef6d3811d30", "name": "The specified SIM does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_group" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ec5def08-f918-432a-a784-eef6d3811d30" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e4a9b4f3-178a-4844-9c1e-d9a0e6e7dff4" } ], "id": "03c56993-2cbf-4f08-9d19-95ea04a66906", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-03c56993-2cbf-4f08-9d19-95ea04a66906" }, { "name": "unset_imei_lock", "item": [ { "name": "Unsets IMEI lock of SIM", "id": "b0acdf25-0add-4fd6-bb43-0fcfa15f79f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_imei_lock" ], "variable": [ { "id": "45764aac-bf3a-435c-b6b0-49c77d3cb620", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Unsets the IMEI lock of the specified SIM." }, "response": [ { "id": "c4a97a4d-49ff-4c9a-8f23-302d81206ca2", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_imei_lock" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c4a97a4d-49ff-4c9a-8f23-302d81206ca2" }, { "id": "1bcd2c17-aa1e-409d-bfef-11bb9a7aac11", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "unset_imei_lock" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1bcd2c17-aa1e-409d-bfef-11bb9a7aac11" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b0acdf25-0add-4fd6-bb43-0fcfa15f79f6" } ], "id": "04b971f7-486f-45af-acf7-c314f90ede45", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-04b971f7-486f-45af-acf7-c314f90ede45" }, { "name": "update_speed_class", "item": [ { "name": "Updates the IoT SIM speed class", "id": "a2120cd4-8bc5-45f7-9be6-32381405639f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "update_speed_class" ], "variable": [ { "id": "f8294b5c-e38a-4b31-ab4f-0c61b4b0ad05", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Updates the IoT SIM speed class." }, "response": [ { "id": "afb120db-524d-469b-99e1-51ac83ded045", "name": "The SIM's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "update_speed_class" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-afb120db-524d-469b-99e1-51ac83ded045" }, { "id": "bdd5a7a0-a8d5-46f1-9def-d46b7198f268", "name": "The specified speed class does not exist to the subscription. For example, arc.standard cannot be specified for plan01s.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "update_speed_class" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bdd5a7a0-a8d5-46f1-9def-d46b7198f268" }, { "id": "47df17ab-b785-4b22-99f4-a3210b659028", "name": "No such SIM found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "update_speed_class" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-47df17ab-b785-4b22-99f4-a3210b659028" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a2120cd4-8bc5-45f7-9be6-32381405639f" } ], "id": "40041b3f-6a6a-4245-81e0-828a6fe03c2c", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-40041b3f-6a6a-4245-81e0-828a6fe03c2c" }, { "name": "Gets information about the IoT SIM", "id": "06caf280-ab57-4d8c-a0d3-946abcbacfce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id" ], "variable": [ { "id": "a5344baa-0f33-49cc-9d95-c6e0cfa2e52d", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ] }, "description": "Gets information about the IoT SIM." }, "response": [ { "id": "ea404334-0e84-4199-ba76-6bd9402ecc85", "name": "The IoT SIM's detailed information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ea404334-0e84-4199-ba76-6bd9402ecc85" }, { "id": "95485b17-59f0-4509-8741-fe5d0bc0ead8", "name": "No such SIM found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-95485b17-59f0-4509-8741-fe5d0bc0ead8" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-06caf280-ab57-4d8c-a0d3-946abcbacfce" } ], "id": "7424de72-4a15-42f7-b501-e65c86e01e9e", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-7424de72-4a15-42f7-b501-e65c86e01e9e" }, { "name": "List SIMs", "id": "b78d26e0-9d85-4644-83e1-a5c5d45062f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sims?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims" ], "query": [ { "description": "Maximum number of SIMs to retrieve. However, the number of SIMs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of SIMs. If the total number of SIMs does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "5a2dcef1-7a6c-496e-b7ea-2387cc1a0604", "name": "List of IoT SIMs.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims" ], "query": [ { "description": "Maximum number of SIMs to retrieve. However, the number of SIMs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"terminate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"nisi8d\": \"\",\n \"Lorem770\": \"\",\n \"veniam_1\": \"\"\n },\n \"moduleType\": \"profilePackage\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"non_5f\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"adipisicinge4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"consequat_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"deserunt_9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"GSM\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"ready\",\n \"tags\": {\n \"ut_9\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"euicc\"\n },\n {\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"eu-central-1\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"terminate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"incididunt2\": \"\",\n \"laboris_41\": \"\",\n \"incididunt_5b\": \"\"\n },\n \"moduleType\": \"embedded\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"sed_64\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cillum6\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"in1\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"velite\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"in_b6\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n }\n }\n },\n \"voluptate5\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"laborumd4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"dolore_687\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"ready\",\n \"tags\": {\n \"velit_16\": \"\",\n \"deserunt_5c\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5a2dcef1-7a6c-496e-b7ea-2387cc1a0604" }, { "id": "4bfd99f2-07b9-4bb7-a5af-25d451ff91c9", "name": "No such SIM found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sims?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sims" ], "query": [ { "description": "Maximum number of SIMs to retrieve. However, the number of SIMs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page.", "key": "last_evaluated_key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4bfd99f2-07b9-4bb7-a5af-25d451ff91c9" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b78d26e0-9d85-4644-83e1-a5c5d45062f6" }, { "name": "Creates a new virtual SIM/Subscriber", "id": "890afa60-3fa7-42a0-a143-8eee72288853", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"virtual\",\n \"subscription\": \"planArc01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims", "host": [ "{{baseUrl}}" ], "path": [ "sims" ] }, "description": "Creates a new Soracom Arc virtual SIM/Subscriber. For details, please refer to [Creating Virtual SIMs](/en/docs/arc/configuration/)." }, "response": [ { "id": "8231caed-e24e-46fd-8758-96303c099e70", "name": "A virtual SIM/Subscriber has been created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"virtual\",\n \"subscription\": \"planArc01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims", "host": [ "{{baseUrl}}" ], "path": [ "sims" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeProfileId\": \"\",\n \"arcSessionStatus\": {\n \"arcAllowedIPs\": [\n \"\",\n \"\"\n ],\n \"arcClientPeerIpAddress\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"arcServerEndpoint\": \"\",\n \"arcServerPeerPublicKey\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"lastUpdatedAt\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"vpgId\": \"\"\n },\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"createdTime\": \"\",\n \"expiryAction\": \"(null value)\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"utc\": \"\",\n \"qui3\": \"\",\n \"aliquip_9\": \"\",\n \"sit_91\": \"\",\n \"idbc\": \"\"\n },\n \"moduleType\": \"virtual\",\n \"operatorId\": \"\",\n \"otaSerialNumber\": \"\",\n \"pcapEndTime\": \"\",\n \"pcapStartTime\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"profiles\": {\n \"proident_47\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"quis17\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"occaecatd\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n }\n }\n },\n \"ullamcod\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"enim_e3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"deseruntc8\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n },\n \"exercitation_2d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n }\n }\n }\n },\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"esta\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-8231caed-e24e-46fd-8758-96303c099e70" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-890afa60-3fa7-42a0-a143-8eee72288853" } ], "id": "eeab28c8-f7f0-4b63-b651-972e8331cec5", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-eeab28c8-f7f0-4b63-b651-972e8331cec5" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "activate", "item": [ { "name": "Activate Subscriber.", "id": "c4f00dde-cd66-4370-95e7-919d36c7107d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/activate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "activate" ], "variable": [ { "id": "41362663-5628-4ba0-82af-549f6c37bc0c", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Activates status of specified subscriber." }, "response": [ { "id": "a59b32d8-febd-4e60-a9bb-4ec013d12d27", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/activate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "activate" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a59b32d8-febd-4e60-a9bb-4ec013d12d27" }, { "id": "05f08f01-9e63-4966-acad-c44047bafa66", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/activate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "activate" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-05f08f01-9e63-4966-acad-c44047bafa66" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c4f00dde-cd66-4370-95e7-919d36c7107d" } ], "id": "ce32a8cf-cc66-4c40-9840-a70c78e70202", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-ce32a8cf-cc66-4c40-9840-a70c78e70202" }, { "name": "bundles", "item": [ { "name": "Set Bundles to Subscriber.", "id": "64497073-c15b-48e0-a0f9-d8597339481b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"US-10GB\",\n \"DU-100GB\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/bundles", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "bundles" ], "variable": [ { "id": "bc288807-de1b-4381-afe1-84d5084e351b", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims)." } ] }, "description": "Sets bundles to the specified subscriber." }, "response": [ { "id": "d56eddc2-bca5-4d88-bdd1-05a822705936", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"US-10GB\",\n \"DU-100GB\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/bundles", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "bundles" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d56eddc2-bca5-4d88-bdd1-05a822705936" }, { "id": "77c6eec7-a029-4e07-a2e2-6a8fc3c5d24b", "name": "The specified bundle is not supported by this Subscriber's subscription.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"US-10GB\",\n \"DU-100GB\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/bundles", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "bundles" ], "variable": [ { "key": "imsi" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-77c6eec7-a029-4e07-a2e2-6a8fc3c5d24b" }, { "id": "89a148b7-a8b7-4b60-a707-f1acb9508f85", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"US-10GB\",\n \"DU-100GB\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/bundles", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "bundles" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-89a148b7-a8b7-4b60-a707-f1acb9508f85" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-64497073-c15b-48e0-a0f9-d8597339481b" } ], "id": "ff62ddec-e19b-439e-8022-5c37a2d7ec2d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-ff62ddec-e19b-439e-8022-5c37a2d7ec2d" }, { "name": "data", "item": [ { "name": "Get data sent from a subscriber to Harvest Data.", "id": "657aee7e-a909-443d-ae46-5695f714dbc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "data" ], "query": [ { "description": "Start time for the data entries search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the data entries search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward.\n", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "d84e24ea-9069-4643-8971-e117837a3156", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber that generated data entries." } ] }, "description": "Returns a list of data entries sent to Harvest Data from a subscriber that match certain criteria. If the total number of data entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "5d8f29a8-5b66-47d4-a136-e9d15d3b52ce", "name": "A list of data entries.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "data" ], "query": [ { "description": "Start time for the data entries search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the data entries search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward.\n", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"Device\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"Sim\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5d8f29a8-5b66-47d4-a136-e9d15d3b52ce" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-657aee7e-a909-443d-ae46-5695f714dbc4" } ], "id": "e8badb80-cf76-447b-9920-072fe697a597", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e8badb80-cf76-447b-9920-072fe697a597" }, { "name": "deactivate", "item": [ { "name": "Deactivate Subscriber.", "id": "d6dfc12e-8f58-42b2-9ba9-26bbbe96cc82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "deactivate" ], "variable": [ { "id": "f9a763d3-07ae-4d7f-b868-e07a943b1295", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deactivates specified subscriber." }, "response": [ { "id": "210343ec-88c5-4483-a45b-fed039663448", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "deactivate" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-210343ec-88c5-4483-a45b-fed039663448" }, { "id": "9bf032d3-8d97-4f44-aed0-9d3a037b82c6", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "deactivate" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9bf032d3-8d97-4f44-aed0-9d3a037b82c6" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d6dfc12e-8f58-42b2-9ba9-26bbbe96cc82" } ], "id": "3d6a56db-d45a-4c26-99e5-05b0ac787c06", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-3d6a56db-d45a-4c26-99e5-05b0ac787c06" }, { "name": "delete_session", "item": [ { "name": "Delete Session", "id": "53ec4db5-6ee6-480d-829e-8b1473d02084", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "delete_session" ], "variable": [ { "id": "fa51a356-f165-486c-86c1-3ef4c3434f9e", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deletes session for the specified subscriber." }, "response": [ { "id": "a0b38c78-dd4e-4f1b-b07e-9803c1723f53", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "delete_session" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a0b38c78-dd4e-4f1b-b07e-9803c1723f53" }, { "id": "6a093adf-7b3d-4c9b-b918-c80b0a324927", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/delete_session", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "delete_session" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6a093adf-7b3d-4c9b-b918-c80b0a324927" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-53ec4db5-6ee6-480d-829e-8b1473d02084" } ], "id": "5bd8107d-72cd-4ea7-9b7b-b73e6d9c7016", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5bd8107d-72cd-4ea7-9b7b-b73e6d9c7016" }, { "name": "disable_termination", "item": [ { "name": "Disable Termination of Subscriber.", "id": "6da25d2c-5f59-42e5-8898-16a80e7c52a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "disable_termination" ], "variable": [ { "id": "f12b2ec6-a939-465e-8de8-38cd9c8f75f1", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Disables termination of specified subscriber." }, "response": [ { "id": "9cc83c6a-7216-42e7-aac8-b311d0627246", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "disable_termination" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9cc83c6a-7216-42e7-aac8-b311d0627246" }, { "id": "9397b473-9c01-445a-939f-15f240b3b91c", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "disable_termination" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9397b473-9c01-445a-939f-15f240b3b91c" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6da25d2c-5f59-42e5-8898-16a80e7c52a3" } ], "id": "54e98f19-2c41-4a8c-af31-fb1348bcf5b4", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-54e98f19-2c41-4a8c-af31-fb1348bcf5b4" }, { "name": "downlink", "item": [ { "name": "ping", "item": [ { "name": "Send ping requests to a subscriber.", "id": "e9aabb5f-c0b6-4a72-bfa4-ed29f880f730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"numberOfPingRequests\": 1,\n \"timeoutSeconds\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/downlink/ping", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "downlink", "ping" ], "variable": [ { "id": "531db15d-dde0-4cd7-b82e-dd5d7c8dfd62", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Send ICMP ping requests to a subscriber." }, "response": [ { "id": "9ed18f0c-8b49-4529-8e38-5358a6150f1b", "name": "Result of the ping", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"numberOfPingRequests\": 1,\n \"timeoutSeconds\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/downlink/ping", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "downlink", "ping" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"rtt\": \"\",\n \"stat\": \"\",\n \"success\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9ed18f0c-8b49-4529-8e38-5358a6150f1b" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e9aabb5f-c0b6-4a72-bfa4-ed29f880f730" } ], "id": "2a1f283b-7334-4c5e-8615-868e4f4e5e1a", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-2a1f283b-7334-4c5e-8615-868e4f4e5e1a" } ], "id": "c6455dee-a33a-48d6-a910-229a009da160", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-c6455dee-a33a-48d6-a910-229a009da160" }, { "name": "enable_termination", "item": [ { "name": "Enable Termination of Subscriber.", "id": "7d620881-925b-44b9-a998-8171e38280fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "enable_termination" ], "variable": [ { "id": "5a78a549-5eb9-4c64-b9b3-c5a03a253059", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Enables termination of specified subscriber." }, "response": [ { "id": "7b442262-a3bd-4e9c-85b2-5b0c0ef069d8", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "enable_termination" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7b442262-a3bd-4e9c-85b2-5b0c0ef069d8" }, { "id": "89762342-b9f7-4a69-a922-8c96c5f4f8d5", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "enable_termination" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-89762342-b9f7-4a69-a922-8c96c5f4f8d5" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7d620881-925b-44b9-a998-8171e38280fa" } ], "id": "49a84242-55ea-455f-ab30-778d2d95aa41", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-49a84242-55ea-455f-ab30-778d2d95aa41" }, { "name": "events", "item": [ { "name": "sessions", "item": [ { "name": "List Session Events.", "id": "e4bccd69-a1bc-4464-b1f7-be0e61565666", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/events/sessions?from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "events", "sessions" ], "query": [ { "description": "Start time for the events search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the events search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Maximum number of events to retrieve.", "key": "limit", "value": "" }, { "description": "The time stamp of the last event retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next event onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "52121808-f378-4c5e-b16a-743f99272e28", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Returns the event history of session creation/modification/disconnection on the specified subscriber in the last 32 days. If the total number of events does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "372e6fd3-3a4d-45e5-b48c-2cb7515b4188", "name": "A list of session events", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/events/sessions?from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "events", "sessions" ], "query": [ { "description": "Start time for the events search range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time for the events search range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Maximum number of events to retrieve.", "key": "limit", "value": "" }, { "description": "The time stamp of the last event retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next event onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apn\": \"\",\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"dns0\": \"\",\n \"dns1\": \"\",\n \"event\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"sessionId\": \"\",\n \"simId\": \"\",\n \"subscription\": \"\",\n \"time\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n {\n \"apn\": \"\",\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"dns0\": \"\",\n \"dns1\": \"\",\n \"event\": \"\",\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"sessionId\": \"\",\n \"simId\": \"\",\n \"subscription\": \"\",\n \"time\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-372e6fd3-3a4d-45e5-b48c-2cb7515b4188" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e4bccd69-a1bc-4464-b1f7-be0e61565666" } ], "id": "f4b4027a-18d5-4465-98da-590cbf9f2e63", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-f4b4027a-18d5-4465-98da-590cbf9f2e63" } ], "id": "d6bbbcf0-616a-41ba-b8e1-e4615040e3bc", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d6bbbcf0-616a-41ba-b8e1-e4615040e3bc" }, { "name": "register", "item": [ { "name": "Register Subscriber.", "id": "2f837f35-3371-46ea-bb67-c44c21f6a348", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"registrationSecret\": \"\",\n \"groupId\": \"\",\n \"tags\": {\n \"irure2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/register", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "register" ], "variable": [ { "id": "031db2d2-67ad-40c5-91a0-18ee3f772a1d", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Registers a subscriber." }, "response": [ { "id": "4d94ca36-304e-4365-9d84-9dc95c000876", "name": "Subscriber registration complete.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"registrationSecret\": \"\",\n \"groupId\": \"\",\n \"tags\": {\n \"irure2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/register", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "register" ], "variable": [ { "key": "imsi" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-4d94ca36-304e-4365-9d84-9dc95c000876" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-2f837f35-3371-46ea-bb67-c44c21f6a348" } ], "id": "e25774fd-2419-495f-9712-e4f556c91d3d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e25774fd-2419-495f-9712-e4f556c91d3d" }, { "name": "report_local_info", "item": [ { "name": "Triggers Subscriber to report SIM local info.", "id": "93d4b767-3324-4c20-b892-55da5cf406dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "report_local_info" ], "variable": [ { "id": "1f1b1796-3777-4061-a93e-145b381aa241", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Triggers Subscriber to report SIM local info." }, "response": [ { "id": "5ccb5f0d-1378-4983-bd6b-f0a07fdc0399", "name": "The local info reporting has successfully been triggered. The subscriber information is asynchronously updated when the SIM reports the information back.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "report_local_info" ], "variable": [ { "key": "imsi" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5ccb5f0d-1378-4983-bd6b-f0a07fdc0399" }, { "id": "eab97d8a-0507-4d99-878e-212aa60037ab", "name": "The specified subscriber does not support local info reporting feature.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "report_local_info" ], "variable": [ { "key": "imsi" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-eab97d8a-0507-4d99-878e-212aa60037ab" }, { "id": "1b818df4-efbf-4a90-90a6-fde977068483", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/report_local_info", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "report_local_info" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1b818df4-efbf-4a90-90a6-fde977068483" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-93d4b767-3324-4c20-b892-55da5cf406dd" } ], "id": "d6925180-25b2-4f20-bc4c-be47715825b7", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d6925180-25b2-4f20-bc4c-be47715825b7" }, { "name": "send_sms", "item": [ { "name": "Send SMS to Subscriber", "id": "ebc887bb-e791-4f44-a827-88d0e1a6a17d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "send_sms" ], "variable": [ { "id": "de99e888-0f52-4a86-b447-16570fa2be74", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Send SMS to the specified subscriber." }, "response": [ { "id": "ab4b574f-0b0b-482e-a005-247845ba8a33", "name": "SMS transmission accepted and completed. Returns the ID assigned to the message.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "send_sms" ], "variable": [ { "key": "imsi" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"messageId\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ab4b574f-0b0b-482e-a005-247845ba8a33" }, { "id": "56de9363-fe2f-499a-bcee-436c294fe10b", "name": "The specified subscriber does not support SMS API.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "send_sms" ], "variable": [ { "key": "imsi" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-56de9363-fe2f-499a-bcee-436c294fe10b" }, { "id": "6e3fd666-515e-417a-96bf-fed57a8321fc", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "send_sms" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6e3fd666-515e-417a-96bf-fed57a8321fc" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ebc887bb-e791-4f44-a827-88d0e1a6a17d" } ], "id": "77d2031f-65f4-4344-aceb-c433cddecc48", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-77d2031f-65f4-4344-aceb-c433cddecc48" }, { "name": "set_expiry_time", "item": [ { "name": "Update Expiry Time of Subscriber.", "id": "7c5aceaf-4653-4f5e-8984-1fb038b0bdbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_expiry_time" ], "variable": [ { "id": "f9a37502-e4df-45df-9c7b-cc703a2cc318", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Updates expiry time of specified subscriber." }, "response": [ { "id": "653794d6-4fe2-453b-9d3b-3e7266c41a06", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_expiry_time" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-653794d6-4fe2-453b-9d3b-3e7266c41a06" }, { "id": "5b19ed00-e214-46b1-9051-e4a5771a5e14", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiryTime\": \"\",\n \"expiryAction\": \"doNothing\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_expiry_time" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5b19ed00-e214-46b1-9051-e4a5771a5e14" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7c5aceaf-4653-4f5e-8984-1fb038b0bdbd" } ], "id": "df5cb702-38e3-49a3-8d22-486b42c68cd2", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-df5cb702-38e3-49a3-8d22-486b42c68cd2" }, { "name": "set_group", "item": [ { "name": "Adds a SIM to a SIM group", "id": "ebcf0330-9467-4944-81d2-054d583e9956", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_group" ], "variable": [ { "id": "97e0e21c-3fc6-48cf-aadb-d39a8a8c5b14", "key": "imsi", "value": "", "description": "(Required) IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)." } ] }, "description": "Adds a SIM to a SIM group." }, "response": [ { "id": "21b240f1-f35b-4bcb-a025-979a413a362e", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_group" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-21b240f1-f35b-4bcb-a025-979a413a362e" }, { "id": "da1eb2e7-d0a2-406f-88b4-e6c95191f4e1", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_group" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-da1eb2e7-d0a2-406f-88b4-e6c95191f4e1" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ebcf0330-9467-4944-81d2-054d583e9956" } ], "id": "e6c1b2db-ad21-4d8c-9b90-15567b1a6be6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e6c1b2db-ad21-4d8c-9b90-15567b1a6be6" }, { "name": "set_imei_lock", "item": [ { "name": "Set IMEI lock configuration for Subscriber.", "id": "c60376d8-3452-4319-9895-acee17d733cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_imei_lock" ], "variable": [ { "id": "df2e50bb-bffe-42a3-87ee-ba9a7c5a09e3", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Set IMEI that the subscriber should be locked to." }, "response": [ { "id": "edd2c76b-5727-4081-9fc2-b4879a2fce9d", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_imei_lock" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-edd2c76b-5727-4081-9fc2-b4879a2fce9d" }, { "id": "985937f1-2a3b-4fb5-ae98-ebbe45cf79fa", "name": "Invalid IMEI string or subscriber is offline and IMEI not specified.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_imei_lock" ], "variable": [ { "key": "imsi" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-985937f1-2a3b-4fb5-ae98-ebbe45cf79fa" }, { "id": "fd714b10-b37f-4b97-b285-22dd73b21ac3", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"imei\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_imei_lock" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fd714b10-b37f-4b97-b285-22dd73b21ac3" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c60376d8-3452-4319-9895-acee17d733cf" } ], "id": "e4ca9005-f826-4574-a7eb-710bbfba5e7c", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e4ca9005-f826-4574-a7eb-710bbfba5e7c" }, { "name": "set_to_standby", "item": [ { "name": "Set Subscriber to standby mode.", "id": "5010019f-074d-4d33-acf8-ed17d6bfb390", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_to_standby" ], "variable": [ { "id": "e4239b4f-0f8f-4bc0-9b1d-b86e0be4b698", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Set the specified subscriber to standby mode." }, "response": [ { "id": "2643b6f5-3cf3-4df0-b30a-9a2d8f5093ac", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_to_standby" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-2643b6f5-3cf3-4df0-b30a-9a2d8f5093ac" }, { "id": "781f9762-c964-49e6-a094-24b415fd6631", "name": "The specified subscriber does not support standby mode.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_to_standby" ], "variable": [ { "key": "imsi" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-781f9762-c964-49e6-a094-24b415fd6631" }, { "id": "59f42331-c54d-4018-bc3f-13b21bec3cbc", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/set_to_standby", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "set_to_standby" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-59f42331-c54d-4018-bc3f-13b21bec3cbc" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5010019f-074d-4d33-acf8-ed17d6bfb390" } ], "id": "e53a2b08-f8c3-4951-978e-53ee73ef3c98", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-e53a2b08-f8c3-4951-978e-53ee73ef3c98" }, { "name": "suspend", "item": [ { "name": "Suspend Subscriber.", "id": "eef634dc-114e-4364-a5ec-62d46868f72c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/suspend", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "suspend" ], "variable": [ { "id": "a8417230-48b4-4c5a-851e-9425d7ee40ca", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Suspends the specified subscriber." }, "response": [ { "id": "77a9f943-5d3e-4b0c-aba0-42b8e9055b58", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/suspend", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "suspend" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-77a9f943-5d3e-4b0c-aba0-42b8e9055b58" }, { "id": "b2797f9b-a36a-4ba5-8c8f-c82d5b82ee25", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/suspend", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "suspend" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b2797f9b-a36a-4ba5-8c8f-c82d5b82ee25" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-eef634dc-114e-4364-a5ec-62d46868f72c" } ], "id": "d92c0127-e079-4655-a0f4-9d1fc09b34db", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d92c0127-e079-4655-a0f4-9d1fc09b34db" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete Subscriber Tag.", "id": "f2453a53-509b-4666-8029-6b9a03893c8d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags", ":tag_name" ], "variable": [ { "id": "0bc42bc2-d0dd-4505-a8cc-170d014918b4", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." }, { "id": "e095a596-3360-4f09-a209-12490ea660dc", "key": "tag_name", "value": "", "description": "(Required) Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ] }, "description": "Deletes a tag from the specified subscriber." }, "response": [ { "id": "3f2d168d-f01f-4197-8c9c-c7b54c3c8ed0", "name": "Deletion of specified tag complete.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags", ":tag_name" ], "variable": [ { "key": "imsi" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-3f2d168d-f01f-4197-8c9c-c7b54c3c8ed0" }, { "id": "c1250092-5bb7-4c70-9b3c-c79eb664a400", "name": "The specified subscriber or the tag does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags", ":tag_name" ], "variable": [ { "key": "imsi" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c1250092-5bb7-4c70-9b3c-c79eb664a400" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f2453a53-509b-4666-8029-6b9a03893c8d" } ], "id": "2deded56-1300-43e2-b716-626577956f95", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-2deded56-1300-43e2-b716-626577956f95" }, { "name": "Bulk Insert or Update Subscriber Tags.", "id": "e4e101b5-7c42-4ad7-9ffd-7f6af8a188da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags" ], "variable": [ { "id": "17e03750-7768-4c5c-adb7-4c57b0c073fc", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Inserts/updates tags for the specified subscriber." }, "response": [ { "id": "fe8f5d1e-c605-4fd2-a734-2e7347bce517", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fe8f5d1e-c605-4fd2-a734-2e7347bce517" }, { "id": "d92127d3-0b9b-4068-af6e-536d2a5c5493", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n },\n {\n \"tagName\": \"\",\n \"tagValue\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/tags", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "tags" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d92127d3-0b9b-4068-af6e-536d2a5c5493" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e4e101b5-7c42-4ad7-9ffd-7f6af8a188da" } ], "id": "10ee2990-ccc9-47f8-8f36-e27ef733428d", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-10ee2990-ccc9-47f8-8f36-e27ef733428d" }, { "name": "terminate", "item": [ { "name": "Terminate Subscriber.", "id": "390ab9ab-5ec5-4d17-83ff-aa7ce3c93293", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/terminate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "terminate" ], "variable": [ { "id": "45336cfb-4344-4103-827d-df789d308961", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Terminates the specified subscriber" }, "response": [ { "id": "f6310e43-8735-4f58-bb2f-438f337d5cac", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/terminate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "terminate" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f6310e43-8735-4f58-bb2f-438f337d5cac" }, { "id": "00bc77a6-d3b2-4da5-893f-a46ba9138134", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/terminate", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "terminate" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-00bc77a6-d3b2-4da5-893f-a46ba9138134" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-390ab9ab-5ec5-4d17-83ff-aa7ce3c93293" } ], "id": "ae0e871f-eab8-4bd7-b5bc-0a17ec31c5fd", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-ae0e871f-eab8-4bd7-b5bc-0a17ec31c5fd" }, { "name": "unset_expiry_time", "item": [ { "name": "Delete Expiry Time of Subscriber.", "id": "7f7fccbf-846d-4c3b-a456-6a7a4ae467e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_expiry_time" ], "variable": [ { "id": "fdc18041-a53a-44b6-8a0b-8c37dd3db254", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deletes expiry time of specified subscriber and changes it to indefinite." }, "response": [ { "id": "e78394d7-a8d3-4deb-8ab7-87bf61d0bdd7", "name": "Change of specified subscriber's expiry time to indefinite complete.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_expiry_time" ], "variable": [ { "key": "imsi" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e78394d7-a8d3-4deb-8ab7-87bf61d0bdd7" }, { "id": "3fa9fa85-c907-42b5-beab-c9a673d58508", "name": "The specified subscriber does not exist or the subscriber does not have an expiry time.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_expiry_time", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_expiry_time" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-3fa9fa85-c907-42b5-beab-c9a673d58508" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7f7fccbf-846d-4c3b-a456-6a7a4ae467e8" } ], "id": "a731ad5f-a2fc-42f0-addc-a4d7002d047a", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-a731ad5f-a2fc-42f0-addc-a4d7002d047a" }, { "name": "unset_group", "item": [ { "name": "Removes a SIM from a SIM group", "id": "3a816cc9-861c-4f47-8ce6-17e9ef424d21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_group" ], "variable": [ { "id": "5e275842-b46c-420c-96bd-5704afcf58af", "key": "imsi", "value": "", "description": "(Required) IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)." } ] }, "description": "Removes a SIM from a SIM group." }, "response": [ { "id": "a23a49e5-54b2-4d57-9520-ec94839e6b29", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_group" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-a23a49e5-54b2-4d57-9520-ec94839e6b29" }, { "id": "6a49f45f-29e9-423d-a3e7-9ddad34b50fd", "name": "The specified subscriber does not exist or the subscriber does not belong to a group.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_group" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6a49f45f-29e9-423d-a3e7-9ddad34b50fd" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-3a816cc9-861c-4f47-8ce6-17e9ef424d21" } ], "id": "d9f499e2-8af8-40be-a16d-3165f6cc8a22", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-d9f499e2-8af8-40be-a16d-3165f6cc8a22" }, { "name": "unset_imei_lock", "item": [ { "name": "Unset IMEI lock configuration for Subscriber.", "id": "902f6ebf-69ee-4803-bba8-c165d306265b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_imei_lock" ], "variable": [ { "id": "5ee7b5a2-1d44-4c54-b260-44d2d9b610a9", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Remove any existing IMEI lock configuration for the subscriber." }, "response": [ { "id": "b550c7d4-c9d8-4ac9-ba26-599376e85df2", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_imei_lock" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b550c7d4-c9d8-4ac9-ba26-599376e85df2" }, { "id": "e5f0212e-052b-4ff4-be19-42ee87fa658e", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi/unset_imei_lock", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "unset_imei_lock" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e5f0212e-052b-4ff4-be19-42ee87fa658e" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-902f6ebf-69ee-4803-bba8-c165d306265b" } ], "id": "4909571b-5da0-4970-bf2a-c75c3b2a947a", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-4909571b-5da0-4970-bf2a-c75c3b2a947a" }, { "name": "update_speed_class", "item": [ { "name": "Update Subscriber speed class.", "id": "13d2d373-00d4-45ac-bb01-bd0a027a83c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "update_speed_class" ], "variable": [ { "id": "998dbee7-6a51-4ed2-91d7-eaad878aa54d", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Changes the speed class of the specified subscriber." }, "response": [ { "id": "1f7a8c34-df5e-42a6-be5f-ae2277c0f827", "name": "The subscriber's detailed information after the update.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "update_speed_class" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1f7a8c34-df5e-42a6-be5f-ae2277c0f827" }, { "id": "79b10a79-c6f7-4efc-b50f-a1fc8b634a1f", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"speedClass\": \"s1.8xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/update_speed_class", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "update_speed_class" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-79b10a79-c6f7-4efc-b50f-a1fc8b634a1f" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-13d2d373-00d4-45ac-bb01-bd0a027a83c1" } ], "id": "c5882aaf-98b4-4d2f-8e65-f873fdf5bfa5", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-c5882aaf-98b4-4d2f-8e65-f873fdf5bfa5" }, { "name": "Get Subscriber.", "id": "bf989e30-ea51-4b71-bab9-ea91ec0fe276", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi" ], "variable": [ { "id": "7e16e7a1-57d1-47de-a7c8-839b78240b74", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Returns information about the specified subscriber." }, "response": [ { "id": "750bc898-72c8-44e6-84f0-94752d2c0681", "name": "The subscriber's detailed information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"virtual\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"NB-IoT\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ipsum1cf\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-750bc898-72c8-44e6-84f0-94752d2c0681" }, { "id": "b33b9bad-89bc-45a7-b767-70882a89ccef", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-b33b9bad-89bc-45a7-b767-70882a89ccef" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-bf989e30-ea51-4b71-bab9-ea91ec0fe276" } ], "id": "5c328cff-b764-481c-835d-f1efdb8c4b0f", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-5c328cff-b764-481c-835d-f1efdb8c4b0f" }, { "name": "export", "item": [ { "name": "Export all subscribers.", "id": "9b4d1d44-f902-41dd-88f2-128d2bbd37e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "export" ], "query": [ { "description": "export mode (async, sync)", "key": "export_mode", "value": "sync" } ] }, "description": "Export all subscribers as a CSV file." }, "response": [ { "id": "72128e09-a03e-4056-8ee9-e37a02297a3e", "name": "Where to export subscribers.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "export" ], "query": [ { "description": "export mode (async, sync)", "key": "export_mode", "value": "sync" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedFileId\": \"\",\n \"exportedFilePath\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-72128e09-a03e-4056-8ee9-e37a02297a3e" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9b4d1d44-f902-41dd-88f2-128d2bbd37e0" } ], "id": "1c10821e-371e-4113-8583-89402c395574", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-1c10821e-371e-4113-8583-89402c395574" }, { "name": "msisdn", "item": [ { "name": "{msisdn}", "item": [ { "name": "send_sms", "item": [ { "name": "Send SMS to Subscriber by MSISDN", "id": "d1dfb0f3-3d77-49fc-88b8-30247e19042d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/msisdn/:msisdn/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "msisdn", ":msisdn", "send_sms" ], "variable": [ { "id": "4dac699a-4836-46f6-a924-7df6aa1411fa", "key": "msisdn", "value": "", "description": "(Required) MSISDN of the target subscriber." } ] }, "description": "Send SMS to a subscriber specified with MSISDN." }, "response": [ { "id": "74c1ca38-3206-441f-a993-caebd634557d", "name": "SMS transmission accepted and completed. Returns the ID assigned to the message.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/msisdn/:msisdn/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "msisdn", ":msisdn", "send_sms" ], "variable": [ { "key": "msisdn" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"messageId\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-74c1ca38-3206-441f-a993-caebd634557d" }, { "id": "85c014cc-c69a-4229-9d26-da0d8efe3e60", "name": "The specified subscriber does not support SMS API.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/msisdn/:msisdn/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "msisdn", ":msisdn", "send_sms" ], "variable": [ { "key": "msisdn" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-85c014cc-c69a-4229-9d26-da0d8efe3e60" }, { "id": "6efde756-3731-4c70-9b8e-f87d246c650d", "name": "The specified subscriber does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"encodingType\": 2,\n \"payload\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/msisdn/:msisdn/send_sms", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "msisdn", ":msisdn", "send_sms" ], "variable": [ { "key": "msisdn" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-6efde756-3731-4c70-9b8e-f87d246c650d" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d1dfb0f3-3d77-49fc-88b8-30247e19042d" } ], "id": "53be25d5-7e69-4959-86ec-e52cf23065e9", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-53be25d5-7e69-4959-86ec-e52cf23065e9" } ], "id": "196e1208-b3d0-43ca-a95f-13512357e249", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-196e1208-b3d0-43ca-a95f-13512357e249" } ], "id": "7cc4436a-454c-4699-9a93-1dd159bd3ee4", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-7cc4436a-454c-4699-9a93-1dd159bd3ee4" }, { "name": "transfer_token", "item": [ { "name": "{token}", "item": [ { "name": "Cancel the transfer of Ready status SIMs (Invalidate the transfer token)", "id": "80c4c8bb-a0c8-42d3-be9f-36b2878f7054", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/:token", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", ":token" ], "variable": [ { "id": "4cd389bc-dcc9-4021-98eb-62b843ce2c8c", "key": "token", "value": "", "description": "(Required) Transfer token. The transfer token can be obtained from [Subscriber:issueSubscriberTransferToken](#!/Subscriber/issueSubscriberTransferToken)." } ] }, "description": "Invalidate the transfer token for SIMs and cancels the transfer of all SIMs associated with the transfer token. To use this API, you need an API key and token issued with the source operator." }, "response": [ { "id": "5f12dc8f-03db-4515-b6a2-ea2ad019c0ce", "name": "Transfer token has been invalidated and the transfer has been cancelled.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/:token", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", ":token" ], "variable": [ { "key": "token" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5f12dc8f-03db-4515-b6a2-ea2ad019c0ce" }, { "id": "f90d79aa-e331-4a23-a8ae-7943f7834218", "name": "Transfer token does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/:token", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", ":token" ], "variable": [ { "key": "token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f90d79aa-e331-4a23-a8ae-7943f7834218" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-80c4c8bb-a0c8-42d3-be9f-36b2878f7054" } ], "id": "accb5e89-d8d1-4827-9d23-1a769f94f0b6", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-accb5e89-d8d1-4827-9d23-1a769f94f0b6" }, { "name": "issue", "item": [ { "name": "Initiate the transfer of Ready status SIMs (Issue a transfer token)", "id": "52859b09-f03f-4116-95f6-6252dcd03bcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transferDestinationOperatorEmail\": \"\",\n \"transferDestinationOperatorId\": \"\",\n \"transferImsi\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", "issue" ] }, "description": "Initiates the transfer of Ready status SIMs. To use this API, you need an API key and token issued with the source operator. When this API is executed, a transfer token is issued and sent to the destination operator via email. For more information about SIM transfers, please refer to [Transferring Ready Status SIMs](/en/docs/air/transfer/#transferring-ready-status-sims).\n\n- To cancel a transfer, cancel each transfer token individually. If there is a possibility of canceling SIMs one by one, specify only one IMSI. To cancel, use the [Subscriber:deleteSubscriberTransferToken API](#!/Subscriber/deleteSubscriberTransferToken).\n- When this API is executed, the status of the SIMs will change to \"Transferring\".\n\n**Warning**: Do not change the status of SIMs that are in the \"Transferring\" status. If the status is changed, the SIMs can no longer be transferred using this procedure. For the procedure to transfer SIMs whose status has been changed, refer to [Transferring Other Status SIMs](/en/docs/air/transfer/#transferring-other-status-sims).\n\n**Info**: The information of the destination operator can be confirmed by logging in to the Soracom User Console with the destination operator.\n" }, "response": [ { "id": "2ed7bb81-c9d5-4c8f-8bc1-3d3458e6d53c", "name": "OK. The status of the SIMs specified in `transferImsi` will change to \"Transferring\".\n\n**Warning**: Do not change the status of SIMs that are in the \"Transferring\" status. If the status is changed, the SIMs can no longer be transferred using the API.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transferDestinationOperatorEmail\": \"\",\n \"transferDestinationOperatorId\": \"\",\n \"transferImsi\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-2ed7bb81-c9d5-4c8f-8bc1-3d3458e6d53c" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-52859b09-f03f-4116-95f6-6252dcd03bcf" } ], "id": "0f9ba6e5-8535-4fbf-90df-3f30462af770", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-0f9ba6e5-8535-4fbf-90df-3f30462af770" }, { "name": "verify", "item": [ { "name": "Accept the transfer of Ready status SIMs (Verify the transfer token)", "id": "843ee523-671d-4e85-b178-75ee1e49cff9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", "verify" ] }, "description": "Verifies the transfer token for SIMs and accepts the transfer. To use this API, you need an API key and token issued with the destination operator." }, "response": [ { "id": "dde0f50b-e616-409c-b261-98daf5a5bdcd", "name": "SIM transfer successfully accepted and processed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/transfer_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", "transfer_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transferredImsi\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-dde0f50b-e616-409c-b261-98daf5a5bdcd" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-843ee523-671d-4e85-b178-75ee1e49cff9" } ], "id": "c7b7f2a0-4931-4ecf-a336-6e237182395b", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-c7b7f2a0-4931-4ecf-a336-6e237182395b" } ], "id": "c7cb09c4-3e46-4db4-a44b-6f6c596a9454", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-c7cb09c4-3e46-4db4-a44b-6f6c596a9454" }, { "name": "List Subscribers.", "id": "fc8072e4-ed13-420c-9883-912ee4aa469b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/subscribers?tag_name=&tag_value=&tag_value_match_mode=exact&status_filter=&speed_class_filter=&serial_number_filter=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers" ], "query": [ { "description": "Tag name for filtering the search (exact match).", "key": "tag_name", "value": "" }, { "description": "Tag search string for filtering the search. Required when `tag_name` has been specified.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Status for filtering the search. Can specify multiple values delimited by `|`. Valid values include: `active`, `inactive`, `ready`, `instock`, `shipped`, `suspended`, and `terminated`.", "key": "status_filter", "value": "" }, { "description": "Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include:\n\n- `s1.minimum`\n- `s1.slow`\n- `s1.standard`\n- `s1.fast`\n- `s1.4xfast`\n- `s1.8xfast`\n- `u1.standard`\n- `u1.slow`\n- `t1.standard`\n- `arc.standard`\n", "key": "speed_class_filter", "value": "" }, { "description": "Serial number for filtering the search. Can specify multiple values delimited by `|`. Returns subscribers with serial number starting with the specified value(s).", "key": "serial_number_filter", "value": "" }, { "description": "Maximum number of subscribers to retrieve (value range is 1 to 100). However, the number of subscribers returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of subscribers that match certain criteria. If the total number of subscribers does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "0ab8a698-06aa-4812-bab5-045a49cffbc0", "name": "A list of subscribers.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/subscribers?tag_name=&tag_value=&tag_value_match_mode=exact&status_filter=&speed_class_filter=&serial_number_filter=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "subscribers" ], "query": [ { "description": "Tag name for filtering the search (exact match).", "key": "tag_name", "value": "" }, { "description": "Tag search string for filtering the search. Required when `tag_name` has been specified.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Status for filtering the search. Can specify multiple values delimited by `|`. Valid values include: `active`, `inactive`, `ready`, `instock`, `shipped`, `suspended`, and `terminated`.", "key": "status_filter", "value": "" }, { "description": "Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include:\n\n- `s1.minimum`\n- `s1.slow`\n- `s1.standard`\n- `s1.fast`\n- `s1.4xfast`\n- `s1.8xfast`\n- `u1.standard`\n- `u1.slow`\n- `t1.standard`\n- `arc.standard`\n", "key": "speed_class_filter", "value": "" }, { "description": "Serial number for filtering the search. Can specify multiple values delimited by `|`. Returns subscribers with serial number starting with the specified value(s).", "key": "serial_number_filter", "value": "" }, { "description": "Maximum number of subscribers to retrieve (value range is 1 to 100). However, the number of subscribers returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward.", "key": "last_evaluated_key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"deactivate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"integrated\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"3G\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\",\n \"tags\": {\n \"tempor_\": \"\",\n \"nostrudd25\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\n {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"terminate\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"iccid\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedAt\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"locationRegistrationStatus\": {\n \"cs\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"eps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n },\n \"ps\": {\n \"lastModifiedTime\": \"\",\n \"vplmn\": \"\"\n }\n },\n \"moduleType\": \"nano\",\n \"msisdn\": \"\",\n \"operatorId\": \"\",\n \"plan\": \"\",\n \"previousSession\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"createdTime\": \"\",\n \"deletedTime\": \"\",\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"registeredTime\": \"\",\n \"renewalFeeStatusSetTime\": \"\",\n \"serialNumber\": \"\",\n \"sessionStatus\": {\n \"cell\": {\n \"ci\": \"\",\n \"eci\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"rac\": \"\",\n \"radioType\": \"LTE-M\",\n \"sac\": \"\",\n \"tac\": \"\"\n },\n \"dnsServers\": [\n \"\",\n \"\"\n ],\n \"gatewayPrivateIpAddress\": \"\",\n \"gatewayPublicIpAddress\": \"\",\n \"imei\": \"\",\n \"imsi\": \"\",\n \"lastUpdatedAt\": \"\",\n \"location\": {},\n \"online\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"ap-southeast-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\",\n \"tags\": {\n \"ut15\": \"\",\n \"elit5af\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-0ab8a698-06aa-4812-bab5-045a49cffbc0" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-fc8072e4-ed13-420c-9883-912ee4aa469b" } ], "id": "93d9b5fd-40fe-43d2-a54a-d30c685cf47f", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-93d9b5fd-40fe-43d2-a54a-d30c685cf47f" }, { "name": "sim_profile_orders", "item": [ { "name": "{profile_order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm an eSIM profile order", "id": "aa98fd44-94a4-4991-9a55-43503cabfd42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "confirm" ], "variable": [ { "id": "eab58b7f-5b9c-4b77-8e86-cf095a202f3b", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Confirms an unconfirmed eSIM profile order and completes the order.\nOnce confirmed, an eSIM profile order cannot be canceled.\n" }, "response": [ { "id": "8f699b54-efd6-4786-9825-f64771a72a8b", "name": "The eSIM profile order has been confirmed.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "confirm" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"profileOrderId\": \"\",\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"status\": \"FAILED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-8f699b54-efd6-4786-9825-f64771a72a8b" }, { "id": "dc252eba-ab32-4eb1-acf1-d46b40da5f56", "name": "The eSIM profile order was not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "confirm" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-dc252eba-ab32-4eb1-acf1-d46b40da5f56" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-aa98fd44-94a4-4991-9a55-43503cabfd42" } ], "id": "cfd163e5-e891-46c5-91c0-defefe8e4b07", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-cfd163e5-e891-46c5-91c0-defefe8e4b07" }, { "name": "profiles", "item": [ { "name": "List eSIM profiles created by the eSIM profile order", "id": "e345b387-a090-4a3e-b9df-d21b730ed47c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/profiles", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "profiles" ], "variable": [ { "id": "a833a229-a4d8-47ab-9c43-b367e8353643", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Returns a list of eSIM profiles created by the specified eSIM profile order.\n" }, "response": [ { "id": "613b6301-b9e8-44ba-b649-b9a2b4b1b25d", "name": "Returned a list of eSIM profiles.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/profiles", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "profiles" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"profileOrderId\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\",\n \"activationCode\": \"\",\n \"profileStatus\": \"ACTIVATION_FAILED\",\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"installedTime\": \"\",\n \"subscription\": \"\"\n },\n {\n \"profileOrderId\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\",\n \"activationCode\": \"\",\n \"profileStatus\": \"INSTALLATION_FAILED\",\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"installedTime\": \"\",\n \"subscription\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-613b6301-b9e8-44ba-b649-b9a2b4b1b25d" }, { "id": "5b16774f-20b0-473b-ba87-7bf778ec8a5c", "name": "The eSIM profile order was not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id/profiles", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id", "profiles" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-5b16774f-20b0-473b-ba87-7bf778ec8a5c" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e345b387-a090-4a3e-b9df-d21b730ed47c" } ], "id": "9ef69826-df3d-4ccd-8603-16160aec0370", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-9ef69826-df3d-4ccd-8603-16160aec0370" }, { "name": "Cancel an eSIM profile order", "id": "ba2923ea-02b1-4a82-9a89-5fae617a7485", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "id": "08a20cbf-df83-47cf-b6a0-2d745941cf6b", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Cancels an unconfirmed eSIM profile order.\n" }, "response": [ { "id": "f12028d0-450d-4b4e-b2e0-70d4670a3268", "name": "eSIM profile order has been canceled.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f12028d0-450d-4b4e-b2e0-70d4670a3268" }, { "id": "c5d99ed7-9650-43e4-9c28-3359df262e15", "name": "The eSIM profile order was not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-c5d99ed7-9650-43e4-9c28-3359df262e15" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ba2923ea-02b1-4a82-9a89-5fae617a7485" }, { "name": "Get an eSIM profile order", "id": "106e2744-386d-495d-b671-daaf26723ea2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "id": "64168785-9fe9-41cf-acab-28d463b4f011", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Get an eSIM profile order.\n" }, "response": [ { "id": "7b17284f-0890-480a-a3fc-83e0e2156726", "name": "Returned the eSIM profile order.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"profileOrderId\": \"\",\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"status\": \"FAILED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7b17284f-0890-480a-a3fc-83e0e2156726" }, { "id": "1137c3c8-73de-40c1-9cec-845ff6ddd223", "name": "The eSIM profile order was not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders/:profile_order_id", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders", ":profile_order_id" ], "variable": [ { "key": "profile_order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-1137c3c8-73de-40c1-9cec-845ff6ddd223" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-106e2744-386d-495d-b671-daaf26723ea2" } ], "id": "4588c288-07e4-4045-9d18-7a7f0fc3afd2", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-4588c288-07e4-4045-9d18-7a7f0fc3afd2" }, { "name": "List eSIM profile orders", "id": "7bcc6ed8-873c-46f0-b386-19a5987cff34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders?limit=100&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders" ], "query": [ { "description": "Maximum number of eSIM profile orders to retrieve. However, the number of eSIM profile orders returned may be less than the specified value.", "key": "limit", "value": "100" }, { "description": "The ID of the last eSIM profile order retrieved on the previous page. By repeating the API call while specifying this parameter, the next page of eSIM profile orders will be returned.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of eSIM profile orders. If the total number of orders does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, "response": [ { "id": "e2715cc0-3e25-4314-b08d-18dc210ced3d", "name": "Returned a list of eSIM profile orders.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sim_profile_orders?limit=100&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders" ], "query": [ { "description": "Maximum number of eSIM profile orders to retrieve. However, the number of eSIM profile orders returned may be less than the specified value.", "key": "limit", "value": "100" }, { "description": "The ID of the last eSIM profile order retrieved on the previous page. By repeating the API call while specifying this parameter, the next page of eSIM profile orders will be returned.", "key": "last_evaluated_key", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"profileOrderId\": \"\",\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"status\": \"COMPLETED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n },\n {\n \"profileOrderId\": \"\",\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"status\": \"COMPLETED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-e2715cc0-3e25-4314-b08d-18dc210ced3d" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-7bcc6ed8-873c-46f0-b386-19a5987cff34" }, { "name": "Create a new eSIM profile order", "id": "d6dc4975-4fc2-4012-80e3-3d15a9d54ecd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"bundles\": [\n \"X3-5MB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.4xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sim_profile_orders", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders" ] }, "description": "Creates a new eSIM profile order without confirming it. An unconfirmed order is valid for 1 day, after which it is automatically canceled.\nUse the [SimProfileOrder:confirmProfileOrder API](#/SimProfileOrder/confirmProfileOrder) to confirm the order.\n" }, "response": [ { "id": "95dcb8d1-826c-4a3b-8924-ba6124bbcbaf", "name": "eSIM profile order has been created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"bundles\": [\n \"X3-5MB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.4xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sim_profile_orders", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"profileOrderId\": \"\",\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"status\": \"FAILED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-95dcb8d1-826c-4a3b-8924-ba6124bbcbaf" }, { "id": "9fc67f78-4f83-46c7-a71a-25a96c8f5e31", "name": "The request is invalid.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": \"\",\n \"quantity\": \"\",\n \"bundles\": [\n \"X3-5MB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.4xfast\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sim_profile_orders", "host": [ "{{baseUrl}}" ], "path": [ "sim_profile_orders" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-9fc67f78-4f83-46c7-a71a-25a96c8f5e31" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d6dc4975-4fc2-4012-80e3-3d15a9d54ecd" } ], "id": "b18dd2fe-5107-4333-b4e3-9752498ec7cd", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-b18dd2fe-5107-4333-b4e3-9752498ec7cd" }, { "name": "cell_locations", "item": [ { "name": "Get location information for a cell tower", "id": "f580f8a2-a7f0-4749-be2a-0d56256bd00f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cell_locations?mcc=&mnc=&lac=&cid=&tac=&ecid=&eci=", "host": [ "{{baseUrl}}" ], "path": [ "cell_locations" ], "query": [ { "description": "(Required) MCC - Mobile Country Code.", "key": "mcc", "value": "" }, { "description": "(Required) MNC - Mobile Network Code.", "key": "mnc", "value": "" }, { "description": "LAC - Location Area Code (for 3G).", "key": "lac", "value": "" }, { "description": "CID - Cell ID (for 3G).", "key": "cid", "value": "" }, { "description": "TAC - Tracking Area Code (for 4G).", "key": "tac", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "ecid", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "eci", "value": "" } ] }, "description": "Retrieves location information (latitude/longitude) for a cell tower based on cell information such as Cell ID.\n\n- For 3G, please specify MCC, MNC, LAC, and CID. It is possible to retrieve approximate location information without CID, but the accuracy will be low.\n\n 3G example\n ```\n $ curl -X GET \"https://api.soracom.io/v1/cell_locations?mcc=440&mnc=10&lac=196\" \\\n -H \"X-Soracom-API-Key: $X_SORACOM_API_KEY\" \\\n -H \"X-Soracom-Token: $X_SORACOM_TOKEN\"\n ```\n\n- For LTE (4G), please specify MCC, MNC, TAC, and ECID.\n\n 4G example\n ```\n $ curl -X GET \"https://api.soracom.io/v1/cell_locations?mcc=440&mnc=10&tac=5680&ecid=48872466\" \\\n -H \"X-Soracom-API-Key: $X_SORACOM_API_KEY\" \\\n -H \"X-Soracom-Token: $X_SORACOM_TOKEN\"\n ```\n\nThe conversion of cell tower information to location information uses the OpenCelliD Project database. The specified cell tower information is used to extract the corresponding location information from the OpenCelliD Project database, but it is possible that the location information may not exist or may be different from the actual location.\n\n[![Creative Commons License](/assets/images/ccbysa_4.0_80x15.png)](https://creativecommons.org/licenses/by-sa/4.0/ \"no-icon-external-link\") OpenCelliD Project is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License\n" }, "response": [ { "id": "d1619c31-5d23-491e-9bbb-cb4a98c97fbf", "name": "Location information for the cell tower.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/cell_locations?mcc=&mnc=&lac=&cid=&tac=&ecid=&eci=", "host": [ "{{baseUrl}}" ], "path": [ "cell_locations" ], "query": [ { "description": "(Required) MCC - Mobile Country Code.", "key": "mcc", "value": "" }, { "description": "(Required) MNC - Mobile Network Code.", "key": "mnc", "value": "" }, { "description": "LAC - Location Area Code (for 3G).", "key": "lac", "value": "" }, { "description": "CID - Cell ID (for 3G).", "key": "cid", "value": "" }, { "description": "TAC - Tracking Area Code (for 4G).", "key": "tac", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "ecid", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "eci", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"avg_strength\": \"\",\n \"created\": \"\",\n \"exact\": \"\",\n \"identifier\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"range\": \"\",\n \"samples\": \"\",\n \"updated\": \"\"\n}", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-d1619c31-5d23-491e-9bbb-cb4a98c97fbf" }, { "id": "38ed1872-5c52-4ed3-a463-9f039d017f0d", "name": "Location information is not found for the cell tower.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/cell_locations?mcc=&mnc=&lac=&cid=&tac=&ecid=&eci=", "host": [ "{{baseUrl}}" ], "path": [ "cell_locations" ], "query": [ { "description": "(Required) MCC - Mobile Country Code.", "key": "mcc", "value": "" }, { "description": "(Required) MNC - Mobile Network Code.", "key": "mnc", "value": "" }, { "description": "LAC - Location Area Code (for 3G).", "key": "lac", "value": "" }, { "description": "CID - Cell ID (for 3G).", "key": "cid", "value": "" }, { "description": "TAC - Tracking Area Code (for 4G).", "key": "tac", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "ecid", "value": "" }, { "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified.", "key": "eci", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-38ed1872-5c52-4ed3-a463-9f039d017f0d" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-f580f8a2-a7f0-4749-be2a-0d56256bd00f" }, { "name": "List location information for multiple cell towers.", "id": "94f010c2-3af3-4e19-b8d6-ff731811bc30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"cid\": \"\",\n \"eci\": \"\",\n \"ecid\": \"\",\n \"identifier\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tac\": \"\"\n },\n {\n \"cid\": \"\",\n \"eci\": \"\",\n \"ecid\": \"\",\n \"identifier\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tac\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cell_locations", "host": [ "{{baseUrl}}" ], "path": [ "cell_locations" ] }, "description": "Retrieves a list of location information (latitude/longitude) for multiple cell towers based on cell information such as Cell ID. For 3G, please specify MCC, MNC, LAC, and CID. It is possible to retrieve approximate location information without CID, but the accuracy will be low. For LTE (4G), please specify MCC, MNC, TAC, and ECID. The conversion of cell tower information to location information uses the OpenCelliD Project database, so it is possible that the information may not exist or may be incorrect.\n\n[![Creative Commons License](/assets/images/ccbysa_4.0_80x15.png)](https://creativecommons.org/licenses/by-sa/4.0/ \"no-icon-external-link\") OpenCelliD Project is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License\n" }, "response": [ { "id": "ae3dc413-9865-4e03-a01c-040f04d3643f", "name": "List of location information for the specified cell towers.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"cid\": \"\",\n \"eci\": \"\",\n \"ecid\": \"\",\n \"identifier\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tac\": \"\"\n },\n {\n \"cid\": \"\",\n \"eci\": \"\",\n \"ecid\": \"\",\n \"identifier\": \"\",\n \"lac\": \"\",\n \"mcc\": \"\",\n \"mnc\": \"\",\n \"tac\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cell_locations", "host": [ "{{baseUrl}}" ], "path": [ "cell_locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"avg_strength\": \"\",\n \"created\": \"\",\n \"exact\": \"\",\n \"identifier\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"range\": \"\",\n \"samples\": \"\",\n \"updated\": \"\"\n },\n {\n \"avg_strength\": \"\",\n \"created\": \"\",\n \"exact\": \"\",\n \"identifier\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"range\": \"\",\n \"samples\": \"\",\n \"updated\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-ae3dc413-9865-4e03-a01c-040f04d3643f" } ], "createdAt": "2026-06-05T15:18:16.000Z", "updatedAt": "2026-06-05T15:18:16.000Z", "uid": "35240-94f010c2-3af3-4e19-b8d6-ff731811bc30" } ], "id": "7ea01fe6-58ca-4e1e-8295-84799ac65781", "createdAt": "2026-06-05T15:18:15.000Z", "updatedAt": "2026-06-05T15:18:15.000Z", "uid": "35240-7ea01fe6-58ca-4e1e-8295-84799ac65781" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }