{ "info": { "_postman_id": "ef85c485-e8fb-4be9-b574-3da3f1357371", "name": "Soracom API", "description": "Soracom API v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:19:01.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "lastUpdatedBy": "35240", "uid": "35240-ef85c485-e8fb-4be9-b574-3da3f1357371" }, "item": [ { "name": "analysis", "item": [ { "name": "queries", "item": [ { "name": "{query_id}", "item": [ { "name": "Retrieve the execution status of a SQL query", "id": "7a7c4818-7898-4cd2-b07f-34da6de38b77", "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}}/analysis/queries/:query_id", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "queries", ":query_id" ], "variable": [ { "id": "09b5a7c5-7daf-46bc-ab11-6215573bcfb8", "key": "query_id", "value": "", "description": "(Required) SQL query ID." } ] }, "description": "Retrieve the execution status of a SQL query." }, "response": [ { "id": "f406cef1-b6dc-4962-8a6f-92febb05849a", "name": "The execution status, results, and download URL of the SQL query.", "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}}/analysis/queries/:query_id", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "queries", ":query_id" ], "variable": [ { "key": "query_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"columnInfo\": [\n {\n \"databaseType\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"databaseType\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"fileSize\": \"\",\n \"rowCount\": \"\",\n \"sqlExecTime\": \"\",\n \"sqlExportTime\": \"\",\n \"status\": \"COMPLETED\",\n \"uncompressedFileSize\": \"\",\n \"url\": \"\",\n \"usedExecCount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f406cef1-b6dc-4962-8a6f-92febb05849a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7a7c4818-7898-4cd2-b07f-34da6de38b77" } ], "id": "7c448ab5-5ed0-4a38-86e7-e2e9b2cabb41", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7c448ab5-5ed0-4a38-86e7-e2e9b2cabb41" }, { "name": "Execute a new SQL query asynchronously", "id": "98b2e070-1e9b-4a62-aec4-aef8d515adb5", "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 \"from\": \"\",\n \"sql\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/analysis/queries", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "queries" ] }, "description": "Executes a SQL query asynchronously. You can check the status of a SQL query execution with the [Analysis:getAnalysisQueries API](#/Analysis/getAnalysisQueries)." }, "response": [ { "id": "f6311e82-d446-4c38-aa21-ee00dda7ea8d", "name": "A new SQL query execution has started.", "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 \"from\": \"\",\n \"sql\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/analysis/queries", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "queries" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"queryId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f6311e82-d446-4c38-aa21-ee00dda7ea8d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-98b2e070-1e9b-4a62-aec4-aef8d515adb5" } ], "id": "87188d9d-6053-4dae-a1f3-0e31ffbfdf5a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-87188d9d-6053-4dae-a1f3-0e31ffbfdf5a" }, { "name": "schemas", "item": [ { "name": "Retrieve available database schemas", "id": "e951d770-8450-4c16-9eb9-910c58beea88", "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}}/analysis/schemas", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "schemas" ] }, "description": "Retrieves the available schemas and their column information within the database. You can use this information as a reference when converting data types of data retrieved with the [Analysis:startAnalysisQueries API](#/Analysis/startAnalysisQueries).\nExample: If the column `type` is `string` as shown below, it can be treated as a string.\n```json\n{\n \"name\": \"SIM_SESSION_EVENTS\",\n \"columnInfo\": [\n {\n \"name\": \"APN\",\n \"type\": \"string\",\n \"databaseType\": \"TEXT\",\n \"description\": \"Access Point Name indicating the network gateway for the SIM session.\"\n }\n ]\n}\n```\n" }, "response": [ { "id": "26b0a5ae-fc70-4312-9ea5-9b6fcbfb1371", "name": "A list of available database schemas and their column 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}}/analysis/schemas", "host": [ "{{baseUrl}}" ], "path": [ "analysis", "schemas" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"columnInfo\": [\n {\n \"databaseType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"databaseType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"name\": \"\"\n },\n {\n \"columnInfo\": [\n {\n \"databaseType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"databaseType\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"name\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-26b0a5ae-fc70-4312-9ea5-9b6fcbfb1371" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e951d770-8450-4c16-9eb9-910c58beea88" } ], "id": "bc55fe81-55cd-46a2-aac9-f62daf918051", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bc55fe81-55cd-46a2-aac9-f62daf918051" } ], "id": "6d4722a6-4c23-4588-996c-5cbbf49b77a8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6d4722a6-4c23-4588-996c-5cbbf49b77a8" }, { "name": "audit_logs", "item": [ { "name": "api", "item": [ { "name": "Retrieve audit logs for Soracom API calls", "id": "b6c11cfe-0bc6-4f01-b578-f91729b4e0f2", "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}}/audit_logs/api?api_kind=&from_epoch_ms=&to_epoch_ms=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "audit_logs", "api" ], "query": [ { "description": "Filter item for audit log retrieval by API kind (e.g. `/v1/auth`).", "key": "api_kind", "value": "" }, { "description": "Start time for the log search range (unixtime milliseconds).", "key": "from_epoch_ms", "value": "" }, { "description": "End time for the log search range (unixtime milliseconds).", "key": "to_epoch_ms", "value": "" }, { "description": "Maximum number of log entries to retrieve (value range is 1 to 1000).", "key": "limit", "value": "" }, { "description": "The value of `requestedTimeEpochMs` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Retrieve audit logs for Soracom API calls." }, "response": [ { "id": "1c4a0a9f-10e7-437e-8da4-993a03ff6258", "name": "A list of Soracom API audit log 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}}/audit_logs/api?api_kind=&from_epoch_ms=&to_epoch_ms=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "audit_logs", "api" ], "query": [ { "description": "Filter item for audit log retrieval by API kind (e.g. `/v1/auth`).", "key": "api_kind", "value": "" }, { "description": "Start time for the log search range (unixtime milliseconds).", "key": "from_epoch_ms", "value": "" }, { "description": "End time for the log search range (unixtime milliseconds).", "key": "to_epoch_ms", "value": "" }, { "description": "Maximum number of log entries to retrieve (value range is 1 to 1000).", "key": "limit", "value": "" }, { "description": "The value of `requestedTimeEpochMs` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page 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 \"apiKind\": \"\",\n \"operatorId\": \"\",\n \"remoteIpAddress\": \"\",\n \"requestPath\": \"\",\n \"requestedTimeEpochMs\": \"\",\n \"userName\": \"\"\n },\n {\n \"apiKind\": \"\",\n \"operatorId\": \"\",\n \"remoteIpAddress\": \"\",\n \"requestPath\": \"\",\n \"requestedTimeEpochMs\": \"\",\n \"userName\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c4a0a9f-10e7-437e-8da4-993a03ff6258" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b6c11cfe-0bc6-4f01-b578-f91729b4e0f2" } ], "id": "5df21d3c-de03-426c-9b98-c0a1b1ba0116", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5df21d3c-de03-426c-9b98-c0a1b1ba0116" }, { "name": "napter", "item": [ { "name": "Retrieve audit logs for Soracom Napter", "id": "e1af9e8f-7831-4ce4-ae1e-9cc7aa681f73", "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}}/audit_logs/napter?resource_type=Subscriber&resource_id=&from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "audit_logs", "napter" ], "query": [ { "description": "Type of the target resource to query log entries.", "key": "resource_type", "value": "Subscriber" }, { "description": "Identity of the target resource to query log entries.", "key": "resource_id", "value": "" }, { "description": "Start time for the log search range (unixtime milliseconds).", "key": "from", "value": "" }, { "description": "End time for the log search range (unixtime milliseconds).", "key": "to", "value": "" }, { "description": "Maximum number of log entries to retrieve (value range is 1 to 1000).", "key": "limit", "value": "" }, { "description": "The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Retrieve audit logs for Soracom Napter." }, "response": [ { "id": "7c453f89-ff7c-48f1-963f-d0f669675e82", "name": "A list of Napter audit log 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}}/audit_logs/napter?resource_type=Subscriber&resource_id=&from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "audit_logs", "napter" ], "query": [ { "description": "Type of the target resource to query log entries.", "key": "resource_type", "value": "Subscriber" }, { "description": "Identity of the target resource to query log entries.", "key": "resource_id", "value": "" }, { "description": "Start time for the log search range (unixtime milliseconds).", "key": "from", "value": "" }, { "description": "End time for the log search range (unixtime milliseconds).", "key": "to", "value": "" }, { "description": "Maximum number of log entries to retrieve (value range is 1 to 1000).", "key": "limit", "value": "" }, { "description": "The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page 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 \"connectionId\": \"\",\n \"createdAt\": \"\",\n \"direction\": {\n \"destinationIPAddress\": \"\",\n \"destinationPort\": \"\",\n \"sourceIPAddress\": \"\",\n \"sourcePort\": \"\"\n },\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"tls\": \"\",\n \"type\": \"CONNECTED\"\n },\n {\n \"connectionId\": \"\",\n \"createdAt\": \"\",\n \"direction\": {\n \"destinationIPAddress\": \"\",\n \"destinationPort\": \"\",\n \"sourceIPAddress\": \"\",\n \"sourcePort\": \"\"\n },\n \"imsi\": \"\",\n \"operatorId\": \"\",\n \"tls\": \"\",\n \"type\": \"REFUSED\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7c453f89-ff7c-48f1-963f-d0f669675e82" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e1af9e8f-7831-4ce4-ae1e-9cc7aa681f73" } ], "id": "2a4fde18-cdc7-46c5-a75f-4b52f9734e57", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a4fde18-cdc7-46c5-a75f-4b52f9734e57" } ], "id": "608d6ea6-fda0-473e-b222-f5e8e9ddec91", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-608d6ea6-fda0-473e-b222-f5e8e9ddec91" }, { "name": "auth", "item": [ { "name": "logout", "item": [ { "name": "Revokes an API key and API token in order to remove access to the Soracom API.", "id": "67b2afdb-d1d1-4781-8cd5-1baa1cd88161", "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}}/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "auth", "logout" ] }, "description": "Revokes the API key and API token that was used to call this API. Once revoked, the API key and API token cannot be used to make further requests to the API, regardless of the key and token's original expiration time. This API can be called regardless of any permission settings." }, "response": [ { "id": "f394b29e-a3ee-49f7-9b49-60c7519dfe69", "name": "Successfully revoked the API key and the API token.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "auth", "logout" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f394b29e-a3ee-49f7-9b49-60c7519dfe69" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-67b2afdb-d1d1-4781-8cd5-1baa1cd88161" } ], "id": "e38e103e-6feb-4c1c-be63-d20297c1c679", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e38e103e-6feb-4c1c-be63-d20297c1c679" }, { "name": "password_reset_token", "item": [ { "name": "issue", "item": [ { "name": "Issues a password reset token for the operator.", "id": "13da30dd-7270-4be8-83ff-5a78493b7ed9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] }, "description": "Generates a password reset token and sends it to the operator's primary email address. After receiving the password reset token, call /v1/auth/password_reset_token/verify API with the token to update the operator's password." }, "response": [ { "id": "c67becde-8f5d-4014-a695-6c0bdd37bedb", "name": "Password reset token successfully sent to the specified email address.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c67becde-8f5d-4014-a695-6c0bdd37bedb" }, { "id": "49603c5c-c743-4a62-87b1-ccbdd8142bce", "name": "Invalid email address.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-49603c5c-c743-4a62-87b1-ccbdd8142bce" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-13da30dd-7270-4be8-83ff-5a78493b7ed9" } ], "id": "8dfa5405-fa9d-480e-897f-b22b9df6a58f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8dfa5405-fa9d-480e-897f-b22b9df6a58f" }, { "name": "verify", "item": [ { "name": "Verifies the password reset token and updates password.", "id": "f7c60b9d-e35e-438b-b40a-84eecb1fc8c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] }, "description": "Updates the operator's password if the password reset token is verified." }, "response": [ { "id": "94f0af1c-ea82-4bb8-87fb-4e4c491f6322", "name": "Password successfully updated.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-94f0af1c-ea82-4bb8-87fb-4e4c491f6322" }, { "id": "4b1278eb-e09b-49b7-a79b-e33511a0d613", "name": "Invalid token.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4b1278eb-e09b-49b7-a79b-e33511a0d613" }, { "id": "0361370c-0776-45c3-8f7d-0c6f186443ac", "name": "Token expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/password_reset_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "password_reset_token", "verify" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0361370c-0776-45c3-8f7d-0c6f186443ac" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f7c60b9d-e35e-438b-b40a-84eecb1fc8c0" } ], "id": "c4b8284d-523d-4087-b162-2d468e0c451c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c4b8284d-523d-4087-b162-2d468e0c451c" } ], "id": "d816da34-01cd-4b83-8540-7a3ee34cae4e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d816da34-01cd-4b83-8540-7a3ee34cae4e" }, { "name": "switch_user", "item": [ { "name": "Generates an API key and an API token to call APIs as a different user.", "id": "e02ad9de-2525-4a93-bcb7-207aafe19236", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] }, "description": "Using the API key and API token of the original user, call this API to issue an API key and API token of the target user that you are switching to. The original user should already be registered in the target user's trust policy. See [User:updateUserTrustPolicy](#!/User/updateUserTrustPolicy) for information on updating the trust policy." }, "response": [ { "id": "dc986687-d46f-4114-aeb4-7a8dc7e87353", "name": "Authentication successful.", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiKey\": \"\",\n \"operatorId\": \"\",\n \"token\": \"\",\n \"userName\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc986687-d46f-4114-aeb4-7a8dc7e87353" }, { "id": "10bcfdc2-0a09-4265-8448-449c3cde201d", "name": "Switch user not allowed.", "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 \"operatorId\": \"\",\n \"tokenTimeoutSeconds\": 3600,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth/switch_user", "host": [ "{{baseUrl}}" ], "path": [ "auth", "switch_user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-10bcfdc2-0a09-4265-8448-449c3cde201d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e02ad9de-2525-4a93-bcb7-207aafe19236" } ], "id": "8e3ece0a-d8f9-40b8-aeaf-6b7d5e7c4112", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8e3ece0a-d8f9-40b8-aeaf-6b7d5e7c4112" }, { "name": "Performs authentication to access to the Soracom API.", "id": "3c037526-64e2-427e-a5f4-0720d7a9bc56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] }, "description": "Performs authentication to access to the Soracom API. Please include the following information in your request.\n\n- To perform authentication by a root account, specify `email` and `password`.\n- To perform authentication by an AuthKey, specify `authKeyId` and `authKey`.\n- To perform authentication by a SAM user, specify `operatorId`, `userName` and `password`.\n\nAn API key and API token will be included in the response if successful. Use the API key and API token to perform subsequent requests.\n" }, "response": [ { "id": "193c7b41-8718-453b-a47b-3d5a55020bad", "name": "Authentication successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"apiKey\": \"\",\n \"operatorId\": \"\",\n \"token\": \"\",\n \"userName\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-193c7b41-8718-453b-a47b-3d5a55020bad" }, { "id": "51d73258-709f-4410-bde3-1a41b53d03f2", "name": "Authentication failed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\",\n \"email\": \"\",\n \"mfaOTPCode\": \"\",\n \"operatorId\": \"\",\n \"password\": \"\",\n \"tokenTimeoutSeconds\": 86400,\n \"userName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth", "host": [ "{{baseUrl}}" ], "path": [ "auth" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-51d73258-709f-4410-bde3-1a41b53d03f2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3c037526-64e2-427e-a5f4-0720d7a9bc56" } ], "id": "5950b4b1-5cac-49d6-b5fd-b897d78000b3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5950b4b1-5cac-49d6-b5fd-b897d78000b3" }, { "name": "batch_groups", "item": [ { "name": "{batch_group_id}", "item": [ { "name": "jobs", "item": [ { "name": "{job_id}", "item": [ { "name": "tasks", "item": [ { "name": "List tasks.", "id": "6e8fd626-d494-45da-a464-b3671b1572b2", "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}}/batch_groups/:batch_group_id/jobs/:job_id/tasks?limit=&status=success&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id", "tasks" ], "query": [ { "description": "Maximum number of tasks to retrieve. The number of tasks returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "Filter by task status.", "key": "status", "value": "success" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of tasks.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "1c25749c-7c33-40bb-9cc5-7510958244d0", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." }, { "id": "a5e25f4b-d933-4650-89fb-8327546038a5", "key": "job_id", "value": "", "description": "(Required) Batch job ID." } ] }, "description": "Returns a list of tasks in the specified batch job. Each task represents an individual API operation executed as part of the batch job.\n" }, "response": [ { "id": "2a07d3e8-1401-48b3-982b-21eddd8b733a", "name": "A list of batch tasks was retrieved successfully.", "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}}/batch_groups/:batch_group_id/jobs/:job_id/tasks?limit=&status=success&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id", "tasks" ], "query": [ { "description": "Maximum number of tasks to retrieve. The number of tasks returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "Filter by task status.", "key": "status", "value": "success" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of tasks.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "batch_group_id" }, { "key": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"finishedTime\": \"\",\n \"request\": {\n \"path\": \"\",\n \"method\": \"DELETE\",\n \"body\": {}\n },\n \"response\": {\n \"body\": {},\n \"statusCode\": \"\"\n },\n \"startedTime\": \"\",\n \"status\": \"pending\",\n \"taskId\": \"\"\n },\n {\n \"finishedTime\": \"\",\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n },\n \"response\": {\n \"body\": {},\n \"statusCode\": \"\"\n },\n \"startedTime\": \"\",\n \"status\": \"success\",\n \"taskId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a07d3e8-1401-48b3-982b-21eddd8b733a" }, { "id": "a07b684a-c236-4738-98f8-b9f824c21981", "name": "Batch job not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs/:job_id/tasks?limit=&status=success&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id", "tasks" ], "query": [ { "description": "Maximum number of tasks to retrieve. The number of tasks returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "Filter by task status.", "key": "status", "value": "success" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of tasks.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "batch_group_id" }, { "key": "job_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a07b684a-c236-4738-98f8-b9f824c21981" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6e8fd626-d494-45da-a464-b3671b1572b2" } ], "id": "75cb1364-8272-4a46-b049-4be954207358", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-75cb1364-8272-4a46-b049-4be954207358" }, { "name": "Get batch job.", "id": "b46bbaed-065e-42e0-84bd-50897f122a8d", "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}}/batch_groups/:batch_group_id/jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id" ], "variable": [ { "id": "99c1852b-6b34-4b05-9b17-02c654d2da11", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." }, { "id": "509d29f6-399f-425c-82fa-8eb8e22be0f8", "key": "job_id", "value": "", "description": "(Required) Batch job ID." } ] }, "description": "Returns information about the specified batch job.\n" }, "response": [ { "id": "a4e99e09-e687-4dda-a509-c8ef7018edc3", "name": "The batch job was found.", "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}}/batch_groups/:batch_group_id/jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id" ], "variable": [ { "key": "batch_group_id" }, { "key": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"abortOnFailure\": \"\",\n \"batchGroupId\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"errorMessage\": \"\",\n \"finishedTime\": \"\",\n \"jobId\": \"\",\n \"jobName\": \"\",\n \"status\": \"aborted\",\n \"summary\": {\n \"error\": \"\",\n \"pending\": \"\",\n \"success\": \"\"\n },\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a4e99e09-e687-4dda-a509-c8ef7018edc3" }, { "id": "8e1cb13c-2452-4029-9dad-022c9340794b", "name": "Batch job not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs", ":job_id" ], "variable": [ { "key": "batch_group_id" }, { "key": "job_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8e1cb13c-2452-4029-9dad-022c9340794b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b46bbaed-065e-42e0-84bd-50897f122a8d" } ], "id": "76dba131-fa33-4601-b54f-10c8db6eef69", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-76dba131-fa33-4601-b54f-10c8db6eef69" }, { "name": "List batch jobs.", "id": "fb8ad195-9872-4d21-ad9b-47d39ba59a77", "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}}/batch_groups/:batch_group_id/jobs?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "query": [ { "description": "Maximum number of batch jobs to retrieve. The number of batch jobs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch jobs.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "263ad872-f213-4d4a-b7b1-9edecb1384c6", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." } ] }, "description": "Returns a list of batch jobs in the specified batch group." }, "response": [ { "id": "d22c81cb-d105-4682-94a6-e724ccb0f249", "name": "A list of batch jobs was retrieved successfully.", "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}}/batch_groups/:batch_group_id/jobs?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "query": [ { "description": "Maximum number of batch jobs to retrieve. The number of batch jobs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch jobs.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"abortOnFailure\": \"\",\n \"batchGroupId\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"errorMessage\": \"\",\n \"finishedTime\": \"\",\n \"jobId\": \"\",\n \"jobName\": \"\",\n \"status\": \"aborted\",\n \"summary\": {\n \"error\": \"\",\n \"pending\": \"\",\n \"success\": \"\"\n },\n \"updatedTime\": \"\"\n },\n {\n \"abortOnFailure\": \"\",\n \"batchGroupId\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"errorMessage\": \"\",\n \"finishedTime\": \"\",\n \"jobId\": \"\",\n \"jobName\": \"\",\n \"status\": \"pending\",\n \"summary\": {\n \"error\": \"\",\n \"pending\": \"\",\n \"success\": \"\"\n },\n \"updatedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d22c81cb-d105-4682-94a6-e724ccb0f249" }, { "id": "7b2eff01-87d0-40e6-a91d-8041be8e9f62", "name": "Batch group not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "query": [ { "description": "Maximum number of batch jobs to retrieve. The number of batch jobs returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch jobs.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b2eff01-87d0-40e6-a91d-8041be8e9f62" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fb8ad195-9872-4d21-ad9b-47d39ba59a77" }, { "name": "Create and run batch job.", "id": "57fa4df5-bfcf-411c-aa2c-22675281cde7", "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 \"tasks\": [\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n }\n },\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"POST\",\n \"body\": {}\n }\n }\n ],\n \"abortOnFailure\": \"\",\n \"description\": \"\",\n \"jobName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "variable": [ { "id": "53be0060-5667-4cea-bc5a-fb49fe228ae6", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." } ] }, "description": "Create a new batch job and run it. A batch job consists of multiple tasks, each representing an API operation to be performed. Tasks are executed using the permissions of the user that created the batch job API. Batch job information is retained for 32 days.\n\n**System Limits:**\n\n- Each batch job is limited to a single API action. Mixing different APIs in the same job is not supported.\n- Each batch job is limited to a maximum of 10,000 tasks.\n- Only one batch job per API action can be created and processed at a time.\n- Batch jobs may be delayed or restricted if system load is high. If this occurs, please wait and try again later.\n" }, "response": [ { "id": "d350d397-8663-421b-b6fd-a109c0a79c44", "name": "The batch job has been created and execution has started.", "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 \"tasks\": [\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n }\n },\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"POST\",\n \"body\": {}\n }\n }\n ],\n \"abortOnFailure\": \"\",\n \"description\": \"\",\n \"jobName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"abortOnFailure\": \"\",\n \"batchGroupId\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"errorMessage\": \"\",\n \"finishedTime\": \"\",\n \"jobId\": \"\",\n \"jobName\": \"\",\n \"status\": \"aborted\",\n \"summary\": {\n \"error\": \"\",\n \"pending\": \"\",\n \"success\": \"\"\n },\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d350d397-8663-421b-b6fd-a109c0a79c44" }, { "id": "e92e1b48-94ee-419f-883b-dda2f54b5cfe", "name": "Bad request. This error can occur in the following cases:\n- Attempting to mix different APIs in a single batch job\n- Already running a batch job with the same API for this operator\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 \"tasks\": [\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n }\n },\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"POST\",\n \"body\": {}\n }\n }\n ],\n \"abortOnFailure\": \"\",\n \"description\": \"\",\n \"jobName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e92e1b48-94ee-419f-883b-dda2f54b5cfe" }, { "id": "07c9d8ef-9394-461a-9812-dd96e44b2318", "name": "Batch group not 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 \"tasks\": [\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n }\n },\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"POST\",\n \"body\": {}\n }\n }\n ],\n \"abortOnFailure\": \"\",\n \"description\": \"\",\n \"jobName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-07c9d8ef-9394-461a-9812-dd96e44b2318" }, { "id": "6c26bb15-8cba-442f-8fbf-ff96ef0c5e25", "name": "Batch job execution is restricted due to high system load.", "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 \"tasks\": [\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"GET\",\n \"body\": {}\n }\n },\n {\n \"request\": {\n \"path\": \"\",\n \"method\": \"POST\",\n \"body\": {}\n }\n }\n ],\n \"abortOnFailure\": \"\",\n \"description\": \"\",\n \"jobName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id", "jobs" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6c26bb15-8cba-442f-8fbf-ff96ef0c5e25" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-57fa4df5-bfcf-411c-aa2c-22675281cde7" } ], "id": "46447f39-2e20-4ad8-a61f-7324a2894932", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-46447f39-2e20-4ad8-a61f-7324a2894932" }, { "name": "Delete batch group.", "id": "0a5f571f-4333-4722-8da5-46750edbeca2", "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}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "id": "b712c6cd-2f62-4cdb-8139-e52361d0209d", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." } ] }, "description": "Delete the specified batch group. Batch groups can only be deleted if there are no running batch jobs in the group.\n" }, "response": [ { "id": "ec1f82ca-e703-440c-95f3-304cb45ecd07", "name": "The batch group has been deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ec1f82ca-e703-440c-95f3-304cb45ecd07" }, { "id": "92dffafd-309b-4e73-a130-97242fa4c35c", "name": "The batch group cannot be deleted because there are running batch jobs.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-92dffafd-309b-4e73-a130-97242fa4c35c" }, { "id": "18f9c335-3a2e-4408-98f5-05c301a65df9", "name": "Batch group not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-18f9c335-3a2e-4408-98f5-05c301a65df9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0a5f571f-4333-4722-8da5-46750edbeca2" }, { "name": "Get batch group.", "id": "f01b7fa6-fb13-4e4b-a866-b5bd73f4c667", "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}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "id": "b7dc7f25-00e0-4d81-8002-208edf19b4c7", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." } ] }, "description": "Returns details of the specified batch group.\n" }, "response": [ { "id": "3da37540-6cc1-4b3c-944c-cc326d97c41e", "name": "The batch group was found.", "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}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchGroupId\": \"\",\n \"batchGroupName\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3da37540-6cc1-4b3c-944c-cc326d97c41e" }, { "id": "2ac921ed-6225-4b73-b989-ddab39810556", "name": "Batch group not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2ac921ed-6225-4b73-b989-ddab39810556" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f01b7fa6-fb13-4e4b-a866-b5bd73f4c667" }, { "name": "Update batch group.", "id": "74195ada-e116-4738-8d8d-18266e86cec5", "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 \"batchGroupName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "id": "61b9b91d-deb1-4dbe-9b19-8df241d24897", "key": "batch_group_id", "value": "", "description": "(Required) Batch group ID." } ] }, "description": "Updates the name or description of the specified batch group.\n" }, "response": [ { "id": "f0312fcc-a548-4205-9d90-f649193c0b28", "name": "The batch group was updated.", "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 \"batchGroupName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchGroupId\": \"\",\n \"batchGroupName\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f0312fcc-a548-4205-9d90-f649193c0b28" }, { "id": "7c3fc96c-901a-452c-af53-0673b08f16c2", "name": "Batch group not 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 \"batchGroupName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups/:batch_group_id", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups", ":batch_group_id" ], "variable": [ { "key": "batch_group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7c3fc96c-901a-452c-af53-0673b08f16c2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-74195ada-e116-4738-8d8d-18266e86cec5" } ], "id": "a6fa2ffb-8e27-4f12-b31b-43b677603caf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a6fa2ffb-8e27-4f12-b31b-43b677603caf" }, { "name": "List batch groups.", "id": "1038d101-57de-49f2-909a-4841bcbe64cd", "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}}/batch_groups?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups" ], "query": [ { "description": "Maximum number of batch groups to retrieve. The number of batch groups returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch groups.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of batch groups." }, "response": [ { "id": "ac5c6285-10be-4356-810e-fd3008e10863", "name": "A list of batch groups was retrieved successfully.", "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}}/batch_groups?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups" ], "query": [ { "description": "Maximum number of batch groups to retrieve. The number of batch groups returned may be less than the specified value.", "key": "limit", "value": "" }, { "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch groups.", "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 \"batchGroupId\": \"\",\n \"batchGroupName\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n },\n {\n \"batchGroupId\": \"\",\n \"batchGroupName\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ac5c6285-10be-4356-810e-fd3008e10863" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1038d101-57de-49f2-909a-4841bcbe64cd" }, { "name": "Create batch group.", "id": "622ea248-9ce5-44ec-a60a-15043467746d", "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 \"batchGroupName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups" ] }, "description": "Create a new batch group for organizing and managing batch jobs. To create a batch job, use the [Batch:createBatchJob](#/Batch/createBatchJob) instead.\n" }, "response": [ { "id": "5966574d-132c-4cd0-9ad0-ecddbf18058c", "name": "The batch group 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 \"batchGroupName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/batch_groups", "host": [ "{{baseUrl}}" ], "path": [ "batch_groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchGroupId\": \"\",\n \"batchGroupName\": \"\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5966574d-132c-4cd0-9ad0-ecddbf18058c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-622ea248-9ce5-44ec-a60a-15043467746d" } ], "id": "657289f3-75b7-4d0c-8d8d-926f742156a4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-657289f3-75b7-4d0c-8d8d-926f742156a4" }, { "name": "bills", "item": [ { "name": "{yyyyMM}", "item": [ { "name": "daily", "item": [ { "name": "Get a daily bill", "id": "2a5b4537-0db6-40fd-9f48-dd886d5f74fe", "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}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "id": "d165e0f2-815e-44f7-bd14-4f768ff59a7e", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. If you specify current month (a month for which the fee has not yet been finalized), a preliminary value will be returned.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "8f849345-4370-4a67-866f-5e07e37af572", "name": "Daily billing information for the specified month.", "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}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"billList\": [\n {\n \"amount\": \"\",\n \"currency\": \"EUR\",\n \"date\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"date\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8f849345-4370-4a67-866f-5e07e37af572" }, { "id": "fb01c612-5464-4bda-9c09-aef1a869e700", "name": "Bill not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fb01c612-5464-4bda-9c09-aef1a869e700" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a5b4537-0db6-40fd-9f48-dd886d5f74fe" } ], "id": "a96d3a5d-8302-493f-b81a-8394c421043b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a96d3a5d-8302-493f-b81a-8394c421043b" }, { "name": "export", "item": [ { "name": "Export historical Detailed billing CSV to dedicated storage", "id": "a3f2a280-0819-4e1b-89d8-e255c017c7e4", "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}}/bills/:yyyyMM/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "0ab891d3-02b9-4dc8-bbfe-80dceaa9b859", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Export historical [Detailed billing CSV](/en/docs/account/billing/#detailed-billing-csv) to dedicated storage and issue URL to download.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "b69fada6-91ab-4db2-a16b-8975b39f9c02", "name": "Export process successfully initiated. Contains the download URL or export ID.", "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}}/bills/:yyyyMM/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "yyyyMM" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b69fada6-91ab-4db2-a16b-8975b39f9c02" }, { "id": "06e533b3-d538-4ab1-9c7e-a9bff5d5fb5e", "name": "Bill not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-06e533b3-d538-4ab1-9c7e-a9bff5d5fb5e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a3f2a280-0819-4e1b-89d8-e255c017c7e4" } ], "id": "85b19b5c-fcdc-44f9-951d-1ca9ec2eb739", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-85b19b5c-fcdc-44f9-951d-1ca9ec2eb739" }, { "name": "Gets a finalized past billing history for the specified month", "id": "94baa9f6-41d9-4f24-a834-bc6b611b5bcb", "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}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "id": "5b1476e6-1614-4255-85ea-f7d387e204d6", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Gets a finalized past billing history for the specified month. If you specify current month (the month in which the usage fee has not yet been finalized), you will get the preliminary value.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "8c0b2520-ce32-4ca9-950d-0f7ace54b982", "name": "The billing history for the specified month.", "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}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"JPY\",\n \"paymentStatus\": \"paid\",\n \"paymentTransactionId\": \"\",\n \"state\": \"closed\",\n \"yearMonth\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8c0b2520-ce32-4ca9-950d-0f7ace54b982" }, { "id": "78a0249f-ed16-40d8-a5cc-809f742dec18", "name": "- The billing history for the specified month has not been finalized.\n- There is no charge for the specified month.\n", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-78a0249f-ed16-40d8-a5cc-809f742dec18" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-94baa9f6-41d9-4f24-a834-bc6b611b5bcb" } ], "id": "0d1281e7-c99f-45e9-90a6-db1cae0ad6b6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0d1281e7-c99f-45e9-90a6-db1cae0ad6b6" }, { "name": "latest", "item": [ { "name": "export", "item": [ { "name": "Export latest billing CSV file to S3", "id": "b06d0cbd-268f-4faa-9324-89d15c90da84", "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}}/bills/latest/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ] }, "description": "Export [Detailed Billing CSV](/en/docs/account/billing/#detailed-billing-csv) for current month (the month in which the usage fee has not yet been finalized) to dedicated storage and issue a URL to download it. The fees will be finalized by the second business day of the following month. The Detailed billing CSV exported using this API will output preliminary values." }, "response": [ { "id": "88b51da9-5b12-4ef5-bd0d-f84ba25bf061", "name": "Export process successfully initiated. Contains the download URL or export ID.", "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}}/bills/latest/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-88b51da9-5b12-4ef5-bd0d-f84ba25bf061" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b06d0cbd-268f-4faa-9324-89d15c90da84" } ], "id": "b64da577-cfa2-4f13-86aa-b606714bd61a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b64da577-cfa2-4f13-86aa-b606714bd61a" }, { "name": "Get latest bill", "id": "c1e0a50b-805d-4a59-b08e-1a6ae4265a76", "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}}/bills/latest", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest" ] }, "description": "Retrieves the preliminary usage fee for the current month (the month in which the usage fee has not yet been finalized)." }, "response": [ { "id": "86a6371e-3b51-449c-8344-8abb4ebdf7c2", "name": "The latest billing information for the current month.", "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}}/bills/latest", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"currency\": \"EUR\",\n \"lastEvaluatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-86a6371e-3b51-449c-8344-8abb4ebdf7c2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c1e0a50b-805d-4a59-b08e-1a6ae4265a76" } ], "id": "5d739cce-698b-4106-a168-2eaeb8c8e3ac", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5d739cce-698b-4106-a168-2eaeb8c8e3ac" }, { "name": "summaries", "item": [ { "name": "bill_items", "item": [ { "name": "Gets a billing summary of bill items.", "id": "9337eebd-4ee5-46da-a27b-36dd98ef4706", "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}}/bills/summaries/bill_items", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "bill_items" ] }, "description": "Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you can get from this API is equivalent to the usage fees displayed in the [COSTS BY SERVICE] panel of the Billing Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" }, "response": [ { "id": "e372e3f0-dce9-4cc7-8a23-1b3af1bc3e51", "name": "A billing summary of bill items for the last 4 months.", "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}}/bills/summaries/bill_items", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "bill_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n },\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n }\n ],\n \"currency\": \"JPY\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n },\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n },\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n }\n ],\n \"currency\": \"JPY\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e372e3f0-dce9-4cc7-8a23-1b3af1bc3e51" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9337eebd-4ee5-46da-a27b-36dd98ef4706" } ], "id": "69ee25a4-8ad2-47f8-a56a-4ea6f2114eee", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-69ee25a4-8ad2-47f8-a56a-4ea6f2114eee" }, { "name": "sims", "item": [ { "name": "Gets a billing summary of SIMs", "id": "f6d0ffc5-f760-4ef9-b0cc-632f9c4a7462", "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}}/bills/summaries/sims", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "sims" ] }, "description": "Get a billing summary of SIMs for the last 4 months (current month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you get from this API is equivalent to the rates displayed in the [COSTS PER SIM (TOP 100)] panel of the Rates Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" }, "response": [ { "id": "af8188ff-32b9-48e1-8cc7-43ae7f8ee0d2", "name": "A billing summary of SIMs for the last 4 months.", "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}}/bills/summaries/sims", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "sims" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"simId\": \"\"\n },\n {\n \"amount\": \"\",\n \"simId\": \"\"\n }\n ],\n \"currency\": \"USD\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n },\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"simId\": \"\"\n },\n {\n \"amount\": \"\",\n \"simId\": \"\"\n }\n ],\n \"currency\": \"USD\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af8188ff-32b9-48e1-8cc7-43ae7f8ee0d2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6d0ffc5-f760-4ef9-b0cc-632f9c4a7462" } ], "id": "d1e5ad9d-234e-4458-a6f3-6c60133c1120", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d1e5ad9d-234e-4458-a6f3-6c60133c1120" } ], "id": "7a42e30c-1f7c-4259-8b75-b1bf558a7851", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7a42e30c-1f7c-4259-8b75-b1bf558a7851" }, { "name": "Gets a list of finalized past billing history", "id": "2b5abf9a-9596-49c9-8913-b401156ea012", "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}}/bills", "host": [ "{{baseUrl}}" ], "path": [ "bills" ] }, "description": "Gets a list of finalized past billing history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "fe8b3c34-f412-42d2-870e-ea035d02405c", "name": "A list of finalized past billing history.", "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}}/bills", "host": [ "{{baseUrl}}" ], "path": [ "bills" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"billList\": [\n {\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"EUR\",\n \"paymentStatus\": \"refund_fail\",\n \"paymentTransactionId\": \"\",\n \"state\": \"temporary\",\n \"yearMonth\": \"\"\n },\n {\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"EUR\",\n \"paymentStatus\": \"refund_fail\",\n \"paymentTransactionId\": \"\",\n \"state\": \"closed\",\n \"yearMonth\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fe8b3c34-f412-42d2-870e-ea035d02405c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2b5abf9a-9596-49c9-8913-b401156ea012" } ], "id": "4f0e8421-fb08-42a8-a8dd-1215ab33df36", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4f0e8421-fb08-42a8-a8dd-1215ab33df36" }, { "name": "cell_locations", "item": [ { "name": "Get location information for a cell tower", "id": "2a0ec4f0-1048-449f-9fdf-b0061521271a", "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": "70d7613b-44b1-4374-9ef0-05d1a5df67a6", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-70d7613b-44b1-4374-9ef0-05d1a5df67a6" }, { "id": "3885019c-404d-4bd4-8377-a91413ae65de", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3885019c-404d-4bd4-8377-a91413ae65de" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a0ec4f0-1048-449f-9fdf-b0061521271a" }, { "name": "List location information for multiple cell towers.", "id": "9f14ceeb-ca19-4a05-9690-94e4ae5a13fd", "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": "53a3b085-96b0-48cc-a31f-fd8c18f8e13b", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-53a3b085-96b0-48cc-a31f-fd8c18f8e13b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9f14ceeb-ca19-4a05-9690-94e4ae5a13fd" } ], "id": "710fb748-098b-4183-8775-f06ff9c2e79e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-710fb748-098b-4183-8775-f06ff9c2e79e" }, { "name": "coupons", "item": [ { "name": "{coupon_code}", "item": [ { "name": "register", "item": [ { "name": "Register Coupon", "id": "05585da8-6339-4489-be68-5d004dec6d54", "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}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "id": "965e8e83-2003-402f-9c06-383428c78620", "key": "coupon_code", "value": "", "description": "(Required) Coupon code." } ] }, "description": "Registers a coupon." }, "response": [ { "id": "40648b98-f44e-49aa-b268-ecd670edfe76", "name": "OK.", "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}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "key": "coupon_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"EUR\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-40648b98-f44e-49aa-b268-ecd670edfe76" }, { "id": "1bf55c44-35b9-4686-958c-e0bd43a42e05", "name": "The coupon code is invalid or the coupon code registration limit has been reached.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "key": "coupon_code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1bf55c44-35b9-4686-958c-e0bd43a42e05" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-05585da8-6339-4489-be68-5d004dec6d54" } ], "id": "9f777552-c77b-44f6-9fc4-47ac56ded8d2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9f777552-c77b-44f6-9fc4-47ac56ded8d2" } ], "id": "07dc935b-1ffd-4d2a-bbe7-45e5042d3bea", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-07dc935b-1ffd-4d2a-bbe7-45e5042d3bea" }, { "name": "{order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm coupon order", "id": "ca53a096-d3b6-41bf-9ebe-6713b104dda8", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/coupons/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":order_id", "confirm" ], "variable": [ { "id": "ed62505b-21a1-4676-a352-95e810b55faf", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:createCouponQuotation API](#/Order/createCouponQuotation)." } ] }, "description": "Performs a credit limit and confirms the order if no problems are encountered." }, "response": [ { "id": "ab355ced-7791-4463-8550-ccffb6819c71", "name": "The confirmed coupon order.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"EUR\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ab355ced-7791-4463-8550-ccffb6819c71" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ca53a096-d3b6-41bf-9ebe-6713b104dda8" } ], "id": "f75942b6-e9f4-477c-a7d3-444b9748e82f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f75942b6-e9f4-477c-a7d3-444b9748e82f" } ], "id": "0996c78a-2416-4a13-b6fc-b94a2f588238", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0996c78a-2416-4a13-b6fc-b94a2f588238" }, { "name": "List coupons.", "id": "bb04b0af-0b05-49cd-a3ae-8d3fb18661ac", "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}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "Returns a list of currently registered coupons." }, "response": [ { "id": "80eec311-9259-4b8f-8f95-f6865bab0214", "name": "OK.", "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}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"couponList\": [\n {\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"USD\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n },\n {\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"JPY\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-80eec311-9259-4b8f-8f95-f6865bab0214" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bb04b0af-0b05-49cd-a3ae-8d3fb18661ac" }, { "name": "Create coupon quotation", "id": "783e7cc8-1734-44cb-ae21-f062af8ee728", "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 \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "Creates a new coupon quotation. If the orderId is put in /coupons/{order_id}/confirm, the order is complete." }, "response": [ { "id": "d9587674-bcb7-4b18-b6f2-e923d4b8c4ac", "name": "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 \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"currency\": \"JPY\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\",\n \"taxAmount\": \"\",\n \"totalAmount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d9587674-bcb7-4b18-b6f2-e923d4b8c4ac" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-783e7cc8-1734-44cb-ae21-f062af8ee728" } ], "id": "7aadb233-697f-4694-a30d-8b11ac7860f1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7aadb233-697f-4694-a30d-8b11ac7860f1" }, { "name": "credentials", "item": [ { "name": "{credentials_id}", "item": [ { "name": "Delete a credential set", "id": "5c60ff0f-f22f-4265-b556-d82ead6477f3", "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}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "id": "006c6633-c9a8-4743-8187-376bfe47f815", "key": "credentials_id", "value": "", "description": "(Required) Credential set ID." } ] }, "description": "Deletes a credential set." }, "response": [ { "id": "6b4273d2-8d83-4c39-ad62-9cce3e2ea18b", "name": "Credential set has been deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "key": "credentials_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6b4273d2-8d83-4c39-ad62-9cce3e2ea18b" }, { "id": "bf5f641e-e7d1-4cf6-aff9-cebece55f794", "name": "Not Found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "key": "credentials_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bf5f641e-e7d1-4cf6-aff9-cebece55f794" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c60ff0f-f22f-4265-b556-d82ead6477f3" }, { "name": "Create a credential set", "id": "178e8f7f-3c73-4f6d-a681-2d515ad93dd9", "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 \"credentials\": {},\n \"description\": \"\",\n \"type\": \"psk\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "id": "488be508-58d6-4079-80fe-a798a7451eff", "key": "credentials_id", "value": "", "description": "(Required) Credential set ID." } ] }, "description": "Creates a new credential set." }, "response": [ { "id": "aafebc47-d928-46b7-b036-18b309df2322", "name": "Credential set 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 \"credentials\": {},\n \"description\": \"\",\n \"type\": \"psk\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "key": "credentials_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDateTime\": \"\",\n \"credentials\": {},\n \"credentialsId\": \"\",\n \"lastUsedDateTime\": \"\",\n \"type\": \"azureIoT-credentials\",\n \"updateDateTime\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aafebc47-d928-46b7-b036-18b309df2322" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-178e8f7f-3c73-4f6d-a681-2d515ad93dd9" }, { "name": "Update a credential set", "id": "68cae137-49c7-4f09-84f1-6557e378bf45", "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 \"credentials\": {},\n \"description\": \"\",\n \"type\": \"psk\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "id": "2b451c91-4330-46e7-9e94-07a05f3a0f52", "key": "credentials_id", "value": "", "description": "(Required) Credential set ID." } ] }, "description": "Updates a credential set." }, "response": [ { "id": "b1b349f0-ce48-40cd-b97e-d6d0e89f3a94", "name": "OK.", "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 \"credentials\": {},\n \"description\": \"\",\n \"type\": \"psk\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "key": "credentials_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDateTime\": \"\",\n \"credentials\": {},\n \"credentialsId\": \"\",\n \"lastUsedDateTime\": \"\",\n \"type\": \"azureIoT-credentials\",\n \"updateDateTime\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b1b349f0-ce48-40cd-b97e-d6d0e89f3a94" }, { "id": "ffe8eaf0-b321-4426-8f26-2f7b00286785", "name": "There was an error in the request or the specified token has already expired. (In the latter case, you will need to use the /auth API to do authentication once again.)", "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 \"credentials\": {},\n \"description\": \"\",\n \"type\": \"psk\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials/:credentials_id", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentials_id" ], "variable": [ { "key": "credentials_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ffe8eaf0-b321-4426-8f26-2f7b00286785" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-68cae137-49c7-4f09-84f1-6557e378bf45" } ], "id": "78b0d4a1-fb2c-4d01-9486-d35981535ced", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-78b0d4a1-fb2c-4d01-9486-d35981535ced" }, { "name": "List credential sets", "id": "5108b193-7eb5-45aa-bc3e-a0457129afb2", "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}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] }, "description": "Returns a list of credential sets." }, "response": [ { "id": "e3e2588e-41f9-49f7-9172-0809cf4160b3", "name": "OK.", "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}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createDateTime\": \"\",\n \"credentials\": {},\n \"credentialsId\": \"\",\n \"lastUsedDateTime\": \"\",\n \"type\": \"pubnub-credentials\",\n \"updateDateTime\": \"\",\n \"description\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"credentials\": {},\n \"credentialsId\": \"\",\n \"lastUsedDateTime\": \"\",\n \"type\": \"optim-cloud-IoT-OS-credentials\",\n \"updateDateTime\": \"\",\n \"description\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e3e2588e-41f9-49f7-9172-0809cf4160b3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5108b193-7eb5-45aa-bc3e-a0457129afb2" } ], "id": "afc46afb-f537-44f5-b166-905c62ee1409", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-afc46afb-f537-44f5-b166-905c62ee1409" }, { "name": "data", "item": [ { "name": "{resource_type}", "item": [ { "name": "{resource_id}", "item": [ { "name": "{time}", "item": [ { "name": "Deletes a data entry", "id": "3d9a3b37-644a-4b97-a0bc-d7b4540df8bd", "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}}/data/:resource_type/:resource_id/:time", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id", ":time" ], "variable": [ { "id": "f7527d91-452d-4a65-9ed6-0f7537be411d", "key": "resource_type", "value": "Device", "description": "(Required) Type of data source resource." }, { "id": "a90d8e5c-003d-4528-a4c0-b7cdbb99a362", "key": "resource_id", "value": "", "description": "(Required) ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" }, { "id": "f2df51c6-03a9-44ef-9c30-44df8f81ace1", "key": "time", "value": "", "description": "(Required) Timestamp of the target data entry to delete (UNIX time in milliseconds)." } ] }, "description": "Deletes a data entry identified with resource ID and timestamp" }, "response": [ { "id": "a197da3e-53c5-4e4e-ba07-ce055b9e4b9d", "name": "The data entry has been successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/data/:resource_type/:resource_id/:time", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id", ":time" ], "variable": [ { "key": "resource_type" }, { "key": "resource_id" }, { "key": "time" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a197da3e-53c5-4e4e-ba07-ce055b9e4b9d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3d9a3b37-644a-4b97-a0bc-d7b4540df8bd" }, { "name": "Gets a data entry", "id": "e346b16b-1b08-4b1c-9612-6661b02221d2", "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}}/data/:resource_type/:resource_id/:time", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id", ":time" ], "variable": [ { "id": "59a6613c-7ef4-48cb-9455-dec17e1614e7", "key": "resource_type", "value": "Device", "description": "(Required) Type of data source resource." }, { "id": "9a6c3e3d-c003-409f-b37d-e6ea1158b711", "key": "resource_id", "value": "", "description": "(Required) ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" }, { "id": "51b7e71e-b30e-42c8-822d-101a66b2c6c5", "key": "time", "value": "", "description": "(Required) Timestamp of the target data entry to get (UNIX time in milliseconds)." } ] }, "description": "Gets a data entry identified with resource ID and timestamp" }, "response": [ { "id": "6a8d5987-c705-4390-a7e4-c77abee0b361", "name": "The data entry specified with resource ID and timestamp", "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}}/data/:resource_type/:resource_id/:time", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id", ":time" ], "variable": [ { "key": "resource_type" }, { "key": "resource_id" }, { "key": "time" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6a8d5987-c705-4390-a7e4-c77abee0b361" }, { "id": "b87bdbc1-800e-4735-a327-80045270a773", "name": "No such entry found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/data/:resource_type/:resource_id/:time", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id", ":time" ], "variable": [ { "key": "resource_type" }, { "key": "resource_id" }, { "key": "time" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b87bdbc1-800e-4735-a327-80045270a773" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e346b16b-1b08-4b1c-9612-6661b02221d2" } ], "id": "819bb1af-32b3-45ec-99a2-cb7a9cac51f1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-819bb1af-32b3-45ec-99a2-cb7a9cac51f1" }, { "name": "Get data sent to Harvest Data from a resource.", "id": "66b7f778-3fba-4245-af4a-fae24a24e36f", "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}}/data/:resource_type/:resource_id?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id" ], "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": "530c2359-c720-41e3-b6b4-c0a36d6b3719", "key": "resource_type", "value": "Device", "description": "(Required) Type of data source resource." }, { "id": "8246f2b3-9d47-4477-8ebf-8c0c3000c643", "key": "resource_id", "value": "", "description": "(Required) ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" } ] }, "description": "Returns a list of data entries sent to Harvest Data from a device that match certain criteria. If the total number of 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": "f3d755fb-4f01-4015-8899-fed84c848732", "name": "A list of data entries sent to Harvest Data from the specified resource.", "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}}/data/:resource_type/:resource_id?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", ":resource_type", ":resource_id" ], "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": "resource_type" }, { "key": "resource_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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f3d755fb-4f01-4015-8899-fed84c848732" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-66b7f778-3fba-4245-af4a-fae24a24e36f" } ], "id": "445fd6c8-2a2f-45d6-a460-b01558ca114d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-445fd6c8-2a2f-45d6-a460-b01558ca114d" } ], "id": "7b7139d6-1d5a-4229-b3ab-70c5d1d58781", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7b7139d6-1d5a-4229-b3ab-70c5d1d58781" }, { "name": "categories", "item": [ { "name": "{category}", "item": [ { "name": "Get data entries for a specific category", "id": "f36bdd8e-a801-44ef-a57b-897fddb3db84", "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}}/data/categories/:category?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "categories", ":category" ], "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": "934a30ba-c3a6-434f-9c91-13dff6425c11", "key": "category", "value": "", "description": "(Required) Name of the category to filter data entries." } ] }, "description": "Returns a list of data entries that belong to a specific category. If the total number of 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": "4775c669-dc68-47f6-add1-61cea1b6f7a7", "name": "A list of data entries belonging to the specified category.", "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}}/data/categories/:category?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "categories", ":category" ], "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": "category" } ] } }, "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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4775c669-dc68-47f6-add1-61cea1b6f7a7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f36bdd8e-a801-44ef-a57b-897fddb3db84" } ], "id": "247712f8-15eb-484b-b091-80181cb02926", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-247712f8-15eb-484b-b091-80181cb02926" } ], "id": "f8f21704-5eed-4911-b746-9cfc34d19066", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f8f21704-5eed-4911-b746-9cfc34d19066" }, { "name": "metadata", "item": [ { "name": "resources", "item": [ { "name": "Get the list of data source resources", "id": "2a9eff8a-12e2-4cd1-916f-4922b9d03833", "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}}/data/metadata/resources?resource_type=Device&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "metadata", "resources" ], "query": [ { "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n", "key": "resource_type", "value": "Device" }, { "description": "Maximum number of data entries to retrieve.", "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 data source resources that have sent data. If the total number of data source resources 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": "f54304eb-5446-4c5a-a3ce-33cd37f3780a", "name": "A list of data source resources that have sent data to Harvest Data.", "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}}/data/metadata/resources?resource_type=Device&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "metadata", "resources" ], "query": [ { "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n", "key": "resource_type", "value": "Device" }, { "description": "Maximum number of data entries to retrieve.", "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 \"attributeNames\": [\n \"\",\n \"\"\n ],\n \"lastModifiedTime\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"\"\n },\n {\n \"attributeNames\": [\n \"\",\n \"\"\n ],\n \"lastModifiedTime\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f54304eb-5446-4c5a-a3ce-33cd37f3780a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a9eff8a-12e2-4cd1-916f-4922b9d03833" } ], "id": "edd71f7d-ef47-43d5-852d-b908e6f84b84", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-edd71f7d-ef47-43d5-852d-b908e6f84b84" } ], "id": "882ab7f1-8c60-4ca1-9655-15eaec50373c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-882ab7f1-8c60-4ca1-9655-15eaec50373c" }, { "name": "resources", "item": [ { "name": "Get the list of data source resources", "id": "6338910d-a1a6-453a-a40e-e1581711d2e9", "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}}/data/resources?resource_type=Device&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "resources" ], "query": [ { "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n", "key": "resource_type", "value": "Device" }, { "description": "Maximum number of data entries to retrieve.", "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 data source resources that have sent data. If the total number of data source resources 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": "1a53de1c-ec10-4554-a0b9-c406fc1bd214", "name": "A list of data source resources that have sent data to Harvest Data.", "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}}/data/resources?resource_type=Device&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "data", "resources" ], "query": [ { "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n", "key": "resource_type", "value": "Device" }, { "description": "Maximum number of data entries to retrieve.", "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 \"attributeNames\": [\n \"\",\n \"\"\n ],\n \"lastModifiedTime\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"\"\n },\n {\n \"attributeNames\": [\n \"\",\n \"\"\n ],\n \"lastModifiedTime\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1a53de1c-ec10-4554-a0b9-c406fc1bd214" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6338910d-a1a6-453a-a40e-e1581711d2e9" } ], "id": "79198345-3fb0-4f2b-b855-1f50008fda0d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-79198345-3fb0-4f2b-b855-1f50008fda0d" } ], "id": "be4078e8-8ba8-4d06-9cee-1fbb5107a9d4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-be4078e8-8ba8-4d06-9cee-1fbb5107a9d4" }, { "name": "device_object_models", "item": [ { "name": "{model_id}", "item": [ { "name": "set_scope", "item": [ { "name": "Sets scope for a device object model", "id": "96a29d6a-74fd-40db-9a62-a08617191519", "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 \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id/set_scope", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id", "set_scope" ], "variable": [ { "id": "acfe5d49-f12b-4617-a79b-415c6f062dea", "key": "model_id", "value": "", "description": "(Required) Target device object model ID" } ] }, "description": "Sets scope for a device object model" }, "response": [ { "id": "38d03067-35db-42c6-af3b-dbe122872973", "name": "Scope is set to the target device object model", "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 \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id/set_scope", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id", "set_scope" ], "variable": [ { "key": "model_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-38d03067-35db-42c6-af3b-dbe122872973" }, { "id": "d7361514-3de5-47cb-a275-0532ea2c76e2", "name": "No such device object model 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 \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id/set_scope", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id", "set_scope" ], "variable": [ { "key": "model_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d7361514-3de5-47cb-a275-0532ea2c76e2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-96a29d6a-74fd-40db-9a62-a08617191519" } ], "id": "21a0ecd9-3e61-49d1-a4a2-4f0ffaf0c5ed", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-21a0ecd9-3e61-49d1-a4a2-4f0ffaf0c5ed" }, { "name": "Deletes a device object model", "id": "22959a7d-3877-4c9a-83ec-521f165852d0", "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}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "id": "e9777a53-7456-409d-8618-f005acb69efa", "key": "model_id", "value": "", "description": "(Required) Target device object model ID" } ] }, "description": "Deletes a device object model" }, "response": [ { "id": "2aa0ac15-5ddf-4bb5-b3e3-6fe6237dcb52", "name": "Successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2aa0ac15-5ddf-4bb5-b3e3-6fe6237dcb52" }, { "id": "4177fe4f-e17f-49c9-9518-4daee358f66f", "name": "No such device object model found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4177fe4f-e17f-49c9-9518-4daee358f66f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-22959a7d-3877-4c9a-83ec-521f165852d0" }, { "name": "Gets a device object model", "id": "40fea9c8-dfe2-448c-b3f5-16de22859f71", "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}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "id": "549ef5c5-40c3-483c-a568-d8bb5cad5740", "key": "model_id", "value": "", "description": "(Required) Target device object model ID" } ] }, "description": "Gets a device object model" }, "response": [ { "id": "bb470ef1-ba2f-496a-9ceb-2d54fe5054b1", "name": "Device object model", "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}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bb470ef1-ba2f-496a-9ceb-2d54fe5054b1" }, { "id": "035093e4-85cc-41ed-ac78-0713a92cda48", "name": "No such device object model found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-035093e4-85cc-41ed-ac78-0713a92cda48" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-40fea9c8-dfe2-448c-b3f5-16de22859f71" }, { "name": "Updates a device object model", "id": "5c476111-6276-47e7-bc9a-89a11b0c34e7", "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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "id": "f599b5f0-ae01-44b7-b407-851c94582d36", "key": "model_id", "value": "", "description": "(Required) Target device object model ID" } ] }, "description": "Updates a device object model" }, "response": [ { "id": "3569b9a2-1bb7-4490-b5a0-e515b3b6f0cd", "name": "Device object model updated", "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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3569b9a2-1bb7-4490-b5a0-e515b3b6f0cd" }, { "id": "a376e959-1d00-4a7a-8cc3-1256cf8e2773", "name": "Failed to parse device object model definition", "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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a376e959-1d00-4a7a-8cc3-1256cf8e2773" }, { "id": "605f49d6-9a24-40c3-804e-d45fbef9c4dd", "name": "No such device object model 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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models/:model_id", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models", ":model_id" ], "variable": [ { "key": "model_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-605f49d6-9a24-40c3-804e-d45fbef9c4dd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c476111-6276-47e7-bc9a-89a11b0c34e7" } ], "id": "da63001a-5a03-4048-9dd4-80247b5b39ad", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-da63001a-5a03-4048-9dd4-80247b5b39ad" }, { "name": "Returns a list of device object models", "id": "5b4d08c4-7f75-436f-a82b-230007d63615", "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}}/device_object_models?last_evaluated_key=&limit=-1", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models" ], "query": [ { "description": "ID of the last device object model in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device object models onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of device object models in a response", "key": "limit", "value": "-1" } ] }, "description": "Returns a list of device object models" }, "response": [ { "id": "e442f375-30b5-4c95-834e-14e8527a8557", "name": "List of device object models", "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}}/device_object_models?last_evaluated_key=&limit=-1", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models" ], "query": [ { "description": "ID of the last device object model in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device object models onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of device object models in a response", "key": "limit", "value": "-1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e442f375-30b5-4c95-834e-14e8527a8557" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5b4d08c4-7f75-436f-a82b-230007d63615" }, { "name": "Creates a new device object model", "id": "fb10501c-69e1-4dd2-aaa2-633eeab3822f", "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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models" ] }, "description": "Creates a new device object model" }, "response": [ { "id": "e14aba79-a81a-4b85-be53-33e36554e544", "name": "Device object model 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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e14aba79-a81a-4b85-be53-33e36554e544" }, { "id": "7bb2ecb7-865b-4b5b-980e-146613dc6481", "name": "Failed to parse device object model definition", "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 \"createdTime\": \"\",\n \"format\": \"xml\",\n \"lastModifiedTime\": \"\",\n \"objectId\": \"\",\n \"objectName\": \"\",\n \"operatorId\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/device_object_models", "host": [ "{{baseUrl}}" ], "path": [ "device_object_models" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7bb2ecb7-865b-4b5b-980e-146613dc6481" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fb10501c-69e1-4dd2-aaa2-633eeab3822f" } ], "id": "774c0818-fc66-4a1f-9e6c-9a6b7927b673", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-774c0818-fc66-4a1f-9e6c-9a6b7927b673" }, { "name": "devices", "item": [ { "name": "{device_id}", "item": [ { "name": "{object}", "item": [ { "name": "{instance}", "item": [ { "name": "{resource}", "item": [ { "name": "execute", "item": [ { "name": "Executes a resource of a device", "id": "e4f9fc11-875d-435b-9992-6f1c7ea6b0d0", "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" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/execute", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "execute" ], "variable": [ { "id": "1e089ea3-f270-4298-9e64-894d3139f4db", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "66eea34b-cf9b-41ad-bc7b-2989ad4563e9", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "68624407-1fa8-4f00-b291-8c04db4fc66c", "key": "instance", "value": "", "description": "(Required) Instance ID" }, { "id": "4bd8ac70-77c4-4e46-9030-7ee2613c4827", "key": "resource", "value": "", "description": "(Required) Resource ID" } ] }, "description": "Executes a resource of a device" }, "response": [ { "id": "e8b611ad-93cc-42f2-b468-402059a8f864", "name": "Execution request is accepted", "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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/execute", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "execute" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e8b611ad-93cc-42f2-b468-402059a8f864" }, { "id": "a3d669fa-9323-4b98-abb7-ddc8450fd423", "name": "Resource is not executable (including cases of connection errors such as device offline)", "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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/execute", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "execute" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a3d669fa-9323-4b98-abb7-ddc8450fd423" }, { "id": "886976b1-6efa-4c96-a37f-af8757068d06", "name": "Resource is not 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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/execute", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "execute" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-886976b1-6efa-4c96-a37f-af8757068d06" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e4f9fc11-875d-435b-9992-6f1c7ea6b0d0" } ], "id": "78d8a80d-a98c-4121-a4ad-7023ce850180", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-78d8a80d-a98c-4121-a4ad-7023ce850180" }, { "name": "observe", "item": [ { "name": "Triggers observation of the specified resource of a device", "id": "28b0ea0f-3319-481b-8e54-3a08ea2c07f8", "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}}/devices/:device_id/:object/:instance/:resource/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "id": "7314bb87-2091-4c68-8d10-cdc9338e516b", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "b02036ab-0256-40ff-ad10-770ac3669391", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "7cb8d304-3bb0-4238-beb0-d245408f4368", "key": "instance", "value": "", "description": "(Required) Instance ID" }, { "id": "a40a480e-00f2-4563-9b44-52dc13168cc4", "key": "resource", "value": "", "description": "(Required) Resource ID" } ] }, "description": "Triggers observation of the specified resource of a device. Once observation is started, the server will be notified when there is a change in value on the device side." }, "response": [ { "id": "6c9aba86-a2f2-44fa-8770-cbc6fc50807f", "name": "Observation started.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6c9aba86-a2f2-44fa-8770-cbc6fc50807f" }, { "id": "8c4e411b-c196-47a1-a593-3ccc7f49d370", "name": "Resource is not readable (including cases of connection errors such as device offline).", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8c4e411b-c196-47a1-a593-3ccc7f49d370" }, { "id": "3d5fd9db-20e4-4faa-b24a-f777dc55d174", "name": "Resource is not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3d5fd9db-20e4-4faa-b24a-f777dc55d174" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-28b0ea0f-3319-481b-8e54-3a08ea2c07f8" } ], "id": "5e02de67-db8c-4228-8710-9c6f78bac3e8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5e02de67-db8c-4228-8710-9c6f78bac3e8" }, { "name": "unobserve", "item": [ { "name": "Stops observation of a resource of a device", "id": "352d5499-af9b-4065-b26b-c288a0c19e39", "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}}/devices/:device_id/:object/:instance/:resource/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "unobserve" ], "variable": [ { "id": "17b4c685-4f11-4405-83b2-468ed74de02d", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "7830480b-6559-408d-8da4-602be9b3e95d", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "ea330f81-1ca6-40c1-8962-e60021ba7d21", "key": "instance", "value": "", "description": "(Required) Instance ID" }, { "id": "3c0553ff-22cf-4c08-a8b3-54ba6a653b54", "key": "resource", "value": "", "description": "(Required) Resource ID" } ] }, "description": "Stops observation of a resource of a device" }, "response": [ { "id": "87d6010a-da18-4eb3-87a7-f2bb2355c073", "name": "Observation cancelled", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "unobserve" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-87d6010a-da18-4eb3-87a7-f2bb2355c073" }, { "id": "9148dabf-ef68-46af-9c67-21e3f86f7723", "name": "Resource is not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource", "unobserve" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9148dabf-ef68-46af-9c67-21e3f86f7723" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-352d5499-af9b-4065-b26b-c288a0c19e39" } ], "id": "8aad8873-be71-4d6f-998a-7855f0d2b870", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8aad8873-be71-4d6f-998a-7855f0d2b870" }, { "name": "Get the specified resource of a device", "id": "5d825eea-40b7-433e-96e1-ae697751eedf", "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}}/devices/:device_id/:object/:instance/:resource?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "id": "bb333e2d-b7ad-4dee-883d-198de95808e7", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "7c8fc739-d89d-441f-a323-dfc7f895a2ca", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "a27ca898-1af5-40cf-81d2-5b182ecb22a9", "key": "instance", "value": "", "description": "(Required) Instance ID" }, { "id": "2942b75c-b2c8-468d-bccf-97e7a34a4d94", "key": "resource", "value": "", "description": "(Required) Resource ID" } ] }, "description": "Get the specified resource of a device" }, "response": [ { "id": "54909bc1-7b7a-407a-a329-a31475b3aabd", "name": "Resource", "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}}/devices/:device_id/:object/:instance/:resource?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"description\": \"\",\n \"id\": \"\",\n \"mandatory\": false,\n \"multiple\": false,\n \"name\": \"\",\n \"observed\": false,\n \"operations\": \"NONE\",\n \"rangeEnumeration\": \"\",\n \"type\": \"TIME\",\n \"units\": \"\",\n \"value\": {},\n \"values\": {}\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-54909bc1-7b7a-407a-a329-a31475b3aabd" }, { "id": "184c928b-8281-451f-90a5-4468ee7fe62b", "name": "Resource is not readable (including cases of connection errors such as device offline).", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-184c928b-8281-451f-90a5-4468ee7fe62b" }, { "id": "2410f793-d267-48d5-bb13-350343d64fb9", "name": "Resource is not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2410f793-d267-48d5-bb13-350343d64fb9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5d825eea-40b7-433e-96e1-ae697751eedf" }, { "name": "Write value to a resource of a device", "id": "ad8e5e00-add6-4dd7-83ba-9656578365bd", "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" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "variable": [ { "id": "41de245f-4291-4615-8edb-74c2dd7c893a", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "666cefaf-b429-4143-8170-f3f446e0b05e", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "2e0a9bc3-2e3a-492a-b169-7cbbad621a84", "key": "instance", "value": "", "description": "(Required) Instance ID" }, { "id": "9f86a468-456c-41bf-9a14-6ebe495fcc89", "key": "resource", "value": "", "description": "(Required) Resource ID" } ] }, "description": "Write value to a resource of a device" }, "response": [ { "id": "e0ec86da-909f-4a21-8155-64850ab04e6b", "name": "Updating resource is accepted", "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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e0ec86da-909f-4a21-8155-64850ab04e6b" }, { "id": "845612ec-b380-4f27-a7a1-cf89cab05d52", "name": "Specified Resource does not support write (Including case of connection error such as offline device)", "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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-845612ec-b380-4f27-a7a1-cf89cab05d52" }, { "id": "b2a6d90f-c76e-4b08-9dc5-697a34591b5b", "name": "Resource is not 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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b2a6d90f-c76e-4b08-9dc5-697a34591b5b" }, { "id": "99794e02-69a9-490c-8433-3ea2cd863e4d", "name": "Error response from the device. (It includes the case where the LwM2M response message is error from the device. The error message from the device is included in the response 'message'. )", "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 \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/:resource", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", ":resource" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" }, { "key": "resource" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-99794e02-69a9-490c-8433-3ea2cd863e4d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ad8e5e00-add6-4dd7-83ba-9656578365bd" } ], "id": "d838664f-7978-47c3-aa21-3fa57802549c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d838664f-7978-47c3-aa21-3fa57802549c" }, { "name": "observe", "item": [ { "name": "Triggers observation of resources under an object instance of a device", "id": "ecbdd665-f2fb-49d3-852f-7dec02e3eee1", "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}}/devices/:device_id/:object/:instance/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "id": "5a433226-0b3a-46b3-9aa2-ad15dcb5cd2b", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "e8a81b78-df93-4396-9871-89bf17538e46", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "93741d7b-66f6-4333-89c8-6bfbd4db8a9d", "key": "instance", "value": "", "description": "(Required) Instance ID" } ] }, "description": "Triggers observation of resources under an object instance of a device" }, "response": [ { "id": "fb66fe99-ce71-44d1-af89-f9e4da27500f", "name": "Observation started.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fb66fe99-ce71-44d1-af89-f9e4da27500f" }, { "id": "40aed70c-99b3-4a4b-9ddd-17036fb11934", "name": "Resource is not readable (including cases of connection errors such as device offline).", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-40aed70c-99b3-4a4b-9ddd-17036fb11934" }, { "id": "5d304b28-a1fa-447e-a4bc-670ae74cafc6", "name": "Resource is not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/observe?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "observe" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5d304b28-a1fa-447e-a4bc-670ae74cafc6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ecbdd665-f2fb-49d3-852f-7dec02e3eee1" } ], "id": "2c7d839f-bcb4-4667-8eeb-2589544fb254", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2c7d839f-bcb4-4667-8eeb-2589544fb254" }, { "name": "unobserve", "item": [ { "name": "Stops observation of resources under an object instance of a device", "id": "07bb131e-047f-47d9-9e46-8144bb7ab68d", "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}}/devices/:device_id/:object/:instance/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "unobserve" ], "variable": [ { "id": "5cc844e0-f8d3-4778-a62f-c44f7bddee82", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "a7bdbe81-fb1e-4fd5-8b27-773050b14eab", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "3ab1bcc0-137c-470f-9d5a-733eb1f677a0", "key": "instance", "value": "", "description": "(Required) Instance ID" } ] }, "description": "Stops observation of resources under an object instance of a device" }, "response": [ { "id": "ebdef5aa-c8b2-400f-b16f-30f54bb38762", "name": "Observation cancelled", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "unobserve" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ebdef5aa-c8b2-400f-b16f-30f54bb38762" }, { "id": "d1c630b5-1898-4eaf-936b-c45ffa9e4a80", "name": "Resource is not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance/unobserve", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance", "unobserve" ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d1c630b5-1898-4eaf-936b-c45ffa9e4a80" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-07bb131e-047f-47d9-9e46-8144bb7ab68d" } ], "id": "42651909-7cba-4c39-b21c-b720ebeb21fa", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-42651909-7cba-4c39-b21c-b720ebeb21fa" }, { "name": "Get resources under an object instance of a device", "id": "8e0f0f71-2768-46ca-92fb-3ae4de31333b", "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}}/devices/:device_id/:object/:instance?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "id": "e64a9400-88ae-4026-9d40-b21f58b8e186", "key": "device_id", "value": "", "description": "(Required) Target device" }, { "id": "e6a4db1e-2668-4201-b3d4-82a5c6ef8897", "key": "object", "value": "", "description": "(Required) Object ID" }, { "id": "18bd0c40-953b-4525-b671-226ae5c50a35", "key": "instance", "value": "", "description": "(Required) Instance ID" } ] }, "description": "Get resources under an object instance of a device" }, "response": [ { "id": "f275f5eb-14df-4100-8a10-f02c60f348cc", "name": "Resources under the specified object instance", "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}}/devices/:device_id/:object/:instance?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"observed\": false,\n \"resources\": {\n \"aliqua8d\": {\n \"description\": \"\",\n \"id\": \"\",\n \"mandatory\": false,\n \"multiple\": false,\n \"name\": \"\",\n \"observed\": false,\n \"operations\": \"NONE\",\n \"rangeEnumeration\": \"\",\n \"type\": \"FLOAT\",\n \"units\": \"\",\n \"value\": {},\n \"values\": {}\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f275f5eb-14df-4100-8a10-f02c60f348cc" }, { "id": "d093015d-6e13-4101-9924-67490f639f5d", "name": "Object instance is not readable (including cases of connection errors such as device offline).", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d093015d-6e13-4101-9924-67490f639f5d" }, { "id": "83a5417d-90c1-44c9-89e1-b6ea533b30a5", "name": "Object instance is not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/:object/:instance?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", ":object", ":instance" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" }, { "key": "object" }, { "key": "instance" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-83a5417d-90c1-44c9-89e1-b6ea533b30a5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8e0f0f71-2768-46ca-92fb-3ae4de31333b" } ], "id": "668f6566-b9b0-415e-84db-4e83e4f0596b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-668f6566-b9b0-415e-84db-4e83e4f0596b" } ], "id": "f1f34708-7290-40c3-8ce7-2517eebe7a91", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f1f34708-7290-40c3-8ce7-2517eebe7a91" }, { "name": "data", "item": [ { "name": "Retrieves data sent from an Inventory device to Harvest Data", "id": "5824f50a-882c-4720-95fc-ccbb768859b7", "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}}/devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "21125860-9d9c-47b5-9492-eb6f6980b5ed", "key": "device_id", "value": "", "description": "(Required) ID of the Inventory device from which to retrieve data. The ID of an Inventory device can be obtained using the [Device:listDevices API](#!/Device/listDevices)." } ] }, "description": "Retrieves data that matches the specified conditions from the data sent by the specified Inventory device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, "response": [ { "id": "32f2a4a5-d00a-4603-9856-87fa39e1471f", "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}}/devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "device_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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-32f2a4a5-d00a-4603-9856-87fa39e1471f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5824f50a-882c-4720-95fc-ccbb768859b7" } ], "id": "872aa37f-5a59-415a-a1bd-4cb0b4d164a1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-872aa37f-5a59-415a-a1bd-4cb0b4d164a1" }, { "name": "set_group", "item": [ { "name": "Adds an Inventory device to an Inventory group", "id": "fd615dea-dd7f-4352-b9b3-96ea5e5d33bf", "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}}/devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "set_group" ], "variable": [ { "id": "c5588171-79c3-4374-b93d-21262c801a3b", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Inventory device." } ] }, "description": "Adds an Inventory device to an Inventory group." }, "response": [ { "id": "1661b3ab-a005-4f72-8e7e-ceca0ac6d711", "name": "Inventory device was successfully added to the group.", "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}}/devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1661b3ab-a005-4f72-8e7e-ceca0ac6d711" }, { "id": "af7cb0b4-3564-45d5-a992-3d2960e4e115", "name": "Specified Inventory device was not 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 \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af7cb0b4-3564-45d5-a992-3d2960e4e115" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fd615dea-dd7f-4352-b9b3-96ea5e5d33bf" } ], "id": "ecec52a8-c49a-44a3-9324-6a154ce500bc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ecec52a8-c49a-44a3-9324-6a154ce500bc" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete device tag", "id": "5fc916b9-cc5a-4aa2-bbd7-4842ff5b31e0", "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}}/devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "id": "227968fc-0be9-4388-81cf-9b465e041eac", "key": "device_id", "value": "", "description": "(Required) Device to update" }, { "id": "5edcb852-06d2-4d91-8da2-73b29cf9fbcb", "key": "tag_name", "value": "", "description": "(Required) Name of tag to delete" } ] }, "description": "Delete device tag" }, "response": [ { "id": "37055fbe-e0d2-4a1b-ad83-966f3e982c87", "name": "Device tag deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-37055fbe-e0d2-4a1b-ad83-966f3e982c87" }, { "id": "c266df06-119e-4323-9d58-96033fec7529", "name": "No such device or tag found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c266df06-119e-4323-9d58-96033fec7529" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5fc916b9-cc5a-4aa2-bbd7-4842ff5b31e0" } ], "id": "27fd0c4e-c295-4b42-b37b-1106f46b1b01", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-27fd0c4e-c295-4b42-b37b-1106f46b1b01" }, { "name": "Updates device tags", "id": "de0b3501-99ea-4827-bd55-6764ec12b230", "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}}/devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags" ], "variable": [ { "id": "0376a383-7dc7-467b-9f36-1f4c5de0e171", "key": "device_id", "value": "", "description": "(Required) Device to update" } ] }, "description": "Updates device tags" }, "response": [ { "id": "546452af-13f1-4b96-b8f2-b5b823b611fa", "name": "Device updated", "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}}/devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-546452af-13f1-4b96-b8f2-b5b823b611fa" }, { "id": "c9ee29ea-85d0-40e2-af18-b59c89b361e6", "name": "No such device 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}}/devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c9ee29ea-85d0-40e2-af18-b59c89b361e6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-de0b3501-99ea-4827-bd55-6764ec12b230" } ], "id": "06b95546-f3f8-4ae9-b4d8-a8bdb335ab70", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-06b95546-f3f8-4ae9-b4d8-a8bdb335ab70" }, { "name": "unset_group", "item": [ { "name": "Removes an Inventory device from an Inventory group", "id": "e26068a5-f250-4830-9dba-47848e129184", "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}}/devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "unset_group" ], "variable": [ { "id": "b7a59e69-81a7-4a51-9360-59daf3fcb557", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Inventory device." } ] }, "description": "Removes an Inventory device from an Inventory group." }, "response": [ { "id": "7388b68f-d2e5-4e0e-ac4f-7be3beb98eb4", "name": "Inventory device was successfully removed from the group.", "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}}/devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7388b68f-d2e5-4e0e-ac4f-7be3beb98eb4" }, { "id": "5d8b7d9c-2360-4993-8ce2-1b9f67b8471c", "name": "Specified Inventory device 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}}/devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5d8b7d9c-2360-4993-8ce2-1b9f67b8471c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e26068a5-f250-4830-9dba-47848e129184" } ], "id": "b60ab38e-3575-493c-9da5-9825e3271c2a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b60ab38e-3575-493c-9da5-9825e3271c2a" }, { "name": "Delete Device", "id": "ef45d38c-55ca-420d-a2f1-41ed99941034", "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}}/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "variable": [ { "id": "89436a54-868f-4ab7-b172-2bcacf694c17", "key": "device_id", "value": "", "description": "(Required) Device to delete" } ] }, "description": "Delete Device" }, "response": [ { "id": "f755416f-8949-42b8-886a-23204d077196", "name": "Device deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f755416f-8949-42b8-886a-23204d077196" }, { "id": "b2812acd-e024-445c-b4b8-3c4ebb7d1e99", "name": "No such device found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b2812acd-e024-445c-b4b8-3c4ebb7d1e99" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ef45d38c-55ca-420d-a2f1-41ed99941034" }, { "name": "Returns a Device identified by device ID", "id": "a41934b7-7621-429c-852e-943f4c47e6d4", "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}}/devices/:device_id?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "id": "e60520c6-d38b-4ac6-b861-36c6815af36f", "key": "device_id", "value": "", "description": "(Required) Device ID" } ] }, "description": "Returns a Device identified by device ID" }, "response": [ { "id": "36b91b6f-e727-4a8c-b5f6-4ffe04251e14", "name": "A Device identified by device ID", "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}}/devices/:device_id?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-36b91b6f-e727-4a8c-b5f6-4ffe04251e14" }, { "id": "d0af3ae8-83b4-4542-a7d2-b9c99f3c46e9", "name": "No such device found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/devices/:device_id?model=false", "host": [ "{{baseUrl}}" ], "path": [ "devices", ":device_id" ], "query": [ { "description": "Whether or not to add model information", "key": "model", "value": "false" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d0af3ae8-83b4-4542-a7d2-b9c99f3c46e9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a41934b7-7621-429c-852e-943f4c47e6d4" } ], "id": "bc7b15f2-2738-4a84-8d3a-fd8b5a28e2af", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bc7b15f2-2738-4a84-8d3a-fd8b5a28e2af" }, { "name": "Returns a list of Devices", "id": "12210dc1-bf71-46cb-a3a0-4a81011e0bc4", "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}}/devices?tag_name=&tag_value=&tag_value_match_mode=&last_evaluated_key=&limit=-1", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Tag name", "key": "tag_name", "value": "" }, { "description": "Tag value", "key": "tag_value", "value": "" }, { "description": "Tag value match mode (exact | prefix)", "key": "tag_value_match_mode", "value": "" }, { "description": "ID of the last Device in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of Devices in a response", "key": "limit", "value": "-1" } ] }, "description": "Returns a list of Devices" }, "response": [ { "id": "f0b535b2-57d2-4844-b6f9-55136fbdc132", "name": "List of Devices", "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}}/devices?tag_name=&tag_value=&tag_value_match_mode=&last_evaluated_key=&limit=-1", "host": [ "{{baseUrl}}" ], "path": [ "devices" ], "query": [ { "description": "Tag name", "key": "tag_name", "value": "" }, { "description": "Tag value", "key": "tag_value", "value": "" }, { "description": "Tag value match mode (exact | prefix)", "key": "tag_value_match_mode", "value": "" }, { "description": "ID of the last Device in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Max number of Devices in a response", "key": "limit", "value": "-1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"laborum1\": \"\",\n \"officiaaa\": \"\",\n \"Lorem3\": \"\",\n \"irure_a75\": \"\"\n }\n },\n {\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"nulla_6\": \"\",\n \"ipsum_3\": \"\",\n \"anim_4d5\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f0b535b2-57d2-4844-b6f9-55136fbdc132" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-12210dc1-bf71-46cb-a3a0-4a81011e0bc4" }, { "name": "Creates a new Device", "id": "d57d47c5-e2f8-4f2d-b66a-2e52cdf3a467", "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 \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices", "host": [ "{{baseUrl}}" ], "path": [ "devices" ] }, "description": "Creates a new Device" }, "response": [ { "id": "f33f84ae-5cbd-45c4-a08c-1d65fb6b30f5", "name": "Device 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 \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/devices", "host": [ "{{baseUrl}}" ], "path": [ "devices" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"in_3c\": \"\",\n \"ad77\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f33f84ae-5cbd-45c4-a08c-1d65fb6b30f5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d57d47c5-e2f8-4f2d-b66a-2e52cdf3a467" } ], "id": "397d280d-710e-4473-a3f8-ef9dc61ef398", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-397d280d-710e-4473-a3f8-ef9dc61ef398" }, { "name": "diagnostics", "item": [ { "name": "{diagnostic_id}", "item": [ { "name": "Get diagnostic", "id": "525942ea-3aa1-4260-9430-0596bcc0a1d6", "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}}/diagnostics/:diagnostic_id", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics", ":diagnostic_id" ], "variable": [ { "id": "b9d8a2dc-0f20-4f92-b220-f4735ea04831", "key": "diagnostic_id", "value": "", "description": "(Required) The identifier of diagnostic request." } ] }, "description": "Returns a diagnostic." }, "response": [ { "id": "c2f25658-5a35-416a-b997-c2c7ab96db79", "name": "OK.", "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}}/diagnostics/:diagnostic_id", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics", ":diagnostic_id" ], "variable": [ { "key": "diagnostic_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"diagnosticId\": \"\",\n \"status\": \"failed\",\n \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"insights\": [\n {\n \"insightId\": \"\",\n \"message\": \"\",\n \"category\": \"unknown\",\n \"severity\": \"info\",\n \"anomalyDetectedTimes\": [\n \"\",\n \"\"\n ],\n \"referenceUrls\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n {\n \"insightId\": \"\",\n \"message\": \"\",\n \"category\": \"unknown\",\n \"severity\": \"warning\",\n \"anomalyDetectedTimes\": [\n \"\",\n \"\"\n ],\n \"referenceUrls\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c2f25658-5a35-416a-b997-c2c7ab96db79" }, { "id": "f83d4d91-3d63-4071-83cf-ddbc3bd31614", "name": "The specified diagnostic_id is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/diagnostics/:diagnostic_id", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics", ":diagnostic_id" ], "variable": [ { "key": "diagnostic_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f83d4d91-3d63-4071-83cf-ddbc3bd31614" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-525942ea-3aa1-4260-9430-0596bcc0a1d6" } ], "id": "c9626ad4-8d7c-44f4-929f-4c269c1245c7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c9626ad4-8d7c-44f4-929f-4c269c1245c7" }, { "name": "Send diagnostic request", "id": "66d3bda9-f43c-46b0-a11d-00f6df8f5493", "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 \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/diagnostics", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics" ] }, "description": "Send a diagnostic request." }, "response": [ { "id": "8b7383af-6edf-45c7-a47d-01345e35ed1d", "name": "Successfully accepted a diagnostic request.", "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 \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/diagnostics", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"diagnosticId\": \"\",\n \"status\": \"failed\",\n \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"insights\": [\n {\n \"insightId\": \"\",\n \"message\": \"\",\n \"category\": \"unknown\",\n \"severity\": \"info\",\n \"anomalyDetectedTimes\": [\n \"\",\n \"\"\n ],\n \"referenceUrls\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n {\n \"insightId\": \"\",\n \"message\": \"\",\n \"category\": \"unknown\",\n \"severity\": \"warning\",\n \"anomalyDetectedTimes\": [\n \"\",\n \"\"\n ],\n \"referenceUrls\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8b7383af-6edf-45c7-a47d-01345e35ed1d" }, { "id": "06443365-e690-40af-8ef3-f880ae9fbfcb", "name": "Bad definitions among diagnostic time range (from/to queries).", "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 \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/diagnostics", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-06443365-e690-40af-8ef3-f880ae9fbfcb" }, { "id": "45108889-5a05-44f6-9640-25434cadcc41", "name": "The specified resource is not 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 \"service\": \"Air\",\n \"resourceType\": \"sim\",\n \"resourceId\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/diagnostics", "host": [ "{{baseUrl}}" ], "path": [ "diagnostics" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-45108889-5a05-44f6-9640-25434cadcc41" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-66d3bda9-f43c-46b0-a11d-00f6df8f5493" } ], "id": "c8355b82-023e-4ced-9941-803a26d6dc0b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c8355b82-023e-4ced-9941-803a26d6dc0b" }, { "name": "event_handlers", "item": [ { "name": "{handler_id}", "item": [ { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "ignore", "item": [ { "name": "Delete Ignore Event Handler", "id": "73078bb2-f295-4867-afa7-cc442827b81b", "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}}/event_handlers/:handler_id/subscribers/:imsi/ignore", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id", "subscribers", ":imsi", "ignore" ], "variable": [ { "id": "60f55aa2-cbe3-4229-9cbf-1aead06ef4ce", "key": "handler_id", "value": "", "description": "(Required) Event handler ID." }, { "id": "59079871-599c-4e57-9d0d-276402c1c5bd", "key": "imsi", "value": "", "description": "(Required) IMSI." } ] }, "description": "Deletes the setting for ignoring the specified event handler of the specified IMSI." }, "response": [ { "id": "039b16df-f04f-4676-8cbb-cf656132fc88", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id/subscribers/:imsi/ignore", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id", "subscribers", ":imsi", "ignore" ], "variable": [ { "key": "handler_id" }, { "key": "imsi" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-039b16df-f04f-4676-8cbb-cf656132fc88" }, { "id": "88cf514a-fc3b-4eb9-81a8-ba6b185c8bc9", "name": "Event Handler not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id/subscribers/:imsi/ignore", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id", "subscribers", ":imsi", "ignore" ], "variable": [ { "key": "handler_id" }, { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-88cf514a-fc3b-4eb9-81a8-ba6b185c8bc9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-73078bb2-f295-4867-afa7-cc442827b81b" }, { "name": "Ignore Event Handler", "id": "9a0e10a5-6c21-4d43-8ab8-24f5a89e566e", "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}}/event_handlers/:handler_id/subscribers/:imsi/ignore", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id", "subscribers", ":imsi", "ignore" ], "variable": [ { "id": "49d334b4-8bf3-4c77-b2e3-55bf4d451d95", "key": "handler_id", "value": "", "description": "(Required) Event handler ID." }, { "id": "3e219aed-e446-4891-9024-502a225ac553", "key": "imsi", "value": "", "description": "(Required) IMSI." } ] }, "description": "Adds a setting for ignoring the specified event handler of the specified IMSI." }, "response": [ { "id": "92a7dd81-97a2-4746-b6c9-47408c52fe5a", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id/subscribers/:imsi/ignore", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id", "subscribers", ":imsi", "ignore" ], "variable": [ { "key": "handler_id" }, { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-92a7dd81-97a2-4746-b6c9-47408c52fe5a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9a0e10a5-6c21-4d43-8ab8-24f5a89e566e" } ], "id": "c39ef3c1-5bb7-40bc-b278-809c9057faa4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c39ef3c1-5bb7-40bc-b278-809c9057faa4" } ], "id": "d120bb7d-35c4-41f3-a4bd-4e55e6e433d1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d120bb7d-35c4-41f3-a4bd-4e55e6e433d1" } ], "id": "4149f671-a040-48e5-aea3-7fcfa24e339e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4149f671-a040-48e5-aea3-7fcfa24e339e" }, { "name": "Delete Event Handler", "id": "63a4d32b-f9c7-4df4-9316-53596ad8b58e", "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}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "id": "e04ec140-6251-440e-b890-84d72af279cd", "key": "handler_id", "value": "", "description": "(Required) Event handler ID." } ] }, "description": "Deletes the specified event handler." }, "response": [ { "id": "f79c6a82-1702-440a-a76b-25fd13cbe610", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f79c6a82-1702-440a-a76b-25fd13cbe610" }, { "id": "da916910-9c6a-4ab5-bd25-097de28a5336", "name": "Event Handler not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-da916910-9c6a-4ab5-bd25-097de28a5336" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-63a4d32b-f9c7-4df4-9316-53596ad8b58e" }, { "name": "Get Event Handler", "id": "38cb0792-f25e-4438-aaf2-4e7416968b95", "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}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "id": "c27be448-fe00-49f9-bbb2-76e91080a4f6", "key": "handler_id", "value": "", "description": "(Required) Event handler ID." } ] }, "description": "Returns information about the specified event handler." }, "response": [ { "id": "16962607-31c4-40a9-bd8d-25a33b820467", "name": "OK.", "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}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"AFTER_ONE_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"GET\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ActivationAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"POST\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"NEVER\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"standby\",\n \"targetOtaStatus\": \"failed\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"active\"\n },\n \"type\": \"SubscriberDailyTrafficRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-16962607-31c4-40a9-bd8d-25a33b820467" }, { "id": "331a449b-fbdd-4635-99b1-082c7f23586d", "name": "Event Handler not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-331a449b-fbdd-4635-99b1-082c7f23586d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-38cb0792-f25e-4438-aaf2-4e7416968b95" }, { "name": "Update Event Handler", "id": "dd072c7f-3a2e-43f2-96bd-a12d70ddad65", "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" } ], "body": { "mode": "raw", "raw": "{\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.8xfast\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ChangeSpeedClassAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"u1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"name\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"BEGINNING_OF_NEXT_MONTH\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"terminated\"\n },\n \"type\": \"MonthlyChargeRule\"\n },\n \"status\": \"inactive\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "id": "76a55038-cde4-4330-bb3f-51ffc409fa19", "key": "handler_id", "value": "", "description": "(Required) Event handler ID." } ] }, "description": "Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/." }, "response": [ { "id": "73229448-05a6-4ec4-982f-5b6424bda59c", "name": "OK.", "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 \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.8xfast\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ChangeSpeedClassAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"u1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"name\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"BEGINNING_OF_NEXT_MONTH\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"terminated\"\n },\n \"type\": \"MonthlyChargeRule\"\n },\n \"status\": \"inactive\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-73229448-05a6-4ec4-982f-5b6424bda59c" }, { "id": "6b83f463-7e58-4318-857c-9c9681e2d65f", "name": "Invalid event handler ID.", "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 \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.8xfast\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ChangeSpeedClassAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"u1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"name\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"BEGINNING_OF_NEXT_MONTH\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"terminated\"\n },\n \"type\": \"MonthlyChargeRule\"\n },\n \"status\": \"inactive\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/event_handlers/:handler_id", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", ":handler_id" ], "variable": [ { "key": "handler_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6b83f463-7e58-4318-857c-9c9681e2d65f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dd072c7f-3a2e-43f2-96bd-a12d70ddad65" } ], "id": "92dfb81f-b4d5-4fbf-a0db-026f9f1357a3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-92dfb81f-b4d5-4fbf-a0db-026f9f1357a3" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "List Event Handlers related to Subscriber", "id": "649a68ce-ddf4-4385-83b8-ded17cc0501c", "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}}/event_handlers/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", "subscribers", ":imsi" ], "variable": [ { "id": "f7174815-7aec-4a56-a52c-f892b5748f24", "key": "imsi", "value": "", "description": "(Required) IMSI." } ] }, "description": "Returns a list of event handlers related to the specified IMSI." }, "response": [ { "id": "9fc12183-7528-4b96-bfea-a55efa8e22bd", "name": "OK.", "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}}/event_handlers/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"AFTER_ONE_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"BEGINNING_OF_NEXT_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"GET\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"NEVER\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.minimum\",\n \"targetStatus\": \"inactive\"\n },\n \"type\": \"SimDailyTotalTrafficRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n },\n {\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"POST\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.standard\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ExecuteWebRequestAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.standard\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ExecuteWebRequestAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"AFTER_ONE_DAY\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"true\",\n \"sourceStatus\": \"suspended\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.slow\",\n \"targetStatus\": \"inactive\"\n },\n \"type\": \"SimImeiMismatchedRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9fc12183-7528-4b96-bfea-a55efa8e22bd" }, { "id": "c6912101-cbb7-495a-972e-f4291b26ee3a", "name": "Event Handler not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/event_handlers/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers", "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c6912101-cbb7-495a-972e-f4291b26ee3a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-649a68ce-ddf4-4385-83b8-ded17cc0501c" } ], "id": "20135c61-8115-402e-9863-4b5a614d1921", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-20135c61-8115-402e-9863-4b5a614d1921" } ], "id": "8c0db07d-689d-48ac-a276-7b70519f1c1e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8c0db07d-689d-48ac-a276-7b70519f1c1e" }, { "name": "List Event Handlers", "id": "bae90d77-158c-458d-9dd0-e1b970fa9b01", "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}}/event_handlers?target=operator", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers" ], "query": [ { "description": "The event handler target (the target for executing events).", "key": "target", "value": "operator" } ] }, "description": "Returns a list of event handlers." }, "response": [ { "id": "393790a7-c2bb-4748-a178-614ed61d7ef9", "name": "OK.", "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}}/event_handlers?target=operator", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers" ], "query": [ { "description": "The event handler target (the target for executing events).", "key": "target", "value": "operator" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"AFTER_ONE_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"BEGINNING_OF_NEXT_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"GET\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"NEVER\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.minimum\",\n \"targetStatus\": \"inactive\"\n },\n \"type\": \"SimDailyTotalTrafficRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n },\n {\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"POST\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.standard\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ExecuteWebRequestAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.standard\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ExecuteWebRequestAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"AFTER_ONE_DAY\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"true\",\n \"sourceStatus\": \"suspended\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.slow\",\n \"targetStatus\": \"inactive\"\n },\n \"type\": \"SimImeiMismatchedRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-393790a7-c2bb-4748-a178-614ed61d7ef9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bae90d77-158c-458d-9dd0-e1b970fa9b01" }, { "name": "Create Event Handler", "id": "9e243776-052b-49ef-9d1f-400e004b4b94", "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 \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.8xfast\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ChangeSpeedClassAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"u1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"name\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"BEGINNING_OF_NEXT_MONTH\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"terminated\"\n },\n \"type\": \"MonthlyChargeRule\"\n },\n \"status\": \"inactive\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/event_handlers", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers" ] }, "description": "Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/." }, "response": [ { "id": "4a4eadb4-a398-4d80-987b-5c34e1245f5a", "name": "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 \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"DELETE\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.8xfast\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ChangeSpeedClassAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"NEVER\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"PUT\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"u1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"name\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"BEGINNING_OF_NEXT_MONTH\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"ready\",\n \"targetOtaStatus\": \"started\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"terminated\"\n },\n \"type\": \"MonthlyChargeRule\"\n },\n \"status\": \"inactive\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/event_handlers", "host": [ "{{baseUrl}}" ], "path": [ "event_handlers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"actionConfigList\": [\n {\n \"properties\": {\n \"executionDateTimeConst\": \"AFTER_ONE_DAY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"GET\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.slow\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"ActivationAction\"\n },\n {\n \"properties\": {\n \"executionDateTimeConst\": \"IMMEDIATELY\",\n \"accessKey\": \"\",\n \"body\": \"\",\n \"contentType\": \"\",\n \"credentialsId\": \"\",\n \"endpoint\": \"\",\n \"executionOffsetMinutes\": \"\",\n \"functionName\": \"\",\n \"headers\": {},\n \"httpMethod\": \"POST\",\n \"message\": \"\",\n \"parameter1\": \"\",\n \"parameter2\": \"\",\n \"parameter3\": \"\",\n \"parameter4\": \"\",\n \"parameter5\": \"\",\n \"secretAccessKey\": \"\",\n \"speedClass\": \"s1.minimum\",\n \"title\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"type\": \"SendMailToOperatorAction\"\n }\n ],\n \"handlerId\": \"\",\n \"ruleConfig\": {\n \"properties\": {\n \"inactiveTimeoutDateConst\": \"NEVER\",\n \"inactiveTimeoutOffsetMinutes\": \"\",\n \"limitTotalAmount\": \"\",\n \"limitTotalTrafficMegaByte\": \"\",\n \"runOnceAmongTarget\": \"false\",\n \"sourceStatus\": \"standby\",\n \"targetOtaStatus\": \"failed\",\n \"targetSpeedClass\": \"s1.4xfast\",\n \"targetStatus\": \"active\"\n },\n \"type\": \"SubscriberDailyTrafficRule\"\n },\n \"status\": \"inactive\",\n \"name\": \"\",\n \"description\": \"\",\n \"targetGroupId\": \"\",\n \"targetImsi\": \"\",\n \"targetOperatorId\": \"\",\n \"targetSimId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4a4eadb4-a398-4d80-987b-5c34e1245f5a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9e243776-052b-49ef-9d1f-400e004b4b94" } ], "id": "26229d7d-5550-4223-9518-d5b76ce83bcd", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-26229d7d-5550-4223-9518-d5b76ce83bcd" }, { "name": "files", "item": [ { "name": "{scope}", "item": [ { "name": "{path}", "item": [ { "name": "Deletes the directory specified by scope and path", "id": "d5d481ea-12d1-4ce6-8d61-1683683718e3", "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}}/files/:scope/:path/", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "variable": [ { "id": "135dba41-fd4b-4804-91e7-a77faa36a372", "key": "scope", "value": "private", "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "id": "40f4364a-1536-4568-82c3-7bd980c2c1d9", "key": "path", "value": "", "description": "(Required) Target path." } ] }, "description": "Deletes the directory specified by scope and path. Only `private` scope is allowed for the operation." }, "response": [ { "id": "49b47fe6-303b-43cf-b83e-27fdec270a21", "name": "The specified directory is successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path/", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-49b47fe6-303b-43cf-b83e-27fdec270a21" }, { "id": "74e73676-ca6f-48e3-b4a1-dde51c31d844", "name": "The specified directory is not empty.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path/", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-74e73676-ca6f-48e3-b4a1-dde51c31d844" }, { "id": "5a2800a6-776e-4e86-aca0-a28d0d3a5101", "name": "No such directory.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path/", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5a2800a6-776e-4e86-aca0-a28d0d3a5101" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d5d481ea-12d1-4ce6-8d61-1683683718e3" }, { "name": "Returns files and directories from the directory specified by the scope and path.", "id": "c3c1a0ea-db8f-437b-bff9-b01b525e948c", "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}}/files/:scope/:path/?limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "query": [ { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filename of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "5d2a237e-7548-4328-bf00-19cef0768a3c", "key": "scope", "value": "private", "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "id": "b7c129ce-3864-4f7e-9187-ed453cc93161", "key": "path", "value": "/", "description": "(Required) Target path." } ] }, "description": "Returns files and directories from the directory specified by the scope and path. Note that [FileEntry:getFile API](#!/FileEntry/getFile) will be called if the path does not end in `/`. If the total number of 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": "39aae033-89a2-4270-b4e6-701ab93a2654", "name": "Files and directories from the directory specified by the scope and path.", "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}}/files/:scope/:path/?limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "query": [ { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filename of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"contentLength\": \"\",\n \"contentType\": \"\",\n \"createdTime\": \"\",\n \"directory\": \"\",\n \"etag\": \"\",\n \"filePath\": \"\",\n \"filename\": \"\",\n \"isDirectory\": \"\",\n \"lastModifiedTime\": \"\"\n },\n {\n \"contentLength\": \"\",\n \"contentType\": \"\",\n \"createdTime\": \"\",\n \"directory\": \"\",\n \"etag\": \"\",\n \"filePath\": \"\",\n \"filename\": \"\",\n \"isDirectory\": \"\",\n \"lastModifiedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-39aae033-89a2-4270-b4e6-701ab93a2654" }, { "id": "40124149-f248-4033-89a0-927b3c9be3e7", "name": "No such directory.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path/?limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path", "" ], "query": [ { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filename of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-40124149-f248-4033-89a0-927b3c9be3e7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c3c1a0ea-db8f-437b-bff9-b01b525e948c" }, { "name": "Gets the metadata of the file specified by the path and the scope", "id": "acb9c2b9-4c5c-4678-913e-2867cc20bb92", "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": "HEAD", "header": [], "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "id": "bce176bd-916b-48f1-abc0-d9f404639783", "key": "scope", "value": "private", "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "id": "3a18d38b-034d-4d24-91af-d4c9744c3be5", "key": "path", "value": "", "description": "(Required) Target path." } ] }, "description": "Gets the metadata of the file specified by the path and the scope." }, "response": [ { "id": "6d22c135-1b7e-4629-a273-71899d732d7b", "name": "Metadata of the file", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "File size (bytes)", "type": "text/plain" }, "key": "Content-Length", "value": "" }, { "disabled": false, "description": { "content": "File's Content-Type", "type": "text/plain" }, "key": "Content-Type", "value": "" }, { "disabled": false, "description": { "content": "Identifier representing the file version", "type": "text/plain" }, "key": "ETag", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6d22c135-1b7e-4629-a273-71899d732d7b" }, { "id": "b5eee06e-f03a-4452-83c9-fb733c3fcc31", "name": "No such file.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b5eee06e-f03a-4452-83c9-fb733c3fcc31" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-acb9c2b9-4c5c-4678-913e-2867cc20bb92" }, { "name": "Uploads the file to the specified path in the scope.", "id": "30412bbe-9285-4ef1-a137-2e409eb60096", "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": "*/*" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "id": "7b462ca3-adbd-4609-ae7a-d2df42747646", "key": "scope", "value": "private", "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "id": "a308c432-7153-491e-906c-198e9e7b5724", "key": "path", "value": "", "description": "(Required) Target path." } ] }, "description": "Uploads the file to the specified path in the scope. Only `private` scope is allowed for the operation." }, "response": [ { "id": "5c31fdd1-31b1-4276-976c-75f6c1a8c5d2", "name": "File is successfully updated with the content.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5c31fdd1-31b1-4276-976c-75f6c1a8c5d2" }, { "id": "e390521e-718c-4354-8286-d73bbdd8e54b", "name": "File is successfully created.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/files/:scope/:path", "host": [ "{{baseUrl}}" ], "path": [ "files", ":scope", ":path" ], "variable": [ { "key": "scope" }, { "key": "path" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e390521e-718c-4354-8286-d73bbdd8e54b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-30412bbe-9285-4ef1-a137-2e409eb60096" } ], "id": "67895289-88e8-46f6-a4fc-f48cea3f55aa", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-67895289-88e8-46f6-a4fc-f48cea3f55aa" } ], "id": "43fa69ae-eb81-4c97-a7db-d5749e070228", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-43fa69ae-eb81-4c97-a7db-d5749e070228" }, { "name": "exported", "item": [ { "name": "{exported_file_id}", "item": [ { "name": "Get the progress of the process when the file is exported asynchronously.", "id": "6db745f5-704b-4046-b55a-807de4fc1795", "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}}/files/exported/:exported_file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", "exported", ":exported_file_id" ], "variable": [ { "id": "aa7396a9-1391-4011-b07a-cd030554dc88", "key": "exported_file_id", "value": "", "description": "(Required) File export ID." } ] }, "description": "Get the progress of the process when the file is exported asynchronously. If the export is complete, you will get the URL to download the file. You can download the file from the URL.\n\nThe following APIs are available to export files asynchronously. The `exported_file_id` is the file output ID (the value of `exportedFileId`) obtained from the following API.\n\n- [Billing:exportBilling API](#!/Billing/exportBilling)\n- [Billing:exportLatestBilling API](#!/Billing/exportLatestBilling)\n- [Payment:exportPaymentStatement API](#!/Payment/exportPaymentStatement)\n- [Stats:exportAirStats API](#!/Stats/exportAirStats)\n- [Stats:exportBeamStats API](#!/Stats/exportBeamStats)\n- [Stats:exportFunkStats API](#!/Stats/exportFunkStats)\n- [Stats:exportFunnelStats API](#!/Stats/exportFunnelStats)\n- [Subscriber:exportSubscribers API](#!/Subscriber/exportSubscribers)\n" }, "response": [ { "id": "2eee8730-d630-4615-b9ed-0a5127423593", "name": "OK", "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}}/files/exported/:exported_file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", "exported", ":exported_file_id" ], "variable": [ { "key": "exported_file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"processing\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2eee8730-d630-4615-b9ed-0a5127423593" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6db745f5-704b-4046-b55a-807de4fc1795" } ], "id": "7e067f76-6647-4fad-96ea-52876905c5c6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7e067f76-6647-4fad-96ea-52876905c5c6" } ], "id": "f8a8adc6-9365-4475-823a-fb2586bd952c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f8a8adc6-9365-4475-823a-fb2586bd952c" }, { "name": "Find files with prefix query parameter in the scope", "id": "45e92551-05be-439e-8126-1a398ce858f5", "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}}/files?scope=private&prefix=&limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files.", "key": "scope", "value": "private" }, { "description": "(Required) Prefix to match with file path.", "key": "prefix", "value": "" }, { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filePath of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of file entries which beginnings of their file paths are matched with the `prefix` query string in the ascending sorted UTF-8 bytes order of their file paths. An empty list is returned if the prefix does not match with any paths of file entries." }, "response": [ { "id": "0865e4e7-d65d-49d5-8364-f31722d747cc", "name": "List of file entries found with query parameters. Empty list if there is no file entry matching prefix.", "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}}/files?scope=private&prefix=&limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files.", "key": "scope", "value": "private" }, { "description": "(Required) Prefix to match with file path.", "key": "prefix", "value": "" }, { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filePath of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry 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 \"contentLength\": \"\",\n \"contentType\": \"\",\n \"createdTime\": \"\",\n \"directory\": \"\",\n \"etag\": \"\",\n \"filePath\": \"\",\n \"filename\": \"\",\n \"isDirectory\": \"\",\n \"lastModifiedTime\": \"\"\n },\n {\n \"contentLength\": \"\",\n \"contentType\": \"\",\n \"createdTime\": \"\",\n \"directory\": \"\",\n \"etag\": \"\",\n \"filePath\": \"\",\n \"filename\": \"\",\n \"isDirectory\": \"\",\n \"lastModifiedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0865e4e7-d65d-49d5-8364-f31722d747cc" }, { "id": "b0990f9c-f2d3-4688-abcb-81e562e16ae7", "name": "The specified scope 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}}/files?scope=private&prefix=&limit=10&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": "(Required) Scope of the request. Specify `private` to handle files uploaded to Harvest Files.", "key": "scope", "value": "private" }, { "description": "(Required) Prefix to match with file path.", "key": "prefix", "value": "" }, { "description": "Maximum number of file entries to be returned.", "key": "limit", "value": "10" }, { "description": "The filePath of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward.", "key": "last_evaluated_key", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b0990f9c-f2d3-4688-abcb-81e562e16ae7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-45e92551-05be-439e-8126-1a398ce858f5" } ], "id": "c95c2d2f-47d1-449e-99d7-37ffac6ba101", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c95c2d2f-47d1-449e-99d7-37ffac6ba101" }, { "name": "gadgets", "item": [ { "name": "{product_id}", "item": [ { "name": "{serial_number}", "item": [ { "name": "disable_termination", "item": [ { "name": "Disables Termination of Gadget API compatible device", "id": "77beafd9-d99e-49ad-8922-5a2aca1684f6", "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}}/gadgets/:product_id/:serial_number/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "disable_termination" ], "variable": [ { "id": "44dacd79-2b8c-4d99-9383-f438e94d1f19", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "002535d1-2696-47ba-8578-b6324518e89e", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Disables termination of specified Gadget API compatible device." }, "response": [ { "id": "fc005481-5dad-44ba-ada3-639ef368e7f0", "name": "Detailed information about the updated Gadget API compatible device.", "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}}/gadgets/:product_id/:serial_number/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "disable_termination" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fc005481-5dad-44ba-ada3-639ef368e7f0" }, { "id": "6ec64d7a-6b04-4518-a6b0-3b7738ce72ee", "name": "The specified Gadget API compatible device 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}}/gadgets/:product_id/:serial_number/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "disable_termination" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6ec64d7a-6b04-4518-a6b0-3b7738ce72ee" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-77beafd9-d99e-49ad-8922-5a2aca1684f6" } ], "id": "845713a8-85d1-44c1-9047-002f838bcb15", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-845713a8-85d1-44c1-9047-002f838bcb15" }, { "name": "enable_termination", "item": [ { "name": "Enables Termination of Gadget API compatible device", "id": "6bdfc888-3dd1-47af-afc3-0236f8e93349", "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}}/gadgets/:product_id/:serial_number/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "enable_termination" ], "variable": [ { "id": "01fa7f99-7705-438a-8912-e651a0efe567", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "928608de-299a-4365-8a28-f002427ff2fe", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Enables termination of specified Gadget API compatible device." }, "response": [ { "id": "957858d6-f0a5-42cd-8b89-66ba243de81a", "name": "Detailed information about the updated Gadget API compatible device.", "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}}/gadgets/:product_id/:serial_number/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "enable_termination" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-957858d6-f0a5-42cd-8b89-66ba243de81a" }, { "id": "ee3c5f92-398f-4b42-a9df-e4907188d88b", "name": "The specified Gadget API compatible device 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}}/gadgets/:product_id/:serial_number/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "enable_termination" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ee3c5f92-398f-4b42-a9df-e4907188d88b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6bdfc888-3dd1-47af-afc3-0236f8e93349" } ], "id": "a38f8310-9453-40bf-bfb7-78003c307d67", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a38f8310-9453-40bf-bfb7-78003c307d67" }, { "name": "register", "item": [ { "name": "Registers a Gadget API compatible device", "id": "e7ff4af2-6dad-46b5-a131-9eb03e3e2f58", "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 \"tags\": {\n \"officia_ae\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gadgets/:product_id/:serial_number/register", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "register" ], "variable": [ { "id": "3d04405f-af5d-4de1-a2b9-7db3e596d8fb", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "6abc64ec-3ee1-4a19-8ed0-fabc94568686", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Registers a Gadget API compatible device." }, "response": [ { "id": "ab3a2ec6-e984-4b69-8954-8fe659d1906b", "name": "Gadget API compatible device successfully registered.", "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 \"tags\": {\n \"officia_ae\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gadgets/:product_id/:serial_number/register", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "register" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ab3a2ec6-e984-4b69-8954-8fe659d1906b" }, { "id": "b3848e85-4af5-436d-941e-f8702c39052c", "name": "No such resource 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 \"tags\": {\n \"officia_ae\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gadgets/:product_id/:serial_number/register", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "register" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b3848e85-4af5-436d-941e-f8702c39052c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e7ff4af2-6dad-46b5-a131-9eb03e3e2f58" } ], "id": "e04930f3-5578-48ff-be3b-79d71aed5e62", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e04930f3-5578-48ff-be3b-79d71aed5e62" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Deletes tags from Gadget API compatible device", "id": "4fd22ec4-08d6-47a3-985c-4bee925fb765", "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}}/gadgets/:product_id/:serial_number/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags", ":tag_name" ], "variable": [ { "id": "eaee300d-0060-4177-b58a-5ad30511df88", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "bd389c49-4e7c-4627-b583-d060ce1d1720", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." }, { "id": "710619d7-8c7c-4f2a-944e-22a951aeba3d", "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 Gadget API compatible device." }, "response": [ { "id": "dd689146-eb37-4796-ba23-97506452cacb", "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}}/gadgets/:product_id/:serial_number/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags", ":tag_name" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dd689146-eb37-4796-ba23-97506452cacb" }, { "id": "fd11dfff-5dc4-44d2-9153-0784ab00c4a0", "name": "The specified Gadget API compatible devices or the tags 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}}/gadgets/:product_id/:serial_number/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags", ":tag_name" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fd11dfff-5dc4-44d2-9153-0784ab00c4a0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4fd22ec4-08d6-47a3-985c-4bee925fb765" } ], "id": "bd9ba812-80ba-457a-9251-9c6c58bb3b9a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bd9ba812-80ba-457a-9251-9c6c58bb3b9a" }, { "name": "Bulk Insert or Update Gadget API compatible device tags", "id": "ca95f2ee-e9d4-4300-ad89-b5f10ca1a9ce", "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}}/gadgets/:product_id/:serial_number/tags", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags" ], "variable": [ { "id": "d940b7a1-a3d0-4ee8-9195-0820e0773835", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "ee1bdd11-f765-483b-a378-37297ad9e7aa", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Inserts/updates tags for the specified Gadget API compatible device." }, "response": [ { "id": "d1c39eda-0f52-49e7-acf1-e100bdb57ab7", "name": "Detailed information about the updated Gadget API compatible device.", "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}}/gadgets/:product_id/:serial_number/tags", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d1c39eda-0f52-49e7-acf1-e100bdb57ab7" }, { "id": "62232d86-3fc8-40ae-adbd-46aca2cafcf8", "name": "The specified Gadget API compatible device 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}}/gadgets/:product_id/:serial_number/tags", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "tags" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-62232d86-3fc8-40ae-adbd-46aca2cafcf8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ca95f2ee-e9d4-4300-ad89-b5f10ca1a9ce" } ], "id": "b1051b71-162f-46c6-b741-010168891a1e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b1051b71-162f-46c6-b741-010168891a1e" }, { "name": "terminate", "item": [ { "name": "Terminates the specified Gadget API compatible device", "id": "fd8ebc85-2491-42f8-b188-04e0cdac752a", "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}}/gadgets/:product_id/:serial_number/terminate", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "terminate" ], "variable": [ { "id": "ac05ad9e-d363-47cf-92c2-8cffd5c86b06", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "000ef780-5311-425f-bde0-f77a8601c30f", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Terminates the specified Gadget API compatible device." }, "response": [ { "id": "d0957d61-cb33-4697-8ec2-a8d69f8b5bef", "name": "Detailed information about the updated Gadget API compatible device.", "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}}/gadgets/:product_id/:serial_number/terminate", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "terminate" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d0957d61-cb33-4697-8ec2-a8d69f8b5bef" }, { "id": "fef5b937-b0fd-40b8-a783-ec3f0b571e45", "name": "The specified Gadget API compatible device 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}}/gadgets/:product_id/:serial_number/terminate", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number", "terminate" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fef5b937-b0fd-40b8-a783-ec3f0b571e45" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fd8ebc85-2491-42f8-b188-04e0cdac752a" } ], "id": "8a7a96fb-8bca-44cf-93bc-37db0bb51bb4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8a7a96fb-8bca-44cf-93bc-37db0bb51bb4" }, { "name": "Get Gadget API compatible device", "id": "b6b9f144-6411-499b-8859-b5c48694e0e3", "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}}/gadgets/:product_id/:serial_number", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number" ], "variable": [ { "id": "bf6911ad-02df-4634-b232-2caca87520bd", "key": "product_id", "value": "button", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "733e35ee-b8d1-4142-9e97-0a2dc6c26703", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Returns information about the specified Gadget API compatible device." }, "response": [ { "id": "c4522763-5a4c-4087-a4bf-d0b07bfdbb58", "name": "Detailed information about the specified Gadget API compatible device.", "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}}/gadgets/:product_id/:serial_number", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"ex_f\": \"\",\n \"reprehenderit0\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c4522763-5a4c-4087-a4bf-d0b07bfdbb58" }, { "id": "70b9a795-3ad5-4677-b76c-c669eaa9499f", "name": "The specified Gadget API compatible device 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}}/gadgets/:product_id/:serial_number", "host": [ "{{baseUrl}}" ], "path": [ "gadgets", ":product_id", ":serial_number" ], "variable": [ { "key": "product_id" }, { "key": "serial_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-70b9a795-3ad5-4677-b76c-c669eaa9499f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b6b9f144-6411-499b-8859-b5c48694e0e3" } ], "id": "07716696-12b4-4c59-a541-c9b691f5021f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-07716696-12b4-4c59-a541-c9b691f5021f" } ], "id": "b30cb586-7fd0-4cc2-8c4b-9190af5066b0", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b30cb586-7fd0-4cc2-8c4b-9190af5066b0" }, { "name": "List gadgets", "id": "1100c219-03d3-41d3-a3ae-effc715a0afc", "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}}/gadgets?product_id=button&tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "gadgets" ], "query": [ { "description": "Product ID of the target Gadget API compatible device for filtering the search.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n", "key": "product_id", "value": "button" }, { "description": "Tag name for filtering the search. The search is always an exact match, regardless of the setting of `tag_value_match_mode`.", "key": "tag_name", "value": "" }, { "description": "Specifies a tag value to search for in a URL-encoded (percent-encoded) string. Required when `tag_name` has been specified.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.\n\n- `exact`: exact match.\n- `prefix`: prefix match.\n", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of Gadget API compatible devices data to retrieve.", "key": "limit", "value": "" }, { "description": "The ID (`{product_id}/{serial_number}`) of the last gadget retrieved on the previous page in URL encoding (percent encoding).\n\nBy specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward.\n\nThe value of the `last_evaluated_key` of `rel=next` returned in the `link` header when the API is called is expected to be specified in the next call, but any ID (`{productId}/{serialNumber}`) can be specified.\n", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of gadgets that match certain criteria. If the total number of gadgets 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": "3b8d2d7f-21d4-4c9d-8269-cba80aba18a0", "name": "A list of Gadget API compatible devices.", "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}}/gadgets?product_id=button&tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "gadgets" ], "query": [ { "description": "Product ID of the target Gadget API compatible device for filtering the search.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n", "key": "product_id", "value": "button" }, { "description": "Tag name for filtering the search. The search is always an exact match, regardless of the setting of `tag_value_match_mode`.", "key": "tag_name", "value": "" }, { "description": "Specifies a tag value to search for in a URL-encoded (percent-encoded) string. Required when `tag_name` has been specified.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.\n\n- `exact`: exact match.\n- `prefix`: prefix match.\n", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of Gadget API compatible devices data to retrieve.", "key": "limit", "value": "" }, { "description": "The ID (`{product_id}/{serial_number}`) of the last gadget retrieved on the previous page in URL encoding (percent encoding).\n\nBy specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward.\n\nThe value of the `last_evaluated_key` of `rel=next` returned in the `link` header when the API is called is expected to be specified in the next call, but any ID (`{productId}/{serialNumber}`) can be specified.\n", "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 \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"laborum_db\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n },\n {\n \"attributes\": {\n \"wimaxBillingStartDate\": \"\",\n \"wimaxIccid\": \"\",\n \"wimaxImei\": \"\"\n },\n \"createdTime\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"productId\": \"button\",\n \"serialNumber\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"ullamcof\": \"\",\n \"amet3ac\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3b8d2d7f-21d4-4c9d-8269-cba80aba18a0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1100c219-03d3-41d3-a3ae-effc715a0afc" } ], "id": "f78145eb-7dee-4b8e-acce-640a194e6cfe", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f78145eb-7dee-4b8e-acce-640a194e6cfe" }, { "name": "groups", "item": [ { "name": "{group_id}", "item": [ { "name": "configuration", "item": [ { "name": "{namespace}", "item": [ { "name": "{name}", "item": [ { "name": "Delete Group Configuration Parameters", "id": "5aaf6dc0-5605-485e-a311-45455a139bce", "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}}/groups/:group_id/configuration/:namespace/:name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace", ":name" ], "variable": [ { "id": "eef019d3-ac62-40f7-936f-f505edee5858", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." }, { "id": "2138c8d0-f9e5-4c2f-8fa8-cc27b7caa4fc", "key": "namespace", "value": "SoracomKrypton", "description": "(Required) Namespace of target parameters." }, { "id": "ea8150dc-9da3-4d1d-8100-4676cc86cf51", "key": "name", "value": "", "description": "(Required) Parameter 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": "Delete parameters for the specified group." }, "response": [ { "id": "59f081d3-51f9-4810-bbda-d5d9868f7ed0", "name": "The parameter was successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/groups/:group_id/configuration/:namespace/:name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace", ":name" ], "variable": [ { "key": "group_id" }, { "key": "namespace" }, { "key": "name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-59f081d3-51f9-4810-bbda-d5d9868f7ed0" }, { "id": "61aaf93a-ff1a-43b4-8b07-de72d0185e93", "name": "The specified group 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}}/groups/:group_id/configuration/:namespace/:name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace", ":name" ], "variable": [ { "key": "group_id" }, { "key": "namespace" }, { "key": "name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-61aaf93a-ff1a-43b4-8b07-de72d0185e93" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5aaf6dc0-5605-485e-a311-45455a139bce" } ], "id": "ddd03b27-db60-49a3-8ded-b81b951e69cc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ddd03b27-db60-49a3-8ded-b81b951e69cc" }, { "name": "Delete Group Configuration Namespace", "id": "5adbcaa4-eaef-43e2-8c4c-695356c1f1e9", "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}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "id": "5ce66080-971c-4949-b632-d442077d19aa", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." }, { "id": "de250177-1903-40dc-a95c-11fddc22c8df", "key": "namespace", "value": "SoracomAir", "description": "(Required) Namespace to be deleted." } ] }, "description": "Delete a namespace for the specified group." }, "response": [ { "id": "1c10f911-1f7a-446c-b25b-b1eb58d4f1fb", "name": "The namespace was successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "key": "group_id" }, { "key": "namespace" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c10f911-1f7a-446c-b25b-b1eb58d4f1fb" }, { "id": "4925f9e6-cf9e-47ef-9197-6042fa81d908", "name": "The specified namespace 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}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "key": "group_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4925f9e6-cf9e-47ef-9197-6042fa81d908" }, { "id": "b4dc1376-b38c-4351-a998-b71b2521a62f", "name": "The specified group 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}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "key": "group_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b4dc1376-b38c-4351-a998-b71b2521a62f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5adbcaa4-eaef-43e2-8c4c-695356c1f1e9" }, { "name": "Update group configuration", "id": "a96515d6-d41d-4f89-9550-b63b00f3d232", "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 \"key\": \"\",\n \"value\": {}\n },\n {\n \"key\": \"\",\n \"value\": {}\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "id": "34e693d3-4ab5-4f17-8615-de8f7c117050", "key": "group_id", "value": "", "description": "(Required) ID of the target group. The group ID can be obtained via the [Group:listGroups API](#!/Group/listGroups)." }, { "id": "f00e4945-943f-45df-9628-6ba21d22f6b2", "key": "namespace", "value": "UnifiedEndpoint", "description": "(Required) A string indicating the configuration target. It varies depending on the configuration content.\n\n- `SoracomAir`: Custom DNS, Metadata service, VPG (Virtual Private Gateway), CHAP authentication, Simple Location function, Binary Parser.\n- `SoracomBeam`: SORACOM Beam.\n- `SoracomEndorse`: SORACOM Endorse.\n- `SoracomFunk`: SORACOM Funk.\n- `SoracomFunnel`: SORACOM Funnel.\n- `SoracomHarvest`: SORACOM Harvest Data.\n- `SoracomHarvestFiles`: SORACOM Harvest Files.\n- `SoracomKrypton`: SORACOM Krypton.\n- `SoracomOrbit`: SORACOM Orbit.\n- `UnifiedEndpoint`: Unified Endpoint.\n" } ] }, "description": "Updates the configuration of the specified group." }, "response": [ { "id": "7d3fcc46-7219-4cec-8548-7bc7d483933f", "name": "The Group 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 \"key\": \"\",\n \"value\": {}\n },\n {\n \"key\": \"\",\n \"value\": {}\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "key": "group_id" }, { "key": "namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"sint4\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"velit23a\": \"\",\n \"sunt_2e6\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7d3fcc46-7219-4cec-8548-7bc7d483933f" }, { "id": "78653a44-5408-4cb1-a912-c50e5eb8ca68", "name": "The specified Group 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 \"key\": \"\",\n \"value\": {}\n },\n {\n \"key\": \"\",\n \"value\": {}\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups/:group_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "configuration", ":namespace" ], "variable": [ { "key": "group_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-78653a44-5408-4cb1-a912-c50e5eb8ca68" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a96515d6-d41d-4f89-9550-b63b00f3d232" } ], "id": "83f51078-af96-4fbf-a92d-3c65f4dab058", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-83f51078-af96-4fbf-a92d-3c65f4dab058" } ], "id": "113177c3-55de-4537-af44-a2cdb721faf1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-113177c3-55de-4537-af44-a2cdb721faf1" }, { "name": "subscribers", "item": [ { "name": "List Subscribers in a group", "id": "6b4fad21-2bbc-44ae-943c-eb75d51b7b93", "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}}/groups/:group_id/subscribers?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "subscribers" ], "query": [ { "description": "Maximum number of results per response page.", "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": "" } ], "variable": [ { "id": "0c146978-25b3-4809-a53c-e765b2df8ec7", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." } ] }, "description": "Returns a list of subscribers that belong to the specified group by group ID." }, "response": [ { "id": "e2fb980e-8e64-4411-b5f9-70b9248384b0", "name": "Specified Group.", "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}}/groups/:group_id/subscribers?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "subscribers" ], "query": [ { "description": "Maximum number of results per response page.", "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": "" } ], "variable": [ { "key": "group_id" } ] } }, "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\": \"suspend\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"veniam_b7\": \"\",\n \"essed0\": \"\"\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\": \"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 \"profiles\": {\n \"amet5a\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"consectetur_2\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\n \"subscription\": \"\"\n },\n \"eu4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"non9\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"Lorembe\": {\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\": \"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-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"in9\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\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\": \"deleteSession\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"Excepteur_e3e\": \"\"\n },\n \"moduleType\": \"trio\",\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 \"ad_01\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam0e0\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"laborum_5\": \"\",\n \"Ute2\": \"\",\n \"eu717\": \"\",\n \"deserunt3\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e2fb980e-8e64-4411-b5f9-70b9248384b0" }, { "id": "995d17ec-befd-4a7d-aab2-6f789234981b", "name": "The specified group 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}}/groups/:group_id/subscribers?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "subscribers" ], "query": [ { "description": "Maximum number of results per response page.", "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": "" } ], "variable": [ { "key": "group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-995d17ec-befd-4a7d-aab2-6f789234981b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6b4fad21-2bbc-44ae-943c-eb75d51b7b93" } ], "id": "7681c5b6-a299-4006-a876-60dbe7585fa5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7681c5b6-a299-4006-a876-60dbe7585fa5" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete Group Tag", "id": "f866d4d9-da93-4978-b97e-a6fc9d62258b", "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}}/groups/:group_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags", ":tag_name" ], "variable": [ { "id": "0f25acac-f939-4e3e-95e0-8ed11a6aa370", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." }, { "id": "a0bb713c-270f-4014-98f9-c267b6e51dd4", "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 tag from the specified group." }, "response": [ { "id": "05192e0d-a9e6-4e22-bbf3-be32e3b7348c", "name": "Tag deletion complete.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/groups/:group_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags", ":tag_name" ], "variable": [ { "key": "group_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05192e0d-a9e6-4e22-bbf3-be32e3b7348c" }, { "id": "39cc3483-2e06-4b76-81a8-01849e38801b", "name": "The specified group 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}}/groups/:group_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags", ":tag_name" ], "variable": [ { "key": "group_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-39cc3483-2e06-4b76-81a8-01849e38801b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f866d4d9-da93-4978-b97e-a6fc9d62258b" } ], "id": "2da8141b-195b-4e37-ba92-f6719a596042", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2da8141b-195b-4e37-ba92-f6719a596042" }, { "name": "Update Group Tags", "id": "85687fbd-f696-49a4-9084-3da8b48a03b6", "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}}/groups/:group_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags" ], "variable": [ { "id": "5318ecf5-5410-4aca-ad58-1184b95fe145", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." } ] }, "description": "Adds/updates tags of specified configuration group." }, "response": [ { "id": "03d9da9a-2757-49ee-bfaa-601b5c6b7dc4", "name": "The group 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}}/groups/:group_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags" ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"sint4\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"velit23a\": \"\",\n \"sunt_2e6\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-03d9da9a-2757-49ee-bfaa-601b5c6b7dc4" }, { "id": "dd54866c-ccab-4684-8e9d-ff39b74184d3", "name": "The specified group 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}}/groups/:group_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id", "tags" ], "variable": [ { "key": "group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dd54866c-ccab-4684-8e9d-ff39b74184d3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-85687fbd-f696-49a4-9084-3da8b48a03b6" } ], "id": "b942a4d9-c8cf-4acc-9232-04f1cad7034a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b942a4d9-c8cf-4acc-9232-04f1cad7034a" }, { "name": "Delete Group", "id": "54c68688-d0fc-4fe7-b982-1b9af5852449", "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}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "id": "adda2d99-3651-44b5-9aad-6f00daeb36f1", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." } ] }, "description": "Deletes the group specified by Group ID." }, "response": [ { "id": "8aa86c49-1133-4a5c-bf02-bed6d0f938ba", "name": "Deletion of specified group complete.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8aa86c49-1133-4a5c-bf02-bed6d0f938ba" }, { "id": "ebcf4933-1903-4a5a-b6c9-d6e77842fe95", "name": "The specified group 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}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ebcf4933-1903-4a5a-b6c9-d6e77842fe95" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-54c68688-d0fc-4fe7-b982-1b9af5852449" }, { "name": "Get Group", "id": "5bd0993c-6635-42c6-a199-8338f8b421a8", "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}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "id": "7f0387e4-b65c-41b1-b095-f2e28b8c921e", "key": "group_id", "value": "", "description": "(Required) ID of the target Group." } ] }, "description": "Returns the group specified by the group ID." }, "response": [ { "id": "a7eac6cb-26c4-4558-8c5c-1dde3ac22dcf", "name": "Specified Group.", "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}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"sint4\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"velit23a\": \"\",\n \"sunt_2e6\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a7eac6cb-26c4-4558-8c5c-1dde3ac22dcf" }, { "id": "b6ba7af3-4338-45dd-857d-da1a33db41d5", "name": "The specified group 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}}/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "groups", ":group_id" ], "variable": [ { "key": "group_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b6ba7af3-4338-45dd-857d-da1a33db41d5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5bd0993c-6635-42c6-a199-8338f8b421a8" } ], "id": "4235d23a-01d0-41d7-9428-c893b8831218", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4235d23a-01d0-41d7-9428-c893b8831218" }, { "name": "List Groups.", "id": "f5f1c419-5dc5-42c8-a3c5-d1ab200e06d2", "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}}/groups?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "groups" ], "query": [ { "description": "Tag name of the group. Filters through all groups that exactly match the tag name. When tag_name is specified, tag_value is required.", "key": "tag_name", "value": "" }, { "description": "Tag value of the groups.", "key": "tag_value", "value": "" }, { "description": "Search criteria for tag strings (`tag_value`).", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last Group ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next group onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of Groups." }, "response": [ { "id": "b56105ef-bf34-4634-a695-dffc22a295c0", "name": "A list of groups.", "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}}/groups?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "groups" ], "query": [ { "description": "Tag name of the group. Filters through all groups that exactly match the tag name. When tag_name is specified, tag_value is required.", "key": "tag_name", "value": "" }, { "description": "Tag value of the groups.", "key": "tag_value", "value": "" }, { "description": "Search criteria for tag strings (`tag_value`).", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last Group ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next group 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 \"configuration\": {\n \"consectetur_6a\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"cillum_3\": \"\"\n }\n },\n {\n \"configuration\": {\n \"consectetur_9\": {},\n \"sunt1c\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"minima\": \"\",\n \"veniama\": \"\",\n \"ute9\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b56105ef-bf34-4634-a695-dffc22a295c0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f5f1c419-5dc5-42c8-a3c5-d1ab200e06d2" }, { "name": "Create Group", "id": "69edd6b8-b279-4a9f-a0c1-5e7ca3036022", "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 \"configuration\": {\n \"quis975\": {}\n },\n \"tags\": {\n \"fugiat4\": \"\",\n \"non_6\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] }, "description": "Create a new group." }, "response": [ { "id": "2f82c8e9-88a7-459d-8273-36e2687efd6d", "name": "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 \"configuration\": {\n \"quis975\": {}\n },\n \"tags\": {\n \"fugiat4\": \"\",\n \"non_6\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/groups", "host": [ "{{baseUrl}}" ], "path": [ "groups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"sint4\": {}\n },\n \"createdTime\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"velit23a\": \"\",\n \"sunt_2e6\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2f82c8e9-88a7-459d-8273-36e2687efd6d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-69edd6b8-b279-4a9f-a0c1-5e7ca3036022" } ], "id": "b3883b19-db53-4a23-a721-4bd704e4e531", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b3883b19-db53-4a23-a721-4bd704e4e531" }, { "name": "lagoon", "item": [ { "name": "image", "item": [ { "name": "link", "item": [ { "name": "Get a custom icon image link of Soracom Lagoon Console", "id": "b5e4b087-6e4b-4352-9814-d6e619a6bd46", "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}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] }, "description": "Get a custom icon image link of Soracom Lagoon Console." }, "response": [ { "id": "63ab953b-a16d-4cab-bf41-ec444854d3af", "name": "OK.", "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}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-63ab953b-a16d-4cab-bf41-ec444854d3af" }, { "id": "5f19c259-b680-4738-b5bf-c39551b6a0e2", "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}}/lagoon/image/link", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "image", "link" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5f19c259-b680-4738-b5bf-c39551b6a0e2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b5e4b087-6e4b-4352-9814-d6e619a6bd46" } ], "id": "2fd1c3f9-3109-43ac-bc09-83ae05b4a86f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2fd1c3f9-3109-43ac-bc09-83ae05b4a86f" } ], "id": "8439eeed-6093-4221-a32e-a903c7f4a64a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8439eeed-6093-4221-a32e-a903c7f4a64a" }, { "name": "license_packs", "item": [ { "name": "Get the status of active Soracom Lagoon license packs", "id": "217c3515-4679-4de2-a802-59c7b089082e", "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}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] }, "description": "Get the status of active Soracom Lagoon license packs." }, "response": [ { "id": "d66bd6cc-eee0-4fe3-a7c1-3ec5eada7425", "name": "OK.", "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}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"licensePackName\": \"\",\n \"quantity\": \"\"\n },\n {\n \"licensePackName\": \"\",\n \"quantity\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d66bd6cc-eee0-4fe3-a7c1-3ec5eada7425" }, { "id": "250a83b6-c097-4ddf-853e-66580ae21d9a", "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}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-250a83b6-c097-4ddf-853e-66580ae21d9a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-217c3515-4679-4de2-a802-59c7b089082e" }, { "name": "Update the quantities for license packs of Soracom Lagoon", "id": "fd778894-c437-44b2-afcf-2b2e7803dc18", "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" } ], "body": { "mode": "raw", "raw": "{\n \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicDashboard\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] }, "description": "Update the quantities for license packs of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials.\n" }, "response": [ { "id": "f998361d-0503-436e-9408-470f6c779f43", "name": "Updated.", "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 \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicDashboard\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f998361d-0503-436e-9408-470f6c779f43" }, { "id": "d518ac35-1db3-4449-aa47-fce17d19ab10", "name": "Bad request.", "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 \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicDashboard\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d518ac35-1db3-4449-aa47-fce17d19ab10" }, { "id": "12a0f997-9d09-4236-b846-af0144818196", "name": "Operator not 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 \"licensePackQuantities\": [\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicDashboard\"\n },\n {\n \"desiredQuantity\": \"\",\n \"licensePackName\": \"basicUser\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "license_packs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-12a0f997-9d09-4236-b846-af0144818196" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fd778894-c437-44b2-afcf-2b2e7803dc18" } ], "id": "668d6341-752a-40e6-b53e-3006b4c7e26e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-668d6341-752a-40e6-b53e-3006b4c7e26e" }, { "name": "plan", "item": [ { "name": "Update the plan of Soracom Lagoon", "id": "4a39e417-51e4-4fb1-8b67-ea3df85df939", "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" } ], "body": { "mode": "raw", "raw": "{\n \"plan\": \"pro\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] }, "description": "Update the plan of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials.\n" }, "response": [ { "id": "1629c9d5-16fd-4c38-ac4e-7c16a3ef56b2", "name": "Updated.", "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 \"plan\": \"pro\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1629c9d5-16fd-4c38-ac4e-7c16a3ef56b2" }, { "id": "f67d5eee-76fd-4c71-97e1-a3967b363e54", "name": "Bad request.", "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 \"plan\": \"pro\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f67d5eee-76fd-4c71-97e1-a3967b363e54" }, { "id": "a631e4c3-8b81-4520-a2da-3ae7431877b4", "name": "Operator not 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 \"plan\": \"pro\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/plan", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "plan" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a631e4c3-8b81-4520-a2da-3ae7431877b4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4a39e417-51e4-4fb1-8b67-ea3df85df939" } ], "id": "bdd07abb-3e90-4bfb-a572-e5998ed5209c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bdd07abb-3e90-4bfb-a572-e5998ed5209c" }, { "name": "register", "item": [ { "name": "Register (activate) Soracom Lagoon", "id": "1bcdb198-4ef0-47cd-909e-36ecf8f6bc7b", "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 \"plan\": \"free\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] }, "description": "Register (activate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials.\n" }, "response": [ { "id": "071eff8a-45d1-4302-9bad-a9c82d5327a3", "name": "Registered.", "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 \"plan\": \"free\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"lagoonUserEmail\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-071eff8a-45d1-4302-9bad-a9c82d5327a3" }, { "id": "37921f93-17b2-429e-a339-bf34af007e92", "name": "Bad request.", "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 \"plan\": \"free\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/register", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-37921f93-17b2-429e-a339-bf34af007e92" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1bcdb198-4ef0-47cd-909e-36ecf8f6bc7b" } ], "id": "69870c05-e2f4-41d4-936b-f04b709ef18b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-69870c05-e2f4-41d4-936b-f04b709ef18b" }, { "name": "terminate", "item": [ { "name": "Terminate (deactivate) Soracom Lagoon", "id": "5c1b6e74-5a70-42d0-ad53-b9a99d490089", "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}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] }, "description": "Terminate (deactivate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials.\n" }, "response": [ { "id": "2a50a345-776e-4dd3-8f4b-c5a3f2a7eefe", "name": "Terminated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a50a345-776e-4dd3-8f4b-c5a3f2a7eefe" }, { "id": "da88e1c9-3bbe-4de0-a909-f6c547ddfc5d", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-da88e1c9-3bbe-4de0-a909-f6c547ddfc5d" }, { "id": "3c99f27d-7d78-48ef-932d-a46ca84c2576", "name": "Operator not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "terminate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3c99f27d-7d78-48ef-932d-a46ca84c2576" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c1b6e74-5a70-42d0-ad53-b9a99d490089" } ], "id": "33196f76-227b-426a-b1fa-ccbf42def582", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-33196f76-227b-426a-b1fa-ccbf42def582" }, { "name": "users", "item": [ { "name": "{lagoon_user_id}", "item": [ { "name": "email", "item": [ { "name": "Update email address of a Soracom Lagoon user", "id": "b0306a93-88f3-41b8-b070-38cc38a30185", "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" } ], "body": { "mode": "raw", "raw": "{\n \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "id": "efe3f32e-c094-4fc9-8ef1-acf419206430", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update email address of a Soracom Lagoon user." }, "response": [ { "id": "80f03a96-2791-40e4-8bd9-dcf079033cf7", "name": "OK.", "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 \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-80f03a96-2791-40e4-8bd9-dcf079033cf7" }, { "id": "a4a063d5-ef47-43b9-903e-d564a00957ff", "name": "Bad request.", "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 \"userEmail\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/email", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "email" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a4a063d5-ef47-43b9-903e-d564a00957ff" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b0306a93-88f3-41b8-b070-38cc38a30185" } ], "id": "b4783de0-e939-4f2b-b258-33a5561bffe8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b4783de0-e939-4f2b-b258-33a5561bffe8" }, { "name": "password", "item": [ { "name": "Update password of a Soracom Lagoon user", "id": "2b0f1d4d-304c-472d-bf2a-20bfa3ba248f", "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" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "id": "3e189535-a105-494f-9877-36ecf3bb72a0", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update password of a Soracom Lagoon user." }, "response": [ { "id": "9faaea4a-4493-437b-a7e7-1279466bc670", "name": "OK.", "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 \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9faaea4a-4493-437b-a7e7-1279466bc670" }, { "id": "8aa387e2-ec46-4107-a933-1531cc7bbb84", "name": "Bad request.", "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 \"newPassword\": \"\",\n \"oldPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "password" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8aa387e2-ec46-4107-a933-1531cc7bbb84" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2b0f1d4d-304c-472d-bf2a-20bfa3ba248f" } ], "id": "54456cc8-5391-47c7-a16e-401df48185f9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-54456cc8-5391-47c7-a16e-401df48185f9" }, { "name": "permission", "item": [ { "name": "Update permission of a Soracom Lagoon user", "id": "4caa8b9e-6015-42e2-a706-3a792dda8214", "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" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"Editor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "id": "f51e71bc-ac67-4de3-80a3-10babefe6b5f", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Update permission of a Soracom Lagoon user." }, "response": [ { "id": "50fa8ed9-8698-4663-a11e-6e436f7be4bf", "name": "OK.", "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 \"role\": \"Editor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-50fa8ed9-8698-4663-a11e-6e436f7be4bf" }, { "id": "19c80349-6f4b-4943-bbb9-022b28b34359", "name": "Bad request.", "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 \"role\": \"Editor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id/permission", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id", "permission" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-19c80349-6f4b-4943-bbb9-022b28b34359" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4caa8b9e-6015-42e2-a706-3a792dda8214" } ], "id": "1aab401f-9056-47f8-b55a-e94439807812", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1aab401f-9056-47f8-b55a-e94439807812" }, { "name": "Delete a Soracom Lagoon user", "id": "58e33b2b-0892-4b1a-bd6d-6adceae215d8", "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}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "id": "72c269f4-77af-435b-aca1-aa632bcd7942", "key": "lagoon_user_id", "value": "", "description": "(Required) Target ID of the lagoon user." } ] }, "description": "Delete a Soracom Lagoon user." }, "response": [ { "id": "5526e06b-6594-4880-975b-cfaa8b997c8a", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5526e06b-6594-4880-975b-cfaa8b997c8a" }, { "id": "2ab09bda-947c-4b0e-9ef8-c8be4e3d2288", "name": "Bad request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lagoon/users/:lagoon_user_id", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users", ":lagoon_user_id" ], "variable": [ { "key": "lagoon_user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2ab09bda-947c-4b0e-9ef8-c8be4e3d2288" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-58e33b2b-0892-4b1a-bd6d-6adceae215d8" } ], "id": "3f3e470a-465d-4bb2-9c50-79b8e85bd690", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3f3e470a-465d-4bb2-9c50-79b8e85bd690" }, { "name": "List Soracom Lagoon users that belong to operator", "id": "0aaa0835-11a2-425a-afe5-10880aae7d5d", "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}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] }, "description": "List Soracom Lagoon users that belong to operator." }, "response": [ { "id": "1c4b2fd2-69e9-4640-914b-f20546de9656", "name": "OK.", "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}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"email\": \"\",\n \"id\": \"\",\n \"lastSeenAt\": \"\",\n \"lastSeenAtAge\": \"\",\n \"role\": \"Viewer\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"lastSeenAt\": \"\",\n \"lastSeenAtAge\": \"\",\n \"role\": \"Viewer\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c4b2fd2-69e9-4640-914b-f20546de9656" }, { "id": "3c1dd743-2ce8-410f-829c-be56445c513c", "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}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3c1dd743-2ce8-410f-829c-be56445c513c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0aaa0835-11a2-425a-afe5-10880aae7d5d" }, { "name": "Create a Soracom Lagoon user", "id": "9a223d43-b631-46a8-bc08-080372d1a841", "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 \"role\": \"Editor\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] }, "description": "Create a Soracom Lagoon user." }, "response": [ { "id": "0b3f8b9d-1551-4e26-a013-c682a77e9987", "name": "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 \"role\": \"Editor\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0b3f8b9d-1551-4e26-a013-c682a77e9987" }, { "id": "c5d3f9e9-c3ef-4b1b-aeeb-9afb80ab9764", "name": "Bad request.", "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 \"role\": \"Editor\",\n \"userEmail\": \"\",\n \"userPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lagoon/users", "host": [ "{{baseUrl}}" ], "path": [ "lagoon", "users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c5d3f9e9-c3ef-4b1b-aeeb-9afb80ab9764" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9a223d43-b631-46a8-bc08-080372d1a841" } ], "id": "229d5b46-ec34-4f53-91db-72b1ddf74779", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-229d5b46-ec34-4f53-91db-72b1ddf74779" } ], "id": "f51f07d6-f2ec-4f53-ae8a-2b99fcc38c66", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f51f07d6-f2ec-4f53-ae8a-2b99fcc38c66" }, { "name": "logs", "item": [ { "name": "Retrieve Error Logs", "id": "c16b8660-4eb7-4c25-8cc1-3c516f48da7d", "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}}/logs?resource_type=SigfoxDevice&resource_id=&service=Orbit&from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "logs" ], "query": [ { "description": "The type of resource for which to retrieve error logs.\n\n- `Subscriber`: IoT SIM.\n- `Device`: Inventory device.\n- `LoraDevice`: LoRaWAN device.\n- `SigfoxDevice`: Sigfox device.\n", "key": "resource_type", "value": "SigfoxDevice" }, { "description": "The ID of the resource for which to retrieve error logs. The ID to specify varies depending on the value of `resource_type`.\n\n| `resource_type` | ID to specify |\n|-|-|\n| `Subscriber` | The IMSI of the IoT SIM. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims). |\n| `Device` | The ID of the Inventory device. The ID can be obtained from the [Device:listDevices API](#!/Device/listDevices). |\n| `LoraDevice` | The ID of the LoRaWAN device. The ID can be obtained from the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices). |\n| `SigfoxDevice` | The ID of the Sigfox device. The ID can be obtained from the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices). |\n", "key": "resource_id", "value": "" }, { "description": "The service name to filter error logs.\n\n- `Air`: SORACOM Air\n- `Beam`: SORACOM Beam\n- `Funk`: SORACOM Funk\n- `Funnel`: SORACOM Funnel\n- `Harvest`: SORACOM Harvest Data/Files\n- `Napter`: SORACOM Napter\n- `Orbit`: SORACOM Orbit\n- `Unified`: Unified Endpoint\n", "key": "service", "value": "Orbit" }, { "description": "Start time of the period for which to retrieve error logs (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the period for which to retrieve error logs (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "The maximum number of error logs to retrieve.", "key": "limit", "value": "" }, { "description": "The value contained in the `x-soracom-next-key` header returned when fetching the previous page. Specify this to retrieve the next page. For more information, see [Retrieving Large Amounts of Data (Paging)](/en/docs/tools/api/paging/).", "key": "last_evaluated_key", "value": "" } ] }, "description": "Fetches error logs that meet specified criteria. If the error logs exceed one page, a URL to retrieve the next page under the same conditions is included in the `link` header of the response.\n" }, "response": [ { "id": "f2cdbe79-1a3c-42bc-9e1b-08be0f0ee32f", "name": "A list of error logs.", "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}}/logs?resource_type=SigfoxDevice&resource_id=&service=Orbit&from=&to=&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "logs" ], "query": [ { "description": "The type of resource for which to retrieve error logs.\n\n- `Subscriber`: IoT SIM.\n- `Device`: Inventory device.\n- `LoraDevice`: LoRaWAN device.\n- `SigfoxDevice`: Sigfox device.\n", "key": "resource_type", "value": "SigfoxDevice" }, { "description": "The ID of the resource for which to retrieve error logs. The ID to specify varies depending on the value of `resource_type`.\n\n| `resource_type` | ID to specify |\n|-|-|\n| `Subscriber` | The IMSI of the IoT SIM. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims). |\n| `Device` | The ID of the Inventory device. The ID can be obtained from the [Device:listDevices API](#!/Device/listDevices). |\n| `LoraDevice` | The ID of the LoRaWAN device. The ID can be obtained from the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices). |\n| `SigfoxDevice` | The ID of the Sigfox device. The ID can be obtained from the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices). |\n", "key": "resource_id", "value": "" }, { "description": "The service name to filter error logs.\n\n- `Air`: SORACOM Air\n- `Beam`: SORACOM Beam\n- `Funk`: SORACOM Funk\n- `Funnel`: SORACOM Funnel\n- `Harvest`: SORACOM Harvest Data/Files\n- `Napter`: SORACOM Napter\n- `Orbit`: SORACOM Orbit\n- `Unified`: Unified Endpoint\n", "key": "service", "value": "Orbit" }, { "description": "Start time of the period for which to retrieve error logs (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the period for which to retrieve error logs (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "The maximum number of error logs to retrieve.", "key": "limit", "value": "" }, { "description": "The value contained in the `x-soracom-next-key` header returned when fetching the previous page. Specify this to retrieve the next page. For more information, see [Retrieving Large Amounts of Data (Paging)](/en/docs/tools/api/paging/).", "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 \"body\": {},\n \"logLevel\": \"info\",\n \"operatorId\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"Device\",\n \"service\": \"Air\",\n \"time\": \"\"\n },\n {\n \"body\": {},\n \"logLevel\": \"debug\",\n \"operatorId\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SigfoxDevice\",\n \"service\": \"Orbit\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f2cdbe79-1a3c-42bc-9e1b-08be0f0ee32f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c16b8660-4eb7-4c25-8cc1-3c516f48da7d" } ], "id": "78d05d63-171e-4c94-a027-2c96cad5776f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-78d05d63-171e-4c94-a027-2c96cad5776f" }, { "name": "lora_devices", "item": [ { "name": "{device_id}", "item": [ { "name": "data", "item": [ { "name": "Retrieves data sent from a LoRaWAN device to Harvest Data", "id": "08427ff6-0f31-49cf-ac06-67c617b6b9aa", "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}}/lora_devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "05b89b77-f8cd-4893-9407-d7355b53e5b2", "key": "device_id", "value": "", "description": "(Required) ID of the LoRaWAN device from which to retrieve data. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." } ] }, "description": "Retrieves data that matches the specified conditions from the data sent by the specified LoRaWAN device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, "response": [ { "id": "dc106c2b-9aaa-433e-b82f-e0718585cdb8", "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}}/lora_devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "device_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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc106c2b-9aaa-433e-b82f-e0718585cdb8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-08427ff6-0f31-49cf-ac06-67c617b6b9aa" }, { "name": "Send data to a LoRaWAN device.", "id": "5f76fe5e-9ece-48c1-adf9-7982f0e6a1ed", "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" } ], "body": { "mode": "raw", "raw": "{\n \"data\": \"\",\n \"fPort\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "variable": [ { "id": "8f8d46fa-5f22-4521-9b15-0065c9955c28", "key": "device_id", "value": "", "description": "(Required) ID of the recipient device." } ] }, "description": "Sends data to the specified LoRaWAN device. The data is sent to the LoRa network server, to be sent out to the device using the next available slot. If another message destined for the same LoRaWAN device ID is already waiting to be sent on the LoRa Network Server, the existing message will be discarded, and the new message will be sent instead. Data is discarded if it is not received by the device for a certain period of time (2 hours)." }, "response": [ { "id": "c92c4d1e-bca4-40e7-91e9-a7f13b544377", "name": "Data has been received and sent to the LoRa network server for the recipient device to retrieve.", "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 \"data\": \"\",\n \"fPort\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c92c4d1e-bca4-40e7-91e9-a7f13b544377" }, { "id": "75d5da92-9959-4705-9b21-9f04e8d0418e", "name": "The payload JSON data contains one or more invalid parameters.", "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 \"data\": \"\",\n \"fPort\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-75d5da92-9959-4705-9b21-9f04e8d0418e" }, { "id": "e81a63f0-e4f5-48db-8120-50b1789a904a", "name": "No such device 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 \"data\": \"\",\n \"fPort\": 2\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e81a63f0-e4f5-48db-8120-50b1789a904a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5f76fe5e-9ece-48c1-adf9-7982f0e6a1ed" } ], "id": "f6cf5de3-9049-4b82-b397-2fc387ea9f6c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6cf5de3-9049-4b82-b397-2fc387ea9f6c" }, { "name": "disable_termination", "item": [ { "name": "Disable Termination of LoRaWAN device.", "id": "ca1b36de-5bd8-4a4d-8256-a4fd42f07293", "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}}/lora_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "disable_termination" ], "variable": [ { "id": "cc5f2545-9a47-4c50-8edd-c5400158b84b", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Disables termination of specified LoRaWAN device." }, "response": [ { "id": "8b4e5b5d-fd51-4c16-bf8d-a0e858120bf7", "name": "The LoRaWAN device'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}}/lora_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "disable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8b4e5b5d-fd51-4c16-bf8d-a0e858120bf7" }, { "id": "a10127db-3445-4b48-898b-f4dca2e61018", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "disable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a10127db-3445-4b48-898b-f4dca2e61018" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ca1b36de-5bd8-4a4d-8256-a4fd42f07293" } ], "id": "39fd91e4-c831-4103-9c83-0ead37c1a689", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-39fd91e4-c831-4103-9c83-0ead37c1a689" }, { "name": "enable_termination", "item": [ { "name": "Enable Termination of LoRaWAN device.", "id": "0f22dee5-b054-4fb1-8777-62937009852b", "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}}/lora_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "enable_termination" ], "variable": [ { "id": "bb75dc21-a11b-4e1e-81e6-a23368c2873c", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Enables termination of specified LoRaWAN device." }, "response": [ { "id": "1ea7cf7e-eaef-4a37-8da1-8b62df20caf9", "name": "The LoRaWAN device'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}}/lora_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "enable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1ea7cf7e-eaef-4a37-8da1-8b62df20caf9" }, { "id": "98712b1e-3509-41d7-88f3-8a102341d323", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "enable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-98712b1e-3509-41d7-88f3-8a102341d323" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0f22dee5-b054-4fb1-8777-62937009852b" } ], "id": "0d71e571-3a39-4537-9a0d-b41b0a3147a3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0d71e571-3a39-4537-9a0d-b41b0a3147a3" }, { "name": "register", "item": [ { "name": "Register LoRaWAN device.", "id": "99c7fa51-8511-40f3-87f3-9c2bfe153de1", "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 \"registrationSecret\": \"\",\n \"tags\": {\n \"amet_89_\": \"\",\n \"ex0d\": \"\",\n \"anim_8\": \"\",\n \"dolore_b8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/register", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "register" ], "variable": [ { "id": "2bfbcfc2-91fa-45f0-ba16-c378cf8cf5e1", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Register a LoRaWAN device." }, "response": [ { "id": "4f3f9b5e-d8a6-40ba-9cb0-9356a935859f", "name": "LoRaWAN device 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 \"groupId\": \"\",\n \"registrationSecret\": \"\",\n \"tags\": {\n \"amet_89_\": \"\",\n \"ex0d\": \"\",\n \"anim_8\": \"\",\n \"dolore_b8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/register", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "register" ], "variable": [ { "key": "device_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4f3f9b5e-d8a6-40ba-9cb0-9356a935859f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-99c7fa51-8511-40f3-87f3-9c2bfe153de1" } ], "id": "649716d4-54d2-446c-bae6-e8aff8d2916d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-649716d4-54d2-446c-bae6-e8aff8d2916d" }, { "name": "set_group", "item": [ { "name": "Adds a LoRaWAN device to a LoRaWAN group", "id": "4a6221cd-1daf-473e-9f49-af81b55c9cff", "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}}/lora_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "set_group" ], "variable": [ { "id": "4aaf928c-f180-410a-bf8d-cc178f3da6eb", "key": "device_id", "value": "", "description": "(Required) ID of the target LoRaWAN device. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." } ] }, "description": "Adds a LoRaWAN device to a LoRaWAN group." }, "response": [ { "id": "bf46c742-18da-48f3-b550-a71ad056565b", "name": "Detailed information of the updated LoRaWAN 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 \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bf46c742-18da-48f3-b550-a71ad056565b" }, { "id": "bce64d75-3f48-41d2-9948-ca2ce4c801d2", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bce64d75-3f48-41d2-9948-ca2ce4c801d2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4a6221cd-1daf-473e-9f49-af81b55c9cff" } ], "id": "df40bc2c-ad45-4579-b7a8-8060a57c8114", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-df40bc2c-ad45-4579-b7a8-8060a57c8114" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete LoRaWAN device Tag.", "id": "194e0453-af57-455e-9c1b-5e5d8d9c1655", "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}}/lora_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "id": "0bf31046-7c86-4b3c-99e7-883314a2081d", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." }, { "id": "c0ed0dab-58e2-48de-b4ca-5e679ac8b98a", "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 LoRaWAN device." }, "response": [ { "id": "c1329d5d-f00c-469f-bb61-45c9b7b69da3", "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}}/lora_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c1329d5d-f00c-469f-bb61-45c9b7b69da3" }, { "id": "96402051-0272-4804-8bcb-9b20431e0987", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-96402051-0272-4804-8bcb-9b20431e0987" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-194e0453-af57-455e-9c1b-5e5d8d9c1655" } ], "id": "cb14aa84-99a8-4f67-8ac6-6efb82b8f359", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cb14aa84-99a8-4f67-8ac6-6efb82b8f359" }, { "name": "Bulk Insert or Update LoRaWAN device Tags.", "id": "17b1fcb2-3f3b-4505-b7b0-4b356c5d4d57", "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}}/lora_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags" ], "variable": [ { "id": "9d39775f-c6ba-46ff-b59b-961b0a206d42", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Inserts/updates tags for the specified LoRaWAN device." }, "response": [ { "id": "a2b5ac38-86c4-49f2-b598-3b57304bbd4c", "name": "The LoRaWAN device'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}}/lora_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a2b5ac38-86c4-49f2-b598-3b57304bbd4c" }, { "id": "4c3c90ff-90db-4dcb-9d12-24677c3d9ee8", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4c3c90ff-90db-4dcb-9d12-24677c3d9ee8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-17b1fcb2-3f3b-4505-b7b0-4b356c5d4d57" } ], "id": "5a21866f-8577-4d3e-bfa5-d41a041e90b5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5a21866f-8577-4d3e-bfa5-d41a041e90b5" }, { "name": "terminate", "item": [ { "name": "Terminate LoRaWAN device.", "id": "89901545-dd4f-4166-bba8-b08a544a30cb", "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}}/lora_devices/:device_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "terminate" ], "variable": [ { "id": "919b65eb-4b9b-4a6c-92e5-9d2baee8a4ad", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Terminates the specified LoRaWAN device." }, "response": [ { "id": "ec2cf7b4-43a8-48d3-9fb9-bacf773bfde3", "name": "The LoRaWAN device'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}}/lora_devices/:device_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "terminate" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ec2cf7b4-43a8-48d3-9fb9-bacf773bfde3" }, { "id": "c7af778d-7832-43a1-818f-da6c94d153a4", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "terminate" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c7af778d-7832-43a1-818f-da6c94d153a4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-89901545-dd4f-4166-bba8-b08a544a30cb" } ], "id": "0feeeb56-a1cb-429e-bd65-58b8d738fc92", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0feeeb56-a1cb-429e-bd65-58b8d738fc92" }, { "name": "unset_group", "item": [ { "name": "Removes a LoRaWAN device from a LoRaWAN group", "id": "d52ef49c-7ede-4c49-bd74-9d1f45d2d133", "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}}/lora_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "unset_group" ], "variable": [ { "id": "12858ddc-e2c6-46a9-9a9a-48928be8ca73", "key": "device_id", "value": "", "description": "(Required) ID of the target LoRaWAN device. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." } ] }, "description": "Removes a LoRaWAN device from a LoRaWAN group." }, "response": [ { "id": "85e5dc0c-a294-414a-b564-3803e032ee42", "name": "Detailed information of the updated LoRaWAN device.", "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}}/lora_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-85e5dc0c-a294-414a-b564-3803e032ee42" }, { "id": "5b4fc895-d75c-43e5-92e0-08df4ddecee2", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5b4fc895-d75c-43e5-92e0-08df4ddecee2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d52ef49c-7ede-4c49-bd74-9d1f45d2d133" } ], "id": "54ec2332-b2e8-40a9-822a-507b5bbc787c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-54ec2332-b2e8-40a9-822a-507b5bbc787c" }, { "name": "Get LoRaWAN device.", "id": "e56e93ed-5b32-4a76-a722-715978849790", "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}}/lora_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id" ], "variable": [ { "id": "115b25c9-149e-4016-97ee-2978979e7871", "key": "device_id", "value": "", "description": "(Required) Device ID of the target LoRaWAN device." } ] }, "description": "Returns information about the specified LoRaWAN device." }, "response": [ { "id": "075fd1bf-47af-45f4-9ef4-cc5d3d4a1f2a", "name": "The LoRaWAN device'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}}/lora_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-075fd1bf-47af-45f4-9ef4-cc5d3d4a1f2a" }, { "id": "dcde4978-9f33-400a-a997-32da2c82657b", "name": "The specified LoRaWAN device 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}}/lora_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dcde4978-9f33-400a-a997-32da2c82657b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e56e93ed-5b32-4a76-a722-715978849790" } ], "id": "8b2c849a-9f17-4fff-b0fd-8f054ab9965b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8b2c849a-9f17-4fff-b0fd-8f054ab9965b" }, { "name": "List LoRaWAN devices.", "id": "c3e6a200-432c-4b2b-bc05-f480d11b2125", "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}}/lora_devices?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices" ], "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": "Maximum number of LoRaWAN devices to retrieve.", "key": "limit", "value": "" }, { "description": "The device ID of the last LoRaWAN device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN device onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of LoRaWAN devices that match certain criteria. If the total number of LoRaWAN devices 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": "bb6cc478-82aa-4aa9-85a7-923e422b42f8", "name": "A list of LoRaWAN devices matching the criteria.", "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}}/lora_devices?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_devices" ], "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": "Maximum number of LoRaWAN devices to retrieve.", "key": "limit", "value": "" }, { "description": "The device ID of the last LoRaWAN device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN device 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 \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"sit_b8b\": \"\"\n },\n \"terminationEnabled\": false\n },\n {\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"idc\": \"\"\n },\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bb6cc478-82aa-4aa9-85a7-923e422b42f8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c3e6a200-432c-4b2b-bc05-f480d11b2125" } ], "id": "dac962ec-0c99-4612-a3f2-59fbf8843b00", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dac962ec-0c99-4612-a3f2-59fbf8843b00" }, { "name": "lora_gateways", "item": [ { "name": "{gateway_id}", "item": [ { "name": "disable_termination", "item": [ { "name": "Disable Termination of LoRaWAN gateway", "id": "e3a5116c-e715-4a57-97b2-338a04e0dd71", "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}}/lora_gateways/:gateway_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "disable_termination" ], "variable": [ { "id": "40367374-acb8-4b3d-9dfb-85e2a898c2a3", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Disables termination of specified LoRaWAN gateway." }, "response": [ { "id": "aae16ed7-593a-4f53-9438-78a418621c65", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "disable_termination" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aae16ed7-593a-4f53-9438-78a418621c65" }, { "id": "d2292f9c-4817-46b3-90a0-9df91820c1e7", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "disable_termination" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d2292f9c-4817-46b3-90a0-9df91820c1e7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e3a5116c-e715-4a57-97b2-338a04e0dd71" } ], "id": "8ca047b5-f735-46cc-b84b-b841457cced7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8ca047b5-f735-46cc-b84b-b841457cced7" }, { "name": "enable_termination", "item": [ { "name": "Enable Termination of LoRaWAN gateway", "id": "bbd5c1af-8897-4a91-9763-82d1cd88ebbf", "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}}/lora_gateways/:gateway_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "enable_termination" ], "variable": [ { "id": "07394710-0d5a-472c-a772-00aaecb3a87e", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Enables termination of specified LoRaWAN gateway." }, "response": [ { "id": "ba59b0de-0100-4dec-9c70-14eec70d6529", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "enable_termination" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ba59b0de-0100-4dec-9c70-14eec70d6529" }, { "id": "556da66d-86c6-44e1-ab85-c35f9b28e3a0", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "enable_termination" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-556da66d-86c6-44e1-ab85-c35f9b28e3a0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bbd5c1af-8897-4a91-9763-82d1cd88ebbf" } ], "id": "4a9cc712-6a98-4300-8297-d980762302f9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4a9cc712-6a98-4300-8297-d980762302f9" }, { "name": "set_network_set", "item": [ { "name": "Set Network Set ID of LoRaWAN gateway", "id": "b44d4c88-73c2-471e-b3ef-ac18954c5f32", "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 \"networkSetId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_gateways/:gateway_id/set_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "set_network_set" ], "variable": [ { "id": "a284757b-fcfd-4491-bf99-6657d0fedd4d", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Sets or overwrites network set ID for the specified LoRaWAN gateway." }, "response": [ { "id": "59db873f-e744-4038-980a-d39b22439ce1", "name": "The LoRaWAN gateway'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 \"networkSetId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_gateways/:gateway_id/set_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "set_network_set" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-59db873f-e744-4038-980a-d39b22439ce1" }, { "id": "160ecdbb-c170-4cad-8648-78c8b34fe7d3", "name": "The specified LoRaWAN gateway 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 \"networkSetId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_gateways/:gateway_id/set_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "set_network_set" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-160ecdbb-c170-4cad-8648-78c8b34fe7d3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b44d4c88-73c2-471e-b3ef-ac18954c5f32" } ], "id": "4caea201-3ba7-4924-b314-9a6837157c04", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4caea201-3ba7-4924-b314-9a6837157c04" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete LoRaWAN gateway tag", "id": "5f790410-760d-47a4-a2ff-edc670e2b221", "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}}/lora_gateways/:gateway_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags", ":tag_name" ], "variable": [ { "id": "84aefe3c-219a-442f-9344-465c6876f93c", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." }, { "id": "9e6d8455-89d3-48e3-986b-20e1f78d0502", "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 LoRaWAN gateway." }, "response": [ { "id": "22a704ea-ae29-4115-9931-d6efe4c48a6a", "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}}/lora_gateways/:gateway_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags", ":tag_name" ], "variable": [ { "key": "gateway_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-22a704ea-ae29-4115-9931-d6efe4c48a6a" }, { "id": "9ceaffe3-ef7a-43f3-8e35-b7a17c3adf10", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags", ":tag_name" ], "variable": [ { "key": "gateway_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9ceaffe3-ef7a-43f3-8e35-b7a17c3adf10" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5f790410-760d-47a4-a2ff-edc670e2b221" } ], "id": "27ab0386-48d2-45cf-936d-88d21c53705b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-27ab0386-48d2-45cf-936d-88d21c53705b" }, { "name": "Bulk Insert or Update LoRaWAN gateway Tags", "id": "8b491a66-0dcc-433f-b5bf-5d6638389618", "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}}/lora_gateways/:gateway_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags" ], "variable": [ { "id": "00276185-655e-4849-bb31-88e116e6efd1", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Inserts/updates tags for the specified LoRaWAN gateway." }, "response": [ { "id": "d66e94ae-51ee-45cc-adc5-9bdffb90f216", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d66e94ae-51ee-45cc-adc5-9bdffb90f216" }, { "id": "56ec945a-4561-4a9b-836b-518d6e5d286e", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "tags" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-56ec945a-4561-4a9b-836b-518d6e5d286e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8b491a66-0dcc-433f-b5bf-5d6638389618" } ], "id": "e6867195-47c0-407e-a468-3b2239205714", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e6867195-47c0-407e-a468-3b2239205714" }, { "name": "terminate", "item": [ { "name": "Terminate LoRaWAN gateway", "id": "e3a25639-a323-4e03-8e66-2608a96dddc5", "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}}/lora_gateways/:gateway_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "terminate" ], "variable": [ { "id": "6d9170e8-3217-4cf5-a457-3223ce446491", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Terminates the specified LoRaWAN gateway." }, "response": [ { "id": "072f5062-f8e0-49be-83cf-232bcc207704", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "terminate" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-072f5062-f8e0-49be-83cf-232bcc207704" }, { "id": "3c067f32-e4c4-4655-b0b4-8e49304c7dbd", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "terminate" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3c067f32-e4c4-4655-b0b4-8e49304c7dbd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e3a25639-a323-4e03-8e66-2608a96dddc5" } ], "id": "0ba586c0-f919-4e4f-b6cd-e3296effb666", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0ba586c0-f919-4e4f-b6cd-e3296effb666" }, { "name": "unset_network_set", "item": [ { "name": "Unset Network Set ID of LoRaWAN gateway", "id": "1f0c3af3-8ad1-4c7a-a738-001efd53aae1", "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}}/lora_gateways/:gateway_id/unset_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "unset_network_set" ], "variable": [ { "id": "347f33fc-dbc1-40a7-bb85-515f51657235", "key": "gateway_id", "value": "", "description": "(Required) ID of the target LoRaWAN gateway." } ] }, "description": "Unset network set ID of the specified LoRaWAN gateway." }, "response": [ { "id": "94071949-4042-46f8-914e-a9666e27b347", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id/unset_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "unset_network_set" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-94071949-4042-46f8-914e-a9666e27b347" }, { "id": "a0e1b3a8-90c7-41bd-a2c8-f60e1620284f", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id/unset_network_set", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id", "unset_network_set" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a0e1b3a8-90c7-41bd-a2c8-f60e1620284f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1f0c3af3-8ad1-4c7a-a738-001efd53aae1" } ], "id": "38fb8d58-5cf5-452d-b9cb-d781bfbf74d2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-38fb8d58-5cf5-452d-b9cb-d781bfbf74d2" }, { "name": "Get LoRaWAN gateway", "id": "3ae70654-7dad-4ffa-bf8f-aa0b7c6bd3ff", "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}}/lora_gateways/:gateway_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id" ], "variable": [ { "id": "e1654d80-14f1-4edd-9688-5a830d1db655", "key": "gateway_id", "value": "", "description": "(Required) Gateway ID of the target LoRaWAN gateway." } ] }, "description": "Returns information about the specified LoRaWAN gateway." }, "response": [ { "id": "04525947-e277-4fcd-a794-9294b8ec4028", "name": "The LoRaWAN gateway'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}}/lora_gateways/:gateway_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"instock\",\n \"tags\": {\n \"et__\": \"\",\n \"qui38\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-04525947-e277-4fcd-a794-9294b8ec4028" }, { "id": "cc23209f-2b39-4766-927b-7823781a4b94", "name": "The specified LoRaWAN gateway 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}}/lora_gateways/:gateway_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways", ":gateway_id" ], "variable": [ { "key": "gateway_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cc23209f-2b39-4766-927b-7823781a4b94" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3ae70654-7dad-4ffa-bf8f-aa0b7c6bd3ff" } ], "id": "250e3e48-ffec-426b-a6ef-ce95599b7942", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-250e3e48-ffec-426b-a6ef-ce95599b7942" }, { "name": "List LoRaWAN Gateways", "id": "2dae71b0-a819-4539-93cd-ffa1ad5dc0c6", "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}}/lora_gateways?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways" ], "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": "Maximum number of LoRaWAN gateways to retrieve.", "key": "limit", "value": "" }, { "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of LoRaWAN gateways that match certain criteria. If the total number of LoRaWAN gateways 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": "8d8ae377-a7b5-47f9-b90b-d4a7a827c8ea", "name": "A list of LoRaWAN gateways.", "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}}/lora_gateways?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_gateways" ], "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": "Maximum number of LoRaWAN gateways to retrieve.", "key": "limit", "value": "" }, { "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway 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 \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"active\",\n \"tags\": {\n \"sint__8\": \"\"\n },\n \"terminationEnabled\": false\n },\n {\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"terminated\",\n \"tags\": {\n \"ad3\": \"\",\n \"in7\": \"\"\n },\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8d8ae377-a7b5-47f9-b90b-d4a7a827c8ea" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2dae71b0-a819-4539-93cd-ffa1ad5dc0c6" } ], "id": "b6abdac0-7b5d-4176-89d0-2865109a402a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b6abdac0-7b5d-4176-89d0-2865109a402a" }, { "name": "lora_network_sets", "item": [ { "name": "{ns_id}", "item": [ { "name": "add_permission", "item": [ { "name": "Adds permission to a LoRaWAN network set", "id": "e4a97b1c-95f1-4ca4-aa4d-2ea49ba4cb69", "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 \"operatorId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets/:ns_id/add_permission", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "add_permission" ], "variable": [ { "id": "5c48b9de-ab4b-4d55-b7ef-f199090fbb5b", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Adds permission to allow another operator to use the network set." }, "response": [ { "id": "eb33b07c-d977-4441-a44e-d7f5e0915242", "name": "Permission added to the network set.", "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 \"operatorId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets/:ns_id/add_permission", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "add_permission" ], "variable": [ { "key": "ns_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-eb33b07c-d977-4441-a44e-d7f5e0915242" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e4a97b1c-95f1-4ca4-aa4d-2ea49ba4cb69" } ], "id": "1ad61941-a378-466b-a5fe-0da80d87ad07", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1ad61941-a378-466b-a5fe-0da80d87ad07" }, { "name": "gateways", "item": [ { "name": "List LoRaWAN Gateways in a Network Set", "id": "ba6fb9fa-bc23-4b5e-a9b1-6f78f7bd1f6f", "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}}/lora_network_sets/:ns_id/gateways?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "gateways" ], "query": [ { "description": "Maximum number of LoRaWAN gateways to retrieve.", "key": "limit", "value": "" }, { "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "edca26ed-7df7-4421-81f8-8c534635f90d", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Returns a list of LoRaWAN gateways that belong to the specified network set. If the total number of LoRaWAN gateways 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": "fdb222bf-fd97-4e81-9ec5-5429358a62ff", "name": "A list of LoRaWAN gateways.", "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}}/lora_network_sets/:ns_id/gateways?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "gateways" ], "query": [ { "description": "Maximum number of LoRaWAN gateways to retrieve.", "key": "limit", "value": "" }, { "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "ns_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"active\",\n \"tags\": {\n \"sint__8\": \"\"\n },\n \"terminationEnabled\": false\n },\n {\n \"address\": \"\",\n \"createdTime\": \"\",\n \"gatewayId\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"online\": false,\n \"operatorId\": \"\",\n \"owned\": false,\n \"status\": \"terminated\",\n \"tags\": {\n \"ad3\": \"\",\n \"in7\": \"\"\n },\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fdb222bf-fd97-4e81-9ec5-5429358a62ff" }, { "id": "0fd13819-1315-4888-8006-52ebbd6c9346", "name": "The specified LoRaWAN network set 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}}/lora_network_sets/:ns_id/gateways?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "gateways" ], "query": [ { "description": "Maximum number of LoRaWAN gateways to retrieve.", "key": "limit", "value": "" }, { "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "ns_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0fd13819-1315-4888-8006-52ebbd6c9346" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ba6fb9fa-bc23-4b5e-a9b1-6f78f7bd1f6f" } ], "id": "150410b4-2c0c-467d-a813-698a4757d874", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-150410b4-2c0c-467d-a813-698a4757d874" }, { "name": "revoke_permission", "item": [ { "name": "Revokes a permission from a LoRaWAN network set", "id": "e0b08dae-fc7a-449a-9b12-781c0565e316", "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 \"operatorId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets/:ns_id/revoke_permission", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "revoke_permission" ], "variable": [ { "id": "def3d6ee-adcb-43e6-a5d7-15cef4393d7f", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Revokes a permission and removes an operator from the list of allowed operators in the network set." }, "response": [ { "id": "5a03348a-d2e2-4f1b-b4a1-9df7a1a10a33", "name": "Permission revoked from the network set.", "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 \"operatorId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets/:ns_id/revoke_permission", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "revoke_permission" ], "variable": [ { "key": "ns_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5a03348a-d2e2-4f1b-b4a1-9df7a1a10a33" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e0b08dae-fc7a-449a-9b12-781c0565e316" } ], "id": "8ca31fd4-8808-4bd7-a3d2-025d88278f7d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8ca31fd4-8808-4bd7-a3d2-025d88278f7d" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete LoRaWAN network set tag", "id": "592442ea-78d1-4f4a-ad4c-c8cfc79f77be", "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}}/lora_network_sets/:ns_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags", ":tag_name" ], "variable": [ { "id": "bfebe84a-6f67-45d6-81c8-17c9842b7a2e", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." }, { "id": "dc697d41-290f-4d59-920c-22a06aff444d", "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 LoRaWAN network set." }, "response": [ { "id": "20b7cfa6-7644-4ad2-9758-b49e648c3988", "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}}/lora_network_sets/:ns_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags", ":tag_name" ], "variable": [ { "key": "ns_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-20b7cfa6-7644-4ad2-9758-b49e648c3988" }, { "id": "a5ffea35-550e-407c-a5fd-4c03abaa394b", "name": "The specified LoRaWAN network set 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}}/lora_network_sets/:ns_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags", ":tag_name" ], "variable": [ { "key": "ns_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a5ffea35-550e-407c-a5fd-4c03abaa394b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-592442ea-78d1-4f4a-ad4c-c8cfc79f77be" } ], "id": "86aabb2b-2ddd-469c-ba7a-85e00e698800", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-86aabb2b-2ddd-469c-ba7a-85e00e698800" }, { "name": "Bulk Insert or Update LoRaWAN network set tags", "id": "a4aaf07c-e430-4c5a-9b21-a702601cdad7", "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}}/lora_network_sets/:ns_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags" ], "variable": [ { "id": "201f8d9e-106e-4459-af40-05db9eba075a", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Inserts/updates tags for the specified LoRaWAN network set." }, "response": [ { "id": "b420f32c-ffb2-48b8-998e-2f0d23a97a78", "name": "The LoRaWAN network set'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}}/lora_network_sets/:ns_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags" ], "variable": [ { "key": "ns_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b420f32c-ffb2-48b8-998e-2f0d23a97a78" }, { "id": "ba6263fe-7503-434a-a808-02dfda299688", "name": "The specified LoRaWAN network set 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}}/lora_network_sets/:ns_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id", "tags" ], "variable": [ { "key": "ns_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ba6263fe-7503-434a-a808-02dfda299688" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a4aaf07c-e430-4c5a-9b21-a702601cdad7" } ], "id": "a325e6b0-7a15-4625-a6bc-95eea30bd883", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a325e6b0-7a15-4625-a6bc-95eea30bd883" }, { "name": "Delete LoRaWAN network set", "id": "53c836e4-a596-449a-9e8f-9244e11e8352", "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}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "id": "ff0baaa2-ac3a-4a7d-be89-eef4993a91a2", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Deletes the specified LoRaWAN network set." }, "response": [ { "id": "2e117231-b4dc-4f54-88c4-e4769937ccbc", "name": "Successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "key": "ns_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2e117231-b4dc-4f54-88c4-e4769937ccbc" }, { "id": "468cc7ba-c3a3-413c-a6aa-599df7482288", "name": "The specified LoRaWAN network set 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}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "key": "ns_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-468cc7ba-c3a3-413c-a6aa-599df7482288" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-53c836e4-a596-449a-9e8f-9244e11e8352" }, { "name": "Get LoRaWAN network set", "id": "616d6a54-9a64-4644-b25e-70d78e858c06", "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}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "id": "89ce3767-eade-4e8c-aea9-bb660e60a6da", "key": "ns_id", "value": "", "description": "(Required) ID of the target LoRaWAN network set." } ] }, "description": "Returns information about the specified LoRaWAN network set." }, "response": [ { "id": "1d1e1ea0-9778-4ef9-a576-7f90a94009cc", "name": "The LoRaWAN network set'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}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "key": "ns_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1d1e1ea0-9778-4ef9-a576-7f90a94009cc" }, { "id": "a8b6ff93-8d7d-45fb-a624-1430c99f3e42", "name": "The specified LoRaWAN network set 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}}/lora_network_sets/:ns_id", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets", ":ns_id" ], "variable": [ { "key": "ns_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a8b6ff93-8d7d-45fb-a624-1430c99f3e42" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-616d6a54-9a64-4644-b25e-70d78e858c06" } ], "id": "8c59f220-9daa-405b-9e7e-ed29bda2e976", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8c59f220-9daa-405b-9e7e-ed29bda2e976" }, { "name": "List LoRaWAN Network Sets", "id": "cd920895-7a48-46ac-92e7-52c8aca6cf5c", "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}}/lora_network_sets?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets" ], "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": "Maximum number of LoRaWAN network set to retrieve.", "key": "limit", "value": "" }, { "description": "The ID of the last network set retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of LoRaWAN network sets that match certain criteria. If the total number of LoRaWAN network sets 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": "7f5c6908-0e4a-4413-ba1c-4c997377a72e", "name": "A list of LoRaWAN network sets.", "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}}/lora_network_sets?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets" ], "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": "Maximum number of LoRaWAN network set to retrieve.", "key": "limit", "value": "" }, { "description": "The ID of the last network set retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device 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 \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"ut_32\": \"\"\n }\n },\n {\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"in_b7e\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7f5c6908-0e4a-4413-ba1c-4c997377a72e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cd920895-7a48-46ac-92e7-52c8aca6cf5c" }, { "name": "Create a LoRaWAN network set", "id": "8299f058-d499-4e6c-b0f7-d5998fa0ebd7", "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 \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets" ] }, "description": "Creates a specified LoRaWAN network set." }, "response": [ { "id": "2ff94a82-cb99-4b13-8cbf-456badf9bbcd", "name": "A LoRaWAN network set was 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 \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lora_network_sets", "host": [ "{{baseUrl}}" ], "path": [ "lora_network_sets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"networkSetId\": \"\",\n \"operatorId\": \"\",\n \"tags\": {\n \"qui_e5c\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2ff94a82-cb99-4b13-8cbf-456badf9bbcd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8299f058-d499-4e6c-b0f7-d5998fa0ebd7" } ], "id": "ac816c5d-dcd7-402c-9e9e-0a87befbc22a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ac816c5d-dcd7-402c-9e9e-0a87befbc22a" }, { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "auth_keys", "item": [ { "name": "{auth_key_id}", "item": [ { "name": "Delete Operator AuthKey", "id": "17acd71f-96e9-4cbb-a1a5-c8b2489cb624", "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}}/operators/:operator_id/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "3f13f4e2-84e0-4548-9855-99e3c5d09003", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "227d8a47-639c-40c0-93a4-d83d30f78dc8", "key": "auth_key_id", "value": "", "description": "(Required) AuthKey ID." } ] }, "description": "Deletes an AuthKey from the operator." }, "response": [ { "id": "cbae695a-2a1f-47dc-a6c3-140086857243", "name": "AuthKey was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "auth_key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cbae695a-2a1f-47dc-a6c3-140086857243" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-17acd71f-96e9-4cbb-a1a5-c8b2489cb624" } ], "id": "c0263cdf-19f0-429a-93a6-ab7501910a56", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c0263cdf-19f0-429a-93a6-ab7501910a56" }, { "name": "List Operator AuthKeys", "id": "72af7081-29e9-4064-be0b-812e76a92a27", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "id": "a295ba56-ae77-48ba-8f7c-689898684e4f", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns the operator's AuthKey list." }, "response": [ { "id": "85cf9e8f-930b-4a4d-8ed2-cfc59465d1af", "name": "OK.", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-85cf9e8f-930b-4a4d-8ed2-cfc59465d1af" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-72af7081-29e9-4064-be0b-812e76a92a27" }, { "name": "Generate Operator AuthKey", "id": "0a872947-0e37-4f93-ad6f-fe86ced08732", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "id": "b80bb23b-e68b-42f3-a7cf-d31ce9e747e8", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Generates an AuthKey for the operator." }, "response": [ { "id": "46450697-2ce5-4348-9d23-f14518230f3f", "name": "AuthKey was generated.", "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}}/operators/:operator_id/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "auth_keys" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-46450697-2ce5-4348-9d23-f14518230f3f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0a872947-0e37-4f93-ad6f-fe86ced08732" } ], "id": "920c995d-9fb0-4c34-9e06-a009f5fb2781", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-920c995d-9fb0-4c34-9e06-a009f5fb2781" }, { "name": "company_information", "item": [ { "name": "Get company information", "id": "a057cac3-8665-468c-8edb-cb06606e400c", "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}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "113ad69c-0724-46e3-9f2a-618f15a93ba6", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets the operator's company information." }, "response": [ { "id": "8869dfdd-0328-4ac0-b24b-305ffa88e23c", "name": "OK.", "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}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8869dfdd-0328-4ac0-b24b-305ffa88e23c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a057cac3-8665-468c-8edb-cb06606e400c" }, { "name": "Create company information", "id": "35ced25f-eca7-4a92-abe1-b105b5eb376e", "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" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "9b56bd9b-e4af-4171-a7f0-52358cda6e2e", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates the operator's company information." }, "response": [ { "id": "d51343c1-7fd4-4967-a1db-77d8d8deade6", "name": "Created.", "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 \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d51343c1-7fd4-4967-a1db-77d8d8deade6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-35ced25f-eca7-4a92-abe1-b105b5eb376e" }, { "name": "Update company information", "id": "45797838-9432-46f1-82dd-17321e80fc8f", "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" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "id": "c373c09d-a71e-4178-a283-15466188f785", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's company information." }, "response": [ { "id": "e1ae7b5d-df4e-45e7-a567-28c4fb10f71e", "name": "OK.", "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 \"companyName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"department\": \"\",\n \"contactPersonName\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"vatIdentificationNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/company_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "company_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e1ae7b5d-df4e-45e7-a567-28c4fb10f71e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-45797838-9432-46f1-82dd-17321e80fc8f" } ], "id": "e0e07b33-0a57-43a4-af41-e9bf4adff5fd", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e0e07b33-0a57-43a4-af41-e9bf4adff5fd" }, { "name": "configuration", "item": [ { "name": "{namespace}", "item": [ { "name": "Delete operator configuration of the namespace", "id": "ebb29444-b57d-4ddf-ab03-185d263d07ce", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "ee85ee2d-e596-4aa2-be63-8e33e0650e31", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "e16704d6-1d3c-4016-b72b-387c2394b831", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Deletes operator configuration of the namespace." }, "response": [ { "id": "7836d9d0-e94e-4951-93a4-4c283e7b1665", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7836d9d0-e94e-4951-93a4-4c283e7b1665" }, { "id": "65b0b0eb-e5cf-4bab-8c0c-3ed0273c840c", "name": "Bad request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-65b0b0eb-e5cf-4bab-8c0c-3ed0273c840c" }, { "id": "a8083ae1-d78e-4e72-960d-379c2979a356", "name": "Configuration not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a8083ae1-d78e-4e72-960d-379c2979a356" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ebb29444-b57d-4ddf-ab03-185d263d07ce" }, { "name": "Get operator configuration of the namespace", "id": "dec532d1-195c-47ba-9954-62b836f6178f", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "a54faf4a-4540-41d6-8b29-03bf7f2e4462", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "23516843-7f21-4174-b85f-b40448877d58", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Gets operator configuration of the namespace." }, "response": [ { "id": "4445008e-5f0c-4df9-ba93-7b22dd0edbca", "name": "OK.", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"billing\": {\n \"attachInvoicePdfEnabled\": \"\"\n },\n \"notification\": {\n \"exceedBundleDisabled\": \"\"\n }\n },\n \"isModifiable\": \"\",\n \"namespace\": \"Support\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4445008e-5f0c-4df9-ba93-7b22dd0edbca" }, { "id": "9569fbd5-ced0-4b07-a3d5-03ffc29dddbd", "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}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9569fbd5-ced0-4b07-a3d5-03ffc29dddbd" }, { "id": "398fefc6-6a37-460c-b025-f65cc59d3d4e", "name": "Configuration not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-398fefc6-6a37-460c-b025-f65cc59d3d4e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dec532d1-195c-47ba-9954-62b836f6178f" }, { "name": "Set operator configuration of the namespace", "id": "f16c2e58-551b-4b99-86f5-09e270d4b9e1", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "id": "41112cbd-c620-43e8-99dc-ce4416bcc609", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "cb7cb7cb-3336-4e1c-87ae-09c1da535d94", "key": "namespace", "value": "", "description": "(Required) Namespace of operator configuration." } ] }, "description": "Sets operator configuration of the namespace." }, "response": [ { "id": "cc60191d-70ee-4280-93e3-6eb392724890", "name": "OK.", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"billing\": {\n \"attachInvoicePdfEnabled\": \"\"\n },\n \"notification\": {\n \"exceedBundleDisabled\": \"\"\n }\n },\n \"isModifiable\": \"\",\n \"namespace\": \"Support\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cc60191d-70ee-4280-93e3-6eb392724890" }, { "id": "2c2eeae5-a1c7-4dc9-92d1-bcccb5c77716", "name": "Bad request.", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2c2eeae5-a1c7-4dc9-92d1-bcccb5c77716" }, { "id": "f6afc706-0b54-4a43-ae45-485432ce0cd9", "name": "Update has been conflicted. Get the latest configuration, then update again.", "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 \"configuration\": {\n \"paymentCoverage\": \"jp\",\n \"tier\": \"basic\",\n \"upcomingTier\": \"enterprise\"\n },\n \"expectedVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/configuration/:namespace", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "configuration", ":namespace" ], "variable": [ { "key": "operator_id" }, { "key": "namespace" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f6afc706-0b54-4a43-ae45-485432ce0cd9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f16c2e58-551b-4b99-86f5-09e270d4b9e1" } ], "id": "aff0b70c-0508-45b1-89ed-0b1bacb9546c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-aff0b70c-0508-45b1-89ed-0b1bacb9546c" } ], "id": "e79410fe-1be4-44c6-89f6-0ce4e67ce502", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e79410fe-1be4-44c6-89f6-0ce4e67ce502" }, { "name": "contracts", "item": [ { "name": "{contract_name}", "item": [ { "name": "Delete Operator Contract", "id": "c643c47c-06b5-4344-9983-05f1a9b8e4fe", "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}}/operators/:operator_id/contracts/:contract_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts", ":contract_name" ], "variable": [ { "id": "f4bc1939-de31-4a98-9ee7-9f0cb9d669aa", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "c65be800-a5e9-42bf-a627-25d5de02d379", "key": "contract_name", "value": "api_audit_log", "description": "(Required) Contract name." } ] }, "description": "Deletes the operator's contract." }, "response": [ { "id": "8ee38f13-5466-41f5-850b-18fd3f035f2c", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts/:contract_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts", ":contract_name" ], "variable": [ { "key": "operator_id" }, { "key": "contract_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8ee38f13-5466-41f5-850b-18fd3f035f2c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c643c47c-06b5-4344-9983-05f1a9b8e4fe" } ], "id": "9fceef23-15f1-46c7-a4da-83e384ee02e3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9fceef23-15f1-46c7-a4da-83e384ee02e3" }, { "name": "Add Operator Contract", "id": "03a2baeb-cfc8-41a7-8d91-1e50c45dac55", "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 \"contractName\": \"support\",\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts" ], "variable": [ { "id": "014663e3-3329-497b-bd01-ae848a9804a1", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Adds the operator's contract." }, "response": [ { "id": "2c9ba4f9-dfb6-4015-a051-b6293239a7bc", "name": "OK.", "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 \"contractName\": \"support\",\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/contracts", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "contracts" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDetail\": {\n \"plan\": \"extended\",\n \"ttl\": \"\"\n },\n \"contractName\": \"harvest\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2c9ba4f9-dfb6-4015-a051-b6293239a7bc" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-03a2baeb-cfc8-41a7-8d91-1e50c45dac55" } ], "id": "eb898c74-3ca6-4cc5-a235-0c752953f6ba", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eb898c74-3ca6-4cc5-a235-0c752953f6ba" }, { "name": "coverage_type", "item": [ { "name": "{coverage_type}", "item": [ { "name": "Add coverage type", "id": "6cbd477e-b2f2-4d9a-b71c-b47b241092a9", "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}}/operators/:operator_id/coverage_type/:coverage_type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "coverage_type", ":coverage_type" ], "variable": [ { "id": "c5910a35-5e8d-4ac0-abfd-dec34673a208", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "726b2c51-389e-4151-8bd2-3a0b3567c9dc", "key": "coverage_type", "value": "", "description": "(Required) Coverage type." } ] }, "description": "Adds the operator's coverage type." }, "response": [ { "id": "c9a99baf-315c-4fae-aa82-3f9afa8aad63", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/coverage_type/:coverage_type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "coverage_type", ":coverage_type" ], "variable": [ { "key": "operator_id" }, { "key": "coverage_type" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c9a99baf-315c-4fae-aa82-3f9afa8aad63" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6cbd477e-b2f2-4d9a-b71c-b47b241092a9" } ], "id": "2246ae97-fea2-4beb-972f-d51400f996b8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2246ae97-fea2-4beb-972f-d51400f996b8" } ], "id": "036f5522-46ab-48dc-986d-f414a1308af9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-036f5522-46ab-48dc-986d-f414a1308af9" }, { "name": "emails", "item": [ { "name": "{email_id}", "item": [ { "name": "Delete email address", "id": "67753da7-d528-488a-9b41-760ddb17692b", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "id": "bddc6bde-5797-4f69-a35a-ab740021ffd6", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "3ad81103-d3f7-4e42-a557-404901ccf171", "key": "email_id", "value": "", "description": "(Required) Email address ID." } ] }, "description": "Deletes the email address corresponding to the specified email address ID from the operator.\n" }, "response": [ { "id": "9ef10141-ba5d-46d3-9286-8b1d614b5ed5", "name": "Email address successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "key": "operator_id" }, { "key": "email_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9ef10141-ba5d-46d3-9286-8b1d614b5ed5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-67753da7-d528-488a-9b41-760ddb17692b" }, { "name": "Get email address", "id": "2912b13e-9f11-4f59-816f-35b488051f02", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "id": "1a378f6b-7b98-4fff-addd-8c89825bd2e1", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "311f2b14-ff5b-4794-83a0-a06b578cec73", "key": "email_id", "value": "", "description": "(Required) Email address ID." } ] }, "description": "Retrieves information for the email address corresponding to the specified email address ID.\n" }, "response": [ { "id": "97c317ba-24e6-49a2-b18a-36cb46c54611", "name": "Information about the specified email address.", "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}}/operators/:operator_id/emails/:email_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails", ":email_id" ], "variable": [ { "key": "operator_id" }, { "key": "email_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-97c317ba-24e6-49a2-b18a-36cb46c54611" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2912b13e-9f11-4f59-816f-35b488051f02" } ], "id": "a6f38369-add1-4caf-a3ce-d8125719847e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a6f38369-add1-4caf-a3ce-d8125719847e" }, { "name": "List email addresses", "id": "d73e370f-5171-40c5-ad9a-636602960fc0", "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}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "id": "24e9a5f3-5206-4fbf-b9c0-259ec36eb432", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Retrieves a list of email addresses registered to the operator.\n" }, "response": [ { "id": "8ff6abe2-75bf-4042-ae52-9a021ea619cd", "name": "A list of email addresses registered to the operator.", "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}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n },\n {\n \"emailId\": \"\",\n \"email\": \"\",\n \"verified\": \"\",\n \"createDateTime\": \"\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8ff6abe2-75bf-4042-ae52-9a021ea619cd" }, { "id": "a906e09c-2304-4122-b8fe-6ee89256d2ac", "name": "Invoked using SAM user credentials. This operation is allowed only for root user.\n", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/emails", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "emails" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a906e09c-2304-4122-b8fe-6ee89256d2ac" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d73e370f-5171-40c5-ad9a-636602960fc0" } ], "id": "fa627880-91a8-4823-8621-cf189b955c78", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fa627880-91a8-4823-8621-cf189b955c78" }, { "name": "individual_information", "item": [ { "name": "Get individual information", "id": "bcd296cb-1454-4e59-8b46-0d6d736b3316", "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}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "4be19b72-dd64-47c1-9d30-b08e76b4bf8e", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets the operator's individual information." }, "response": [ { "id": "6245ab82-35d8-4347-8e95-16607ed38c1f", "name": "OK.", "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}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6245ab82-35d8-4347-8e95-16607ed38c1f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bcd296cb-1454-4e59-8b46-0d6d736b3316" }, { "name": "Create individual information", "id": "6364b754-6b97-4829-9ecb-9656c7a15c78", "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" } ], "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "f2e83667-e7a2-42c7-8b18-c82334014781", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates the operator's individual information." }, "response": [ { "id": "3ab81860-1e12-43aa-a161-2a4033888f82", "name": "Created.", "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 \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3ab81860-1e12-43aa-a161-2a4033888f82" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6364b754-6b97-4829-9ecb-9656c7a15c78" }, { "name": "Update individual information", "id": "6d42ebc0-8003-4838-87a4-3b9cdea6fc66", "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" } ], "body": { "mode": "raw", "raw": "{\n \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "id": "4647a37b-c954-4ef7-b632-d7e9defddffd", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's individual information." }, "response": [ { "id": "a922e5ae-1a03-4fac-8583-93c0e28a6f43", "name": "OK.", "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 \"fullName\": \"\",\n \"countryCode\": \"\",\n \"zipCode\": \"\",\n \"phoneNumber\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"city\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/individual_information", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "individual_information" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a922e5ae-1a03-4fac-8583-93c0e28a6f43" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6d42ebc0-8003-4838-87a4-3b9cdea6fc66" } ], "id": "c4b32f78-5d88-42c2-bc40-d0582f776f1b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c4b32f78-5d88-42c2-bc40-d0582f776f1b" }, { "name": "mfa", "item": [ { "name": "verify", "item": [ { "name": "Verify Operator's MFA OTP Code", "id": "257e2fa3-6d5f-4b29-aec4-218ddcbcebf2", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "id": "b96d6a69-95c7-41c6-be08-f3934a5aaa50", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Verifies operator's MFA with OTP code. This API must be called after calling `Operator:enableMFA`. MFA will not be activated unless the MFA OTP is verified with this API. Be sure to securely store the backup code returned in the response to this API." }, "response": [ { "id": "ff5c845c-7786-4117-aabd-a85d57513c91", "name": "OK.", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"backupCodes\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ff5c845c-7786-4117-aabd-a85d57513c91" }, { "id": "ba797c1c-92af-43f5-aa55-ac775f39b287", "name": "Bad request.", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa", "verify" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ba797c1c-92af-43f5-aa55-ac775f39b287" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-257e2fa3-6d5f-4b29-aec4-218ddcbcebf2" } ], "id": "749d02cb-13ad-4ae1-93a0-847176709090", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-749d02cb-13ad-4ae1-93a0-847176709090" }, { "name": "Revoke Operator's MFA", "id": "ff135b24-ab16-4a23-a66f-dfa5b0cdf79e", "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": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "e9c5766f-9edd-47ca-b56b-5108e060ffd9", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Revokes operator's MFA without backup codes." }, "response": [ { "id": "4d42e6cf-0e28-4b4c-9ed2-623d67d61604", "name": "Revoked.", "originalRequest": { "method": "DELETE", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4d42e6cf-0e28-4b4c-9ed2-623d67d61604" }, { "id": "05809454-cd89-4c1a-85c5-b68bad24ab0d", "name": "Bad request.", "originalRequest": { "method": "DELETE", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05809454-cd89-4c1a-85c5-b68bad24ab0d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ff135b24-ab16-4a23-a66f-dfa5b0cdf79e" }, { "name": "Get Operator's MFA Status", "id": "83d71b21-ef22-4438-b988-1441616d226b", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "7d1d6efa-06f7-41f5-bbd9-df5d5ca3a221", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Gets operator's MFA status. The MFA status is one of `ACTIVE`, `INACTIVE` or `UNCONFIRMED`." }, "response": [ { "id": "dac9f1bf-ea48-4f3f-a124-f788091c1d2d", "name": "OK.", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dac9f1bf-ea48-4f3f-a124-f788091c1d2d" }, { "id": "0d6b0c34-a7a3-4f72-9723-8097ccd4349a", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0d6b0c34-a7a3-4f72-9723-8097ccd4349a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-83d71b21-ef22-4438-b988-1441616d226b" }, { "name": "Enable Operator's MFA", "id": "c7b64a97-adb1-46f4-bb55-9844e7f766ba", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "id": "cb18e07d-7c75-4b76-bf9e-d2e5dd30d848", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Enables operator's MFA. After calling this API, it should be verified by calling `Operator:verifyMFA` API." }, "response": [ { "id": "b239b2c3-ad69-4154-919a-f1389ad894b2", "name": "OK.", "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}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totpUri\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b239b2c3-ad69-4154-919a-f1389ad894b2" }, { "id": "296fd2f4-be55-4a27-83b4-54f799535b1e", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "mfa" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-296fd2f4-be55-4a27-83b4-54f799535b1e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c7b64a97-adb1-46f4-bb55-9844e7f766ba" } ], "id": "290e2483-a58c-44dd-be2e-479e81c8e26e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-290e2483-a58c-44dd-be2e-479e81c8e26e" }, { "name": "password", "item": [ { "name": "Update Operator Password", "id": "5e14ef17-4659-4dc2-90f7-be540a4241b0", "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" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "id": "a850dc51-7689-4073-99d3-9e572cdbf0a3", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Updates the operator's password." }, "response": [ { "id": "eadf06e4-1e28-46e1-a149-f26775df44a7", "name": "OK.", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-eadf06e4-1e28-46e1-a149-f26775df44a7" }, { "id": "6ae660dd-67a9-43ed-9606-9ac9e27379bf", "name": "Invalid password.", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "password" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6ae660dd-67a9-43ed-9606-9ac9e27379bf" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5e14ef17-4659-4dc2-90f7-be540a4241b0" } ], "id": "fb7e5016-bbb0-4a53-8239-3ec8084f1be3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fb7e5016-bbb0-4a53-8239-3ec8084f1be3" }, { "name": "roles", "item": [ { "name": "{role_id}", "item": [ { "name": "users", "item": [ { "name": "List Role Attached Users", "id": "9e7052d3-5ff3-4419-8549-4b6eb5c24505", "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}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "id": "e9adf1ec-9694-4de2-854d-9e520542a402", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "794d294f-0274-4306-ae07-36564512deda", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Retrieves a list of users attached to a role." }, "response": [ { "id": "02d8d606-8b43-4921-8321-fd2ad29b6fe9", "name": "OK.", "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}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n },\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-02d8d606-8b43-4921-8321-fd2ad29b6fe9" }, { "id": "26639460-a8c7-474b-872a-fea1532e43c3", "name": "Role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "users" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-26639460-a8c7-474b-872a-fea1532e43c3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9e7052d3-5ff3-4419-8549-4b6eb5c24505" } ], "id": "9f74415c-1c0f-4a5c-8f1f-67de64787746", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9f74415c-1c0f-4a5c-8f1f-67de64787746" }, { "name": "versions", "item": [ { "name": "Get Soracom Managed Role Versions", "id": "5c258e24-24f0-44e0-8b99-e2fe38e489a1", "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}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "id": "057264e1-1a45-4f9e-9ad5-65bc24a4a69e", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "a6296c5e-cd7e-4ad0-b47a-1c50e8b7897f", "key": "role_id", "value": "", "description": "(Required) SRN (Soracom Resource Name) of the Soracom managed role. The format is `srn:soracom:::Role:[roleName]`." } ] }, "description": "Retrieves a list of versions for a Soracom managed role." }, "response": [ { "id": "3492bf1b-ee26-45d8-a20a-6a1356c6586c", "name": "OK.", "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}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"description\": \"\",\n \"owner\": \"operator\",\n \"permission\": \"\",\n \"publishDateTime\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"version\": \"\"\n },\n {\n \"description\": \"\",\n \"owner\": \"operator\",\n \"permission\": \"\",\n \"publishDateTime\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3492bf1b-ee26-45d8-a20a-6a1356c6586c" }, { "id": "aa437e30-b817-43ae-9bd0-9badfbd35257", "name": "Operator managed roles cannot be specified.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aa437e30-b817-43ae-9bd0-9badfbd35257" }, { "id": "09591a21-559e-4864-8148-658bcd4913a0", "name": "Soracom managed role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id", "versions" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-09591a21-559e-4864-8148-658bcd4913a0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c258e24-24f0-44e0-8b99-e2fe38e489a1" } ], "id": "0e3a87cd-6329-4906-af66-e44548752ffb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0e3a87cd-6329-4906-af66-e44548752ffb" }, { "name": "Delete Operator Managed Role", "id": "3dcacabe-ae2b-4e4a-b1ce-7c623efc070f", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "b739c80e-c4d1-4b0b-b620-be775626663c", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "bd705504-280b-47bc-b5c5-58b60303b63f", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Deletes an operator managed role." }, "response": [ { "id": "79ba2cbb-6118-4961-aec6-47337e654a52", "name": "The role was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-79ba2cbb-6118-4961-aec6-47337e654a52" }, { "id": "9b67bd5c-b2c2-4ddc-bb9b-5e48a3358f15", "name": "The role is still in use.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9b67bd5c-b2c2-4ddc-bb9b-5e48a3358f15" }, { "id": "3d5aea3c-02bb-47e5-bc48-b09bf0853525", "name": "Role not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3d5aea3c-02bb-47e5-bc48-b09bf0853525" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3dcacabe-ae2b-4e4a-b1ce-7c623efc070f" }, { "name": "Get Role", "id": "a6f613ce-87fa-49be-aef2-4c37064028d9", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "283fa70e-dfe5-4e9a-b116-e75b78911771", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "21dc4c81-0405-4182-ad4b-553894b3f593", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Retrieves a role." }, "response": [ { "id": "1b6289d9-aaf7-4a89-9ef9-1f14255744c5", "name": "OK.", "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}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1b6289d9-aaf7-4a89-9ef9-1f14255744c5" }, { "id": "656fb7ac-5835-4a8f-b574-c2d04eb2d9a4", "name": "Role not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-656fb7ac-5835-4a8f-b574-c2d04eb2d9a4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a6f613ce-87fa-49be-aef2-4c37064028d9" }, { "name": "Create Operator Managed Role", "id": "5d60116d-ff46-4fbb-92b0-5b5604be2510", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "98d70d19-7d1c-4751-a0fc-58870361cc38", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "f18cba2a-1298-4e39-8964-b679850e6083", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Adds a new operator managed role." }, "response": [ { "id": "f03e93db-52c4-4f4e-a1a9-c6d04e8a7850", "name": "OK.", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"roleId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f03e93db-52c4-4f4e-a1a9-c6d04e8a7850" }, { "id": "1a2bb0ee-c858-4418-b3da-27d1eda69d92", "name": "Failed to create an operator managed role.", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1a2bb0ee-c858-4418-b3da-27d1eda69d92" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5d60116d-ff46-4fbb-92b0-5b5604be2510" }, { "name": "Update Operator Managed Role", "id": "c0640fc0-224c-47a7-a26f-3869ad5ff329", "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" } ], "body": { "mode": "raw", "raw": "{\n \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "id": "3eb6e37d-e1fc-4e22-98de-220a34e3a9ea", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "3828655b-4d7c-4172-afdf-2e66cdd2c04b", "key": "role_id", "value": "", "description": "(Required) Role ID." } ] }, "description": "Edits an operator managed role." }, "response": [ { "id": "c4e25e56-38c0-4c40-afb5-b57fd2824dc2", "name": "OK.", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c4e25e56-38c0-4c40-afb5-b57fd2824dc2" }, { "id": "b9173565-e984-43df-aff0-b9fef7859bec", "name": "Operator managed role not 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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b9173565-e984-43df-aff0-b9fef7859bec" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c0640fc0-224c-47a7-a26f-3869ad5ff329" } ], "id": "93aefa55-698b-4cf9-b9d0-c7f104473240", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-93aefa55-698b-4cf9-b9d0-c7f104473240" }, { "name": "List Roles", "id": "a5237a56-9506-4df5-bcfa-b5100c670133", "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}}/operators/:operator_id/roles?owner=operator", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles" ], "query": [ { "description": "Filters by the type of the role. Specify one of the following:\n- `operator`: Operator managed role (default)\n- `soracom`: Soracom managed role\n- `all`: All roles\n", "key": "owner", "value": "operator" } ], "variable": [ { "id": "a7c9a125-f3c2-4af4-ad74-b1d68b72e9b6", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a list of roles." }, "response": [ { "id": "b3316e81-b3e0-461e-bb5a-bb911f367358", "name": "OK.", "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}}/operators/:operator_id/roles?owner=operator", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "roles" ], "query": [ { "description": "Filters by the type of the role. Specify one of the following:\n- `operator`: Operator managed role (default)\n- `soracom`: Soracom managed role\n- `all`: All roles\n", "key": "owner", "value": "operator" } ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b3316e81-b3e0-461e-bb5a-bb911f367358" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a5237a56-9506-4df5-bcfa-b5100c670133" } ], "id": "eb2328af-cf1e-459b-a3ea-5185a1e2515a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eb2328af-cf1e-459b-a3ea-5185a1e2515a" }, { "name": "shipping_addresses", "item": [ { "name": "{shipping_address_id}", "item": [ { "name": "Delete shipping address", "id": "6ebf1e31-4a1b-478b-8427-c10e6f6be1eb", "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}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "b86f0ac7-4254-4fbd-9931-1c485777f8af", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "d07e20a2-f803-478a-b98e-3e4f9791fcf3", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Deletes a shipping address." }, "response": [ { "id": "e8eb51f5-8f65-4b50-a5a0-736f2f179d6f", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e8eb51f5-8f65-4b50-a5a0-736f2f179d6f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6ebf1e31-4a1b-478b-8427-c10e6f6be1eb" }, { "name": "Get shipping address", "id": "45534960-2003-4c97-8719-4af69102aa3b", "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}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "51926772-a087-4ac4-b507-02f416f73792", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "ddf8c0bd-ac5b-4269-bc66-1d643dd90a28", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Returns a shipping address." }, "response": [ { "id": "7a199d97-6167-41d6-bd37-3120b8cb7e54", "name": "OK.", "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}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7a199d97-6167-41d6-bd37-3120b8cb7e54" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-45534960-2003-4c97-8719-4af69102aa3b" }, { "name": "Update shipping address", "id": "f355fe1f-cb38-47bc-9173-d45285535ae4", "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" } ], "body": { "mode": "raw", "raw": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "a8bca3ee-43ad-419d-8c9e-0a80bfd56078", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "2f3a1dbc-8156-4dc6-aec5-b88428ddd33e", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Updates a shipping address." }, "response": [ { "id": "2fa2e25c-0499-4044-928f-1c6688019db9", "name": "OK.", "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 \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2fa2e25c-0499-4044-928f-1c6688019db9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f355fe1f-cb38-47bc-9173-d45285535ae4" } ], "id": "39dd455f-d5d7-40ee-8374-8b082b51652d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-39dd455f-d5d7-40ee-8374-8b082b51652d" }, { "name": "List shipping addresses", "id": "002f090d-1296-430d-95a4-4484589b42d8", "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}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "id": "e4eef593-2621-403f-8a1e-10cd46d65a19", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a list of shipping addresses." }, "response": [ { "id": "03f6fad3-49c3-47d7-95fb-8af486c178bc", "name": "OK.", "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}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shippingAddresses\": [\n {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n },\n {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-03f6fad3-49c3-47d7-95fb-8af486c178bc" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-002f090d-1296-430d-95a4-4484589b42d8" }, { "name": "Create shipping address", "id": "a5b151fd-9f8e-40b3-832b-711053ea34da", "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 \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "id": "b54066ea-5532-4505-8944-8688def7e316", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates a new shipping address." }, "response": [ { "id": "9de4029b-d440-41a6-8fd1-f469639f3749", "name": "Shipping address was registered.", "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 \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9de4029b-d440-41a6-8fd1-f469639f3749" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a5b151fd-9f8e-40b3-832b-711053ea34da" } ], "id": "bdbfcb31-59c5-4332-86d3-9f426c1f3e2c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bdbfcb31-59c5-4332-86d3-9f426c1f3e2c" }, { "name": "support", "item": [ { "name": "token", "item": [ { "name": "Generate Token for Support Console", "id": "e5a46708-d793-4ad4-baab-ae222b6b769e", "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}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "id": "bd47999f-8df5-4f6e-9afd-732af7958871", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a token for accessing the support console." }, "response": [ { "id": "3dc4a0d9-7654-4be5-827d-dc5b66a540fd", "name": "OK.", "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}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3dc4a0d9-7654-4be5-827d-dc5b66a540fd" }, { "id": "b35ccd4c-8114-4ce8-8b23-7460f9781624", "name": "Invalid Operator Id.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b35ccd4c-8114-4ce8-8b23-7460f9781624" }, { "id": "ffcd6975-acf9-43fe-bc60-c24aed778564", "name": "Invalid token.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/support/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "support", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ffcd6975-acf9-43fe-bc60-c24aed778564" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e5a46708-d793-4ad4-baab-ae222b6b769e" } ], "id": "579818ca-c4d9-4dcc-81b0-abbc403fd024", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-579818ca-c4d9-4dcc-81b0-abbc403fd024" } ], "id": "48e3bf0b-89b4-48fb-9cd2-dfc131feedbb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-48e3bf0b-89b4-48fb-9cd2-dfc131feedbb" }, { "name": "system_notifications", "item": [ { "name": "{type}", "item": [ { "name": "Delete an email address from the email settings", "id": "78aeab2f-68c9-4838-8f35-763c2b062903", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "cc037349-f5cc-41d3-bbf0-1103e6716b89", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "b7627de6-1af9-4768-a7fc-256f789c3878", "key": "type", "value": "support", "description": "(Required) Email address type." } ] }, "description": "Delete an email address from the email settings." }, "response": [ { "id": "0bffeeaf-16a5-4570-a856-f1445ba06542", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0bffeeaf-16a5-4570-a856-f1445ba06542" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-78aeab2f-68c9-4838-8f35-763c2b062903" }, { "name": "Get information on email settings", "id": "0006a1be-76ef-4034-8d74-b264bef0fb6b", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "7aa0298e-50ad-45cf-ac6b-d4b4dd77c22e", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "c1ad4b3d-4397-4322-9212-bb23e2666e6e", "key": "type", "value": "recovery", "description": "(Required) Email address type." } ] }, "description": "Return information on email settings." }, "response": [ { "id": "cf6a49c4-89e4-49ca-80e0-a4df099de303", "name": "OK.", "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}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"recovery\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cf6a49c4-89e4-49ca-80e0-a4df099de303" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0006a1be-76ef-4034-8d74-b264bef0fb6b" }, { "name": "Set an email address in the email settings", "id": "a2179cbf-4048-4250-b170-5fa5b0ae0524", "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 \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "id": "05d95153-c01d-4d49-8251-2179395ea977", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "f8f9d7fa-8165-4968-8ab9-9208db98faa1", "key": "type", "value": "recovery", "description": "(Required) Email address type." } ] }, "description": "Set an email address in the email settings." }, "response": [ { "id": "8d447107-5fcb-4a9f-8aef-c53e3607d519", "name": "OK.", "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 \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/system_notifications/:type", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications", ":type" ], "variable": [ { "key": "operator_id" }, { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"recovery\",\n \"updateDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8d447107-5fcb-4a9f-8aef-c53e3607d519" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2179cbf-4048-4250-b170-5fa5b0ae0524" } ], "id": "415e33f2-22b7-43cc-b270-341568b8382c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-415e33f2-22b7-43cc-b270-341568b8382c" }, { "name": "List email settings", "id": "cdd0aea4-de3c-454a-98e6-e3ff993f31bd", "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}}/operators/:operator_id/system_notifications", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications" ], "variable": [ { "id": "dd53f50d-5425-409a-b0ee-ffb2432ed105", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Returns a list of email settings." }, "response": [ { "id": "da55ddf6-dead-402f-8b2a-648f606df825", "name": "OK.", "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}}/operators/:operator_id/system_notifications", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "system_notifications" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"billing\",\n \"updateDateTime\": \"\"\n },\n {\n \"emailIdList\": [\n \"\",\n \"\"\n ],\n \"type\": \"billing\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-da55ddf6-dead-402f-8b2a-648f606df825" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cdd0aea4-de3c-454a-98e6-e3ff993f31bd" } ], "id": "5d09abcb-e9dc-494a-9456-621e6c3ccc3e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5d09abcb-e9dc-494a-9456-621e6c3ccc3e" }, { "name": "token", "item": [ { "name": "Generate API Token", "id": "f27d37ff-09db-4c64-9bc5-63c6f5be38e4", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "id": "5a0b4b91-d81f-48a6-938c-d3865be92291", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Generates a new API token. If you insert the current API token into the header and make a request, a response is returned containing the new API token. You can then use the new API token in future requests." }, "response": [ { "id": "3dcf91ab-22f3-40ab-985f-5f3457da7f1e", "name": "OK.", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3dcf91ab-22f3-40ab-985f-5f3457da7f1e" }, { "id": "aeb5111d-b5c4-4fa1-9ea4-bdc6678f632a", "name": "There was an error in the request or the specified token has already expired. (In the latter case, you will need to use the /auth API to do authentication once again.)", "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 \"tokenTimeoutSeconds\": 86400\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/token", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "token" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aeb5111d-b5c4-4fa1-9ea4-bdc6678f632a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f27d37ff-09db-4c64-9bc5-63c6f5be38e4" } ], "id": "acd37b58-ae7c-4ae3-9571-0e9e1fcb93d5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-acd37b58-ae7c-4ae3-9571-0e9e1fcb93d5" }, { "name": "tokens", "item": [ { "name": "Revoke all API keys and API tokens that were generated by the root user", "id": "312a8205-28a0-4db3-8def-88ff94b17cb9", "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}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "id": "d27e26af-766d-4293-a9e6-ab4a4ad294f7", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Revoke all API keys and API tokens that were generated by the root user. Once revoked, the API key and API token cannot be used to call the Soracom API, regardless of their expiration time." }, "response": [ { "id": "36f67022-1845-441c-b95b-e7f0e8c104ec", "name": "Successfully revoked all API keys and API tokens.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-36f67022-1845-441c-b95b-e7f0e8c104ec" }, { "id": "5c19afbd-9ac4-484b-97c5-c1314516b241", "name": "Invalid Operator Id.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "tokens" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5c19afbd-9ac4-484b-97c5-c1314516b241" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-312a8205-28a0-4db3-8def-88ff94b17cb9" } ], "id": "38098bda-a6f2-4b1e-b6c9-4c7cf8d8b821", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-38098bda-a6f2-4b1e-b6c9-4c7cf8d8b821" }, { "name": "users", "item": [ { "name": "{user_name}", "item": [ { "name": "auth_keys", "item": [ { "name": "{auth_key_id}", "item": [ { "name": "Delete User AuthKey.", "id": "fe3fb2f7-6527-4633-9d75-3a66ac33763f", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "0df553bf-f78a-4ca5-bd22-08c8f96bbfac", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "45add152-38e9-40e5-ae55-86058de7c31d", "key": "user_name", "value": "", "description": "(Required) user_name" }, { "id": "aaf90c11-6473-464f-871f-b63b5495ea99", "key": "auth_key_id", "value": "", "description": "(Required) auth_key_id" } ] }, "description": "Deletes an AuthKey from the SAM user." }, "response": [ { "id": "12b4c010-a9fe-47ee-9f05-3a4d3002b22e", "name": "The AuthKey was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-12b4c010-a9fe-47ee-9f05-3a4d3002b22e" }, { "id": "8661c7ae-8991-40d0-bd6d-232b46cff934", "name": "AuthKey not found.", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8661c7ae-8991-40d0-bd6d-232b46cff934" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fe3fb2f7-6527-4633-9d75-3a66ac33763f" }, { "name": "Get AuthKey.", "id": "128c62fe-41d1-4b3b-b64c-a34feccc1876", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "id": "01b95602-190c-4b5d-bda5-434a3f79208c", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "f880ed32-bdd2-41c6-86aa-750e0060a71d", "key": "user_name", "value": "", "description": "(Required) user_name" }, { "id": "5bdfa0f7-9b80-4025-9fea-31bfd4ec5f82", "key": "auth_key_id", "value": "", "description": "(Required) auth_key_id" } ] }, "description": "Returns the SAM user's AuthKey." }, "response": [ { "id": "4d922849-a82a-4120-ad88-065b88abd6fb", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys", ":auth_key_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "auth_key_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4d922849-a82a-4120-ad88-065b88abd6fb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-128c62fe-41d1-4b3b-b64c-a34feccc1876" } ], "id": "7ad3ea06-4467-4f1c-983c-ad8bc40ff77b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7ad3ea06-4467-4f1c-983c-ad8bc40ff77b" }, { "name": "List User AuthKeys.", "id": "76135452-bd90-4561-b006-0b3e752dd3ab", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "id": "b751c71e-4a4f-40bc-b310-1f7c57b380d8", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "8e76412a-f528-45f3-9a84-207f637e95cf", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Returns the SAM user's AuthKey list." }, "response": [ { "id": "469b2e44-2080-4e6f-b169-c5ff0fed98f1", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-469b2e44-2080-4e6f-b169-c5ff0fed98f1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-76135452-bd90-4561-b006-0b3e752dd3ab" }, { "name": "Generate AuthKey.", "id": "12fbb893-a7ad-4fde-9597-d391b9ef4999", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "id": "7737d816-e341-41c5-b90f-c8ef90312a64", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "0f70126c-45d4-4835-8103-17e5453a29a0", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Generates an AuthKey for the SAM user." }, "response": [ { "id": "f4cb26c4-678b-4228-95d4-134f674b7089", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/auth_keys", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "auth_keys" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKey\": \"\",\n \"authKeyId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f4cb26c4-678b-4228-95d4-134f674b7089" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-12fbb893-a7ad-4fde-9597-d391b9ef4999" } ], "id": "1ef06139-e43c-401c-a82b-58dec736b956", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1ef06139-e43c-401c-a82b-58dec736b956" }, { "name": "mfa", "item": [ { "name": "verify", "item": [ { "name": "Verify SAM user's MFA OTP code when MFA activation phase", "id": "3bcd6ebb-8ffd-41be-aa8d-a495a4af3d46", "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" } ], "body": { "mode": "raw", "raw": "{\n \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "id": "fc8165e0-64fa-4f0d-8af7-e8ec6ad282b9", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "acf88814-962a-4d89-8ffe-b12fc46f7a00", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Verify SAM user's MFA OTP code when MFA activation phase" }, "response": [ { "id": "1b57e8ca-7734-4095-a420-9bc4cc760c97", "name": "Verified", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1b57e8ca-7734-4095-a420-9bc4cc760c97" }, { "id": "5385514a-557b-4ab5-ae28-86b7a9fd89e6", "name": "Bad request.", "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 \"mfaOTPCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa", "verify" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5385514a-557b-4ab5-ae28-86b7a9fd89e6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3bcd6ebb-8ffd-41be-aa8d-a495a4af3d46" } ], "id": "aecf980c-49a6-47c1-960b-0ba8a8350f22", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-aecf980c-49a6-47c1-960b-0ba8a8350f22" }, { "name": "Revoke SAM user's MFA", "id": "97999689-f476-4540-b4d5-3adb94bc80a3", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "4d47f02a-c63c-44e8-ae3f-171922a018b4", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "aaf5226f-7aab-4d16-92de-7ea4b9394ab2", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Revoke SAM user's MFA" }, "response": [ { "id": "a53e0074-bae2-4127-b051-6a003cf3ab38", "name": "Revoked", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a53e0074-bae2-4127-b051-6a003cf3ab38" }, { "id": "00e1716f-5b22-4313-977d-c0725a8f1ec4", "name": "Bad request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-00e1716f-5b22-4313-977d-c0725a8f1ec4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-97999689-f476-4540-b4d5-3adb94bc80a3" }, { "name": "Get SAM user's MFA status", "id": "0aaf68e3-181a-4fa1-a52c-ceaaf00cc394", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "cb6e97c9-4e32-4ebb-9243-e5c6d0b56300", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "91967a80-29b7-4cbb-a84e-18f14050963f", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Get SAM user's MFA status" }, "response": [ { "id": "628ecd96-59ef-4f45-b08e-d02b79312f62", "name": "OK", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-628ecd96-59ef-4f45-b08e-d02b79312f62" }, { "id": "d79c3d96-e7ec-427b-9485-56a9a6d59639", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d79c3d96-e7ec-427b-9485-56a9a6d59639" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0aaf68e3-181a-4fa1-a52c-ceaaf00cc394" }, { "name": "Enable SAM user's MFA", "id": "a2915cc6-7b1a-491d-aa2b-3ce75d709630", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "id": "604c791b-65b7-48b0-9723-1a16125aa933", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "672d4187-cb01-4cc7-904d-89fa69acb88f", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Enable SAM user's MFA" }, "response": [ { "id": "3aedbade-8d5d-42f5-b704-8917f4acd6d2", "name": "OK", "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}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totpUri\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3aedbade-8d5d-42f5-b704-8917f4acd6d2" }, { "id": "f10c90fc-a5f8-49f9-ba47-55c60aec9a25", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/mfa", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "mfa" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f10c90fc-a5f8-49f9-ba47-55c60aec9a25" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2915cc6-7b1a-491d-aa2b-3ce75d709630" } ], "id": "d59a053e-1ff2-4567-8f95-dee098acf802", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d59a053e-1ff2-4567-8f95-dee098acf802" }, { "name": "password", "item": [ { "name": "Delete Password.", "id": "e446dfd5-52ba-4b2a-a175-70f9ecd0dfd4", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "8d6ad9c2-a21b-4f1a-8e2f-d15e0edb7470", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "e751fa80-c2db-4289-9f79-977de67f496a", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Deletes the user's password." }, "response": [ { "id": "73c6a910-e7fd-45d0-aef5-b0d86aed25b7", "name": "The user's password was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-73c6a910-e7fd-45d0-aef5-b0d86aed25b7" }, { "id": "a5fd1fd4-6476-4e5f-bd67-d0942b3b0180", "name": "Password registration is required.", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a5fd1fd4-6476-4e5f-bd67-d0942b3b0180" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e446dfd5-52ba-4b2a-a175-70f9ecd0dfd4" }, { "name": "Has User Password.", "id": "871c2a3a-d51f-4771-871c-3114bccb8721", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "be2a2e86-58d7-44f1-85f3-c6938d665998", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "fd80a0b8-d3fd-4ae7-8625-63b32e3061c7", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Retrieves whether the SAM user has a password or not." }, "response": [ { "id": "f7400207-307b-4937-939e-a64949ee45c3", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"hasPassword\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f7400207-307b-4937-939e-a64949ee45c3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-871c2a3a-d51f-4771-871c-3114bccb8721" }, { "name": "Create Password.", "id": "c7d763e0-249a-4e2a-83e4-ce9b0e825181", "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" } ], "body": { "mode": "raw", "raw": "{\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "277e1404-0a8b-4d98-9fa4-586fd5eef55d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "122236fc-4d6c-4ffc-aa9c-6cdb5699abd4", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Creates a password for the SAM user." }, "response": [ { "id": "9d3953ab-7316-4a17-8a75-bd6dd447e0dd", "name": "Password for the SAM user was registered.", "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 \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9d3953ab-7316-4a17-8a75-bd6dd447e0dd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c7d763e0-249a-4e2a-83e4-ce9b0e825181" }, { "name": "Update Password.", "id": "0383aa93-b03e-467a-b296-39fcb57322c2", "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" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "id": "43af0f38-ad6c-486d-841b-fa6baec8071e", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "9f957d0b-4e10-45a6-a6ec-27d456975309", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Updates the password of the SAM user." }, "response": [ { "id": "52041083-dccc-4f90-9022-b8a4af76bc70", "name": "OK", "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 \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/password", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "password" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-52041083-dccc-4f90-9022-b8a4af76bc70" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0383aa93-b03e-467a-b296-39fcb57322c2" } ], "id": "dfdc330a-3a97-43ff-83d9-1c982e51e315", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dfdc330a-3a97-43ff-83d9-1c982e51e315" }, { "name": "permission", "item": [ { "name": "Delete user permission.", "id": "6c5a1505-63a0-4dbc-b7cc-e227d276f82d", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "53debfb6-5ebf-42e3-9907-ac3c7ca20bbe", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "315efd40-718f-4e99-b715-5be68ccbe749", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Deletes the SAM user's permission." }, "response": [ { "id": "3695cbe0-2ed5-4628-9ada-1e6f150163a3", "name": "Deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3695cbe0-2ed5-4628-9ada-1e6f150163a3" }, { "id": "234a1ed4-a2af-4a9a-9a4f-a6cf30ba3e50", "name": "Invalid Operator ID or SAM user name", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-234a1ed4-a2af-4a9a-9a4f-a6cf30ba3e50" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6c5a1505-63a0-4dbc-b7cc-e227d276f82d" }, { "name": "Get User Permission.", "id": "3630834d-665c-4eea-ba45-5aadb70c35aa", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "42a65687-64f8-4f09-ad22-469871cdf950", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "4e7782dd-126e-4a73-a699-9bc683b009cd", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Retrieves the SAM user's permissions." }, "response": [ { "id": "ccc47fb2-e666-41f5-afc1-348a2f50b259", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"permission\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ccc47fb2-e666-41f5-afc1-348a2f50b259" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3630834d-665c-4eea-ba45-5aadb70c35aa" }, { "name": "Update user permission.", "id": "eafceca3-75bc-4bad-9060-7f88da0c11ba", "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" } ], "body": { "mode": "raw", "raw": "{\n \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "id": "69796ffa-b4ac-4c65-94b1-9d2c01da9a77", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "3b520754-eabc-4a4a-ab5a-c4d45d9d326a", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Updates the SAM user's permissions." }, "response": [ { "id": "24eb2133-e7c5-4ae8-b94f-977759df457b", "name": "OK", "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 \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/permission", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "permission" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-24eb2133-e7c5-4ae8-b94f-977759df457b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eafceca3-75bc-4bad-9060-7f88da0c11ba" } ], "id": "f8c29312-395f-431f-b65b-5fdb819f901d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f8c29312-395f-431f-b65b-5fdb819f901d" }, { "name": "roles", "item": [ { "name": "{role_id}", "item": [ { "name": "Detach Role from User", "id": "83bda522-f0a9-4c3b-973c-5f57014be2b3", "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}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "id": "dfc380fd-018f-4b93-95e2-c6dfee8c546c", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "cae4dc76-57db-4207-b15f-d16d2684aea8", "key": "user_name", "value": "", "description": "(Required) SAM user name." }, { "id": "e6141591-17c5-4dc8-af26-c6b18a3e9afd", "key": "role_id", "value": "", "description": "(Required) Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ] }, "description": "Detaches a role from a user." }, "response": [ { "id": "bf795f82-8d1e-4723-858f-c1062c7235ac", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bf795f82-8d1e-4723-858f-c1062c7235ac" }, { "id": "ae211ec9-4b3d-44d0-ae7a-b108100c8fce", "name": "SAM user or role not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles", ":role_id" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ae211ec9-4b3d-44d0-ae7a-b108100c8fce" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-83bda522-f0a9-4c3b-973c-5f57014be2b3" } ], "id": "0cdc5116-a3cb-429e-a5cb-68a931732943", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0cdc5116-a3cb-429e-a5cb-68a931732943" }, { "name": "List User Roles", "id": "497cd9d8-ac2a-408b-a21e-eb7a39e7e03d", "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}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "id": "58bad973-b069-4979-8342-217f5b49a2f0", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "c42b1078-7d43-447b-a50a-2c90b113b320", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Retrieves a list of the user's roles." }, "response": [ { "id": "602af633-8ea0-4b37-9a4a-1988740737d0", "name": "OK.", "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}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"permission\": \"\",\n \"roleId\": \"\",\n \"roleName\": \"\",\n \"updateDateTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-602af633-8ea0-4b37-9a4a-1988740737d0" }, { "id": "78814d35-c2a5-43a8-90e2-331c092b7656", "name": "SAM user not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-78814d35-c2a5-43a8-90e2-331c092b7656" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-497cd9d8-ac2a-408b-a21e-eb7a39e7e03d" }, { "name": "Attach Role to User", "id": "e3e86810-5504-40db-bf56-b68729856c92", "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" } ], "body": { "mode": "raw", "raw": "{\n \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "id": "977a792f-b526-412f-826d-d4990d1ecef2", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "1aaaf97d-27ce-4eb2-a047-57e97a843606", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Attaches a role to a user." }, "response": [ { "id": "805a1116-94c3-4cd5-9e9d-d28a6b278127", "name": "OK.", "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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-805a1116-94c3-4cd5-9e9d-d28a6b278127" }, { "id": "709bed04-6c5e-4d46-9771-a9518c7809cb", "name": "The role has already been attached or not 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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-709bed04-6c5e-4d46-9771-a9518c7809cb" }, { "id": "8b990d56-5a8e-44fd-8eb5-563ccf37ec65", "name": "SAM user not 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 \"roleId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/roles", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "roles" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8b990d56-5a8e-44fd-8eb5-563ccf37ec65" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e3e86810-5504-40db-bf56-b68729856c92" } ], "id": "ee74c9b7-d200-444c-9b1f-a0fd97dcb86a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ee74c9b7-d200-444c-9b1f-a0fd97dcb86a" }, { "name": "tokens", "item": [ { "name": "Revoke all API keys and API tokens that were generated by the specified SAM user.", "id": "19911fc5-34aa-4a9d-be42-f642c98c1b7e", "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}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "id": "bbee2b90-022d-449e-a9b8-fd3656036706", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "bc16084f-1932-487d-968f-f13a46947cba", "key": "user_name", "value": "", "description": "(Required) SAM user name" } ] }, "description": "Revoke all API keys and API tokens that were generated by the specified SAM user. Once revoked, the API key and API token cannot be used to call the SORACOM API, regardless of their expiration time." }, "response": [ { "id": "c2dfce6b-f018-49c6-9928-8f710f74ea87", "name": "Successfully revoked all API keys and API tokens", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c2dfce6b-f018-49c6-9928-8f710f74ea87" }, { "id": "14fc7b98-a715-408f-9a4c-36352ea36282", "name": "Wrong operator ID or username was specified.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/tokens", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "tokens" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-14fc7b98-a715-408f-9a4c-36352ea36282" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-19911fc5-34aa-4a9d-be42-f642c98c1b7e" } ], "id": "5c1725e9-6f86-4c38-bfb7-f9beaa3c2082", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c1725e9-6f86-4c38-bfb7-f9beaa3c2082" }, { "name": "trust_policy", "item": [ { "name": "Deletes user trust policy.", "id": "0998ec5e-7721-449f-95e9-9a13d9e7f325", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "e9ded874-833a-45c3-889b-7a87b24edfe0", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "805ff21e-230e-49f2-90a3-0379fcb9d24d", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Deletes user trust policy for switching user." }, "response": [ { "id": "adecca26-dec6-4588-bee6-4a29b4c05065", "name": "Successfully deleted a trust policy for the user.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-adecca26-dec6-4588-bee6-4a29b4c05065" }, { "id": "b680a5c5-6e58-4ba6-8bc0-f592599f527e", "name": "Bad request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b680a5c5-6e58-4ba6-8bc0-f592599f527e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0998ec5e-7721-449f-95e9-9a13d9e7f325" }, { "name": "Gets user trust policy.", "id": "79c8ebc5-0571-4c00-b266-b9c74b65788c", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "d3a91b39-5bae-4e90-aacd-03f33256ef4a", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "74bb18f8-66ef-4e0b-a2b7-5bf751d9287d", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Gets user trust policy for switching user." }, "response": [ { "id": "e96f5a00-48d2-4c52-a9b4-91493fd976f9", "name": "Successfully obtained trust policy.", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trustPolicy\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e96f5a00-48d2-4c52-a9b4-91493fd976f9" }, { "id": "7bdc6efb-2593-4d9a-8f60-49043f777a3a", "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}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7bdc6efb-2593-4d9a-8f60-49043f777a3a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-79c8ebc5-0571-4c00-b266-b9c74b65788c" }, { "name": "Updates user trust policy", "id": "4b26a9ba-078d-4db5-be1c-35fdbb9e0d00", "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" } ], "body": { "mode": "raw", "raw": "{\n \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "id": "c71fdcc6-6e87-40f3-8660-5f55b6d67207", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "05c87c75-7105-4048-9887-ea25f69410cd", "key": "user_name", "value": "", "description": "(Required) SAM user name." } ] }, "description": "Updates the trust policy of the user specified by `operator_id` and `user_name` parameters.\n\n**Warning**: Setting a trust policy will allow the operator(s) or user(s) specified in the request body to switch to this SAM user. When switching, the trusted operator(s) or user(s) will be granted the same permissions as this SAM user, and may be able to see session history, traffic history, and other account information.\n" }, "response": [ { "id": "8133159e-dd9f-474c-9607-54ba30b97691", "name": "Successfully updated a trust policy for the user.", "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 \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8133159e-dd9f-474c-9607-54ba30b97691" }, { "id": "bcb4beb4-6be1-45e4-bd70-5169f99d78f8", "name": "Bad request.", "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 \"trustPolicy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name/trust_policy", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name", "trust_policy" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bcb4beb4-6be1-45e4-bd70-5169f99d78f8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4b26a9ba-078d-4db5-be1c-35fdbb9e0d00" } ], "id": "a4bf52cf-4730-484e-9236-2a5f3043767e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a4bf52cf-4730-484e-9236-2a5f3043767e" }, { "name": "Delete User.", "id": "68561e28-2e9b-4058-a8b9-d45f9269a0ad", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "83f310c1-e415-4921-93b4-1e9b45fb1fac", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "8efbc3f0-eca6-41f4-8f3c-f2e63b908f88", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Deletes the SAM user." }, "response": [ { "id": "c37da955-0e72-44fe-8f0c-c5d54edb6963", "name": "The SAM user was deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c37da955-0e72-44fe-8f0c-c5d54edb6963" }, { "id": "763c24f2-a580-4632-b9c9-b4daa0f41330", "name": "SAM User not found.", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-763c24f2-a580-4632-b9c9-b4daa0f41330" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-68561e28-2e9b-4058-a8b9-d45f9269a0ad" }, { "name": "Get User.", "id": "9333e7b3-024d-4ec5-987a-2218238e2767", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "bc9a2a2c-a4fd-432c-a034-83b5df91f426", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "4f589fef-5134-43ee-99ef-36d4006c5790", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Returns a SAM user." }, "response": [ { "id": "1c464910-34d6-4c99-8f83-27d21863f6e6", "name": "OK.", "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}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c464910-34d6-4c99-8f83-27d21863f6e6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9333e7b3-024d-4ec5-987a-2218238e2767" }, { "name": "Create User.", "id": "d6c717db-b689-41a8-8d24-1fc7acce3e24", "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" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "8ea20e83-02de-49f8-a08c-05800de60693", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "240773ad-79e7-49f6-bcbc-1332072d3582", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Adds a new SAM user." }, "response": [ { "id": "54a1db7d-0185-4146-b609-da4fb5a3c377", "name": "A new user was added.", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-54a1db7d-0185-4146-b609-da4fb5a3c377" }, { "id": "cfb42a05-de59-407c-a715-a7ec29c4b351", "name": "Failed to create a new user.", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cfb42a05-de59-407c-a715-a7ec29c4b351" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d6c717db-b689-41a8-8d24-1fc7acce3e24" }, { "name": "Update User.", "id": "de78af3b-6f4e-422a-8b18-82fc631e5ed8", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "id": "ff190063-3e16-41fe-afa0-d852a8a688b2", "key": "operator_id", "value": "", "description": "(Required) Operator ID" }, { "id": "98a5ca3d-24b1-4eec-be36-6cd57157ec4e", "key": "user_name", "value": "", "description": "(Required) user_name" } ] }, "description": "Updates the SAM user." }, "response": [ { "id": "a053efb0-e146-41cd-adde-797c2a26ac88", "name": "OK", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a053efb0-e146-41cd-adde-797c2a26ac88" }, { "id": "e08047f0-0813-49ec-becf-7b307746e09f", "name": "SAM User not found.", "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 \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/:user_name", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", ":user_name" ], "variable": [ { "key": "operator_id" }, { "key": "user_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorMessage\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"httpStatus\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e08047f0-0813-49ec-becf-7b307746e09f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-de78af3b-6f4e-422a-8b18-82fc631e5ed8" } ], "id": "86853285-d963-412a-a169-2a2db60b785f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-86853285-d963-412a-a169-2a2db60b785f" }, { "name": "default_permissions", "item": [ { "name": "Delete the default permissions", "id": "f6dd3124-7455-4ecc-88a9-2c2f262e3fda", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "409451cb-1e86-4883-ac55-3b340c68dbef", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Delete the default permissions rule that is applied to all of the SAM" }, "response": [ { "id": "37a90cfe-1d32-4280-a027-e046b06d9c03", "name": "Deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-37a90cfe-1d32-4280-a027-e046b06d9c03" }, { "id": "a5903907-8063-443f-872b-8da84999c36f", "name": "Not privileged", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a5903907-8063-443f-872b-8da84999c36f" }, { "id": "1552cb0f-ec6a-4985-aa28-fdf09ca35f37", "name": "Operator Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1552cb0f-ec6a-4985-aa28-fdf09ca35f37" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6dd3124-7455-4ecc-88a9-2c2f262e3fda" }, { "name": "Get the default permissions", "id": "c0db361d-60a8-4efa-9c80-dc33ec627dac", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "5761138b-36c9-4d68-bc23-d810c0a172ba", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Get the default permissions rule that is applied to all of the SAM users" }, "response": [ { "id": "30dbcee8-3797-41cb-8654-aae264cb980a", "name": "OK", "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}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"defaultPermissions\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-30dbcee8-3797-41cb-8654-aae264cb980a" }, { "id": "e86c89c7-9049-4093-ac47-3a5d2eace847", "name": "Not privileged", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e86c89c7-9049-4093-ac47-3a5d2eace847" }, { "id": "ef6dd7bd-0293-4316-9bc0-976a51a813e2", "name": "Operator Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ef6dd7bd-0293-4316-9bc0-976a51a813e2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c0db361d-60a8-4efa-9c80-dc33ec627dac" }, { "name": "Update the default permissions", "id": "9f30775e-883a-490a-aeb6-1af79f9b584d", "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" } ], "body": { "mode": "raw", "raw": "{\n \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "id": "4600ef86-7c3b-4d16-a835-8cc5425bd2b5", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Update the default permissions rule that is applied to all of the SAM" }, "response": [ { "id": "e83a9116-62bf-416c-8660-6930b1eb9d53", "name": "Accepted", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e83a9116-62bf-416c-8660-6930b1eb9d53" }, { "id": "6c7b9820-10dc-4d73-aad6-d8436ca79631", "name": "Bad request.", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6c7b9820-10dc-4d73-aad6-d8436ca79631" }, { "id": "a24b96d8-d270-4c7f-91ee-19ad64d39d13", "name": "Not privileged", "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 \"permissions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/users/default_permissions", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users", "default_permissions" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a24b96d8-d270-4c7f-91ee-19ad64d39d13" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9f30775e-883a-490a-aeb6-1af79f9b584d" } ], "id": "dcb9349a-25cb-4b21-b6b1-471667c3f95b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dcb9349a-25cb-4b21-b6b1-471667c3f95b" }, { "name": "Retrieve a list of SAM users", "id": "fe73f457-254b-4534-985b-2ddfa7cbf347", "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}}/operators/:operator_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users" ], "variable": [ { "id": "26beec21-211e-4a31-b8cc-dd90f94bf0ec", "key": "operator_id", "value": "", "description": "(Required) The operator ID." } ] }, "description": "Retrieves a list of SAM users." }, "response": [ { "id": "e467912d-8ca8-45dc-9c94-647d81131375", "name": "OK.", "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}}/operators/:operator_id/users", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "users" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n },\n {\n \"authKeyList\": [\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n },\n {\n \"authKeyId\": \"\",\n \"createDateTime\": \"\",\n \"lastUsedDateTime\": \"\"\n }\n ],\n \"createDateTime\": \"\",\n \"hasPassword\": \"\",\n \"roleList\": [\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"soracom\",\n \"roleName\": \"\"\n },\n {\n \"createDateTime\": \"\",\n \"roleId\": \"\",\n \"updateDateTime\": \"\",\n \"description\": \"\",\n \"owner\": \"operator\",\n \"roleName\": \"\"\n }\n ],\n \"updateDateTime\": \"\",\n \"userName\": \"\",\n \"description\": \"\",\n \"permission\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e467912d-8ca8-45dc-9c94-647d81131375" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fe73f457-254b-4534-985b-2ddfa7cbf347" } ], "id": "d80c1b83-a826-410e-98e2-4006073ea39a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d80c1b83-a826-410e-98e2-4006073ea39a" }, { "name": "Get Operator", "id": "b5861401-5178-47bf-9525-dd5bad9d1cc0", "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}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "id": "4b8679cf-dedb-4273-98e7-79d17d54a44f", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns information about the operator." }, "response": [ { "id": "d2aece0e-3743-4faa-a5e3-35eb2df55796", "name": "OK.", "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}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createDate\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"operatorId\": \"\",\n \"rootOperatorId\": \"\",\n \"updateDate\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d2aece0e-3743-4faa-a5e3-35eb2df55796" }, { "id": "77553496-c37b-434f-a42f-148ef68a00cd", "name": "Invalid Operator Id.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-77553496-c37b-434f-a42f-148ef68a00cd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b5861401-5178-47bf-9525-dd5bad9d1cc0" } ], "id": "467de572-59e8-46d6-b9ee-14e21c073988", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-467de572-59e8-46d6-b9ee-14e21c073988" }, { "name": "add_email_token", "item": [ { "name": "issue", "item": [ { "name": "Issue an authentication token to add an email address", "id": "45bcc0a8-fcb3-4979-87a8-1213344dca63", "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" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] }, "description": "Generates an authentication token for adding a new email address and sends it to the specified email address. This authentication token is used with [Email:verifyAddEmailToken API](#/Email/verifyAddEmailToken) to complete email address verification and addition.\n\n**Warning**: This API can only be executed with root user credentials.\n" }, "response": [ { "id": "01d44142-df27-4911-87db-3e5f2099eaff", "name": "Authentication token successfully issued and sent to the specified email address.", "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 \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-01d44142-df27-4911-87db-3e5f2099eaff" }, { "id": "be840b2f-11e7-4453-a5bf-a47e2a1d304b", "name": "Exceeds maximum number of emails.", "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 \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-be840b2f-11e7-4453-a5bf-a47e2a1d304b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-45bcc0a8-fcb3-4979-87a8-1213344dca63" } ], "id": "755f30a1-0661-43ec-a8e3-2d433cc68aa7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-755f30a1-0661-43ec-a8e3-2d433cc68aa7" }, { "name": "verify", "item": [ { "name": "Verify an authentication token to add an email address", "id": "ea5ee261-60bb-4720-a7c6-388620854026", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "verify" ] }, "description": "Verifies the authentication token issued by [Email:issueAddEmailToken API](#/Email/issueAddEmailToken) and adds the email address to the operator.\n\n**Warning**: Authentication tokens have an expiration time. Expired authentication tokens cannot be used.\n" }, "response": [ { "id": "54b64491-ef1a-456d-b84b-fa781242e4fd", "name": "Email address successfully verified and added to the operator.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/add_email_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "add_email_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-54b64491-ef1a-456d-b84b-fa781242e4fd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ea5ee261-60bb-4720-a7c6-388620854026" } ], "id": "1ef983eb-a29b-4de6-97ae-3d52beb77d30", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1ef983eb-a29b-4de6-97ae-3d52beb77d30" } ], "id": "5cea62a3-ba96-4188-9770-c735d1b55857", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5cea62a3-ba96-4188-9770-c735d1b55857" }, { "name": "mfa_revoke_token", "item": [ { "name": "issue", "item": [ { "name": "Issue Operator's MFA Revoke Token", "id": "f2ea1d7d-8331-4954-b1da-d974bbdd3c2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] }, "description": "Issues a token to revoke operator's MFA. The issued token will be sent to the operator via email." }, "response": [ { "id": "bc7d7779-bd71-456d-961e-6bedb8b2fddb", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bc7d7779-bd71-456d-961e-6bedb8b2fddb" }, { "id": "e10a0de7-e7e1-450b-99b4-d37a744b190c", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e10a0de7-e7e1-450b-99b4-d37a744b190c" }, { "id": "1709d470-e73b-40fb-b702-a798c9782d82", "name": "Operator not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/issue", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "issue" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1709d470-e73b-40fb-b702-a798c9782d82" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f2ea1d7d-8331-4954-b1da-d974bbdd3c2b" } ], "id": "03ee700d-b758-4f8f-809e-2e40a086c1bf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-03ee700d-b758-4f8f-809e-2e40a086c1bf" }, { "name": "verify", "item": [ { "name": "Verify Operator's MFA revoke token", "id": "42f22a75-927a-4768-8617-dc46c607f61b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] }, "description": "Verifies the one-time token which is previously issued by calling `/operators/mfa_revoke_token/issue` API, operator's email address, password, and one of the backup codes. If verified, operator's MFA is going to be revoked." }, "response": [ { "id": "16e52206-6c94-4c47-8106-f8ccd541e078", "name": "Revoked.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-16e52206-6c94-4c47-8106-f8ccd541e078" }, { "id": "8a620c2a-bdbc-4ded-ac0f-78f1b690174f", "name": "Bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8a620c2a-bdbc-4ded-ac0f-78f1b690174f" }, { "id": "6ac26f3e-ceda-403c-bdc1-fab945402693", "name": "Invalid username or password.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backupCode\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/mfa_revoke_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "operators", "mfa_revoke_token", "verify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6ac26f3e-ceda-403c-bdc1-fab945402693" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-42f22a75-927a-4768-8617-dc46c607f61b" } ], "id": "e0834340-1489-473c-a57c-b8175be2d2f9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e0834340-1489-473c-a57c-b8175be2d2f9" } ], "id": "f2cb4ad9-3ec1-481c-9e80-141cff99c216", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f2cb4ad9-3ec1-481c-9e80-141cff99c216" } ], "id": "7615433e-8e5b-4990-8af9-5f75626a4429", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7615433e-8e5b-4990-8af9-5f75626a4429" }, { "name": "orders", "item": [ { "name": "{order_id}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel order", "id": "34f2ac1a-f753-4cef-ad88-817c6a080afa", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "cancel" ], "variable": [ { "id": "694ae68f-a3a5-4db1-ac0b-76721c9f95ee", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Cancels an order. If the order has already been dispatched, an error is returned." }, "response": [ { "id": "632baf58-9b59-4264-b0df-697f596463b7", "name": "The order was cancelled.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "cancel" ], "variable": [ { "key": "order_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-632baf58-9b59-4264-b0df-697f596463b7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-34f2ac1a-f753-4cef-ad88-817c6a080afa" } ], "id": "0cc0c858-11c5-4c93-bd93-90042e50fc10", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0cc0c858-11c5-4c93-bd93-90042e50fc10" }, { "name": "confirm", "item": [ { "name": "Confirm order", "id": "eaf2e7d1-75b2-47fb-af28-0a6c777fdbe7", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "confirm" ], "variable": [ { "id": "540bc760-964f-4e88-ae26-4f2da62c183d", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Performs a credit limit and confirms the order if no problems are encountered.\n\n**Warning**: Only orders completed within the past month can be confirmed. If one month has elapsed, please redo the order placement operation.\n" }, "response": [ { "id": "89a30b76-5c09-4e5d-ae82-5243332d7c45", "name": "The confirmed order information.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"EUR\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"tempor_c1\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"dolore4\": \"\",\n \"pariatur_8\": \"\",\n \"veniam_909\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"cancelled\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"elitd22\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"nostrud_6c\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-89a30b76-5c09-4e5d-ae82-5243332d7c45" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eaf2e7d1-75b2-47fb-af28-0a6c777fdbe7" } ], "id": "a05ffbb2-c6ab-45a4-ba53-66fe7a92c53b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a05ffbb2-c6ab-45a4-ba53-66fe7a92c53b" }, { "name": "resource_initial_setting", "item": [ { "name": "Update resource initial setting for an order", "id": "05d8af7a-1ae4-4ecc-8daf-b19abba8c092", "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 \"simInitialSettings\": {\n \"sint29\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"occaecat14\": \"\",\n \"in1\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "id": "9b3ffbb8-19d2-4e51-9c93-b0f0bc951180", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Update resource initial setting for an order.\n\n**Warning**: Initial settings of IoT SIM cannot be specified after confirmation of receipt.\n" }, "response": [ { "id": "61f09dd7-15b7-4afb-b076-d47864a4bc65", "name": "The initial setting has been successfully updated.", "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 \"simInitialSettings\": {\n \"sint29\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"occaecat14\": \"\",\n \"in1\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"EUR\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"tempor_c1\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"dolore4\": \"\",\n \"pariatur_8\": \"\",\n \"veniam_909\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"cancelled\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"elitd22\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"nostrud_6c\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-61f09dd7-15b7-4afb-b076-d47864a4bc65" }, { "id": "4e6dcda7-0e16-444c-baa8-aaa1f430e8c7", "name": "The specified request has a problem.", "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 \"simInitialSettings\": {\n \"sint29\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"occaecat14\": \"\",\n \"in1\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4e6dcda7-0e16-444c-baa8-aaa1f430e8c7" }, { "id": "fc124e20-42f1-4729-a8eb-f8b44b6dffcf", "name": "Order ID not found.", "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 \"simInitialSettings\": {\n \"sint29\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"occaecat14\": \"\",\n \"in1\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fc124e20-42f1-4729-a8eb-f8b44b6dffcf" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-05d8af7a-1ae4-4ecc-8daf-b19abba8c092" } ], "id": "5798d750-b413-447e-a994-4d529045c2f1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5798d750-b413-447e-a994-4d529045c2f1" }, { "name": "subscribers", "item": [ { "name": "register", "item": [ { "name": "Register subscribers for operator", "id": "8c2b9682-b05c-4f9e-b500-f83ea2b8fe4c", "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}}/orders/:order_id/subscribers/register", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers", "register" ], "variable": [ { "id": "dbb09755-9376-437d-8b48-42396fa496e4", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Registers the ordered SIM with the operator.\n\n**Warning**: IoT SIMs can only be registered for the past 18 months. If you need to register an IoT SIM that was ordered before the time period, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "646a170b-6fe8-4fd6-95df-a49abf1a9e9d", "name": "Subscribers were registered for the operator.", "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}}/orders/:order_id/subscribers/register", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers", "register" ], "variable": [ { "key": "order_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-646a170b-6fe8-4fd6-95df-a49abf1a9e9d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8c2b9682-b05c-4f9e-b500-f83ea2b8fe4c" } ], "id": "f67b346f-dd08-4c47-832a-7a334de74f1f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f67b346f-dd08-4c47-832a-7a334de74f1f" }, { "name": "List ordered subscribers", "id": "dbed4c80-33fe-416d-a133-71d6967f49d8", "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}}/orders/:order_id/subscribers?last_evaluated_key=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers" ], "query": [ { "description": "The value of the `x-soracom-next-key` header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination).", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of subscribers in a response.", "key": "limit", "value": "" } ], "variable": [ { "id": "d59bd5d0-bbc9-4410-8ded-1c9142fb7d99", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "List ordered subscribers.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "8b5bffaa-3c38-494d-8137-92bc1183e32d", "name": "A list of ordered 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}}/orders/:order_id/subscribers?last_evaluated_key=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers" ], "query": [ { "description": "The value of the `x-soracom-next-key` header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination).", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of subscribers in a response.", "key": "limit", "value": "" } ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"orderedSubscriberList\": [\n {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"deviceSerialNumber\": \"\",\n \"eiccid\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"serialNumber\": \"\",\n \"simId\": \"\"\n },\n {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"deviceSerialNumber\": \"\",\n \"eiccid\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"serialNumber\": \"\",\n \"simId\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8b5bffaa-3c38-494d-8137-92bc1183e32d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dbed4c80-33fe-416d-a133-71d6967f49d8" } ], "id": "b8d30540-306b-42fa-a575-5bbc4e479962", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b8d30540-306b-42fa-a575-5bbc4e479962" }, { "name": "Get a confirmed order", "id": "2fac7933-eb2d-49ee-ad66-e7090082b1f2", "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}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "variable": [ { "id": "14723240-6079-465a-86b3-15e9adf8569a", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Returns a confirmed order.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "5f1feac7-1c46-49fb-90df-e5c684b6ecee", "name": "The confirmed order 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}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"EUR\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"tempor_c1\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"dolore4\": \"\",\n \"pariatur_8\": \"\",\n \"veniam_909\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"cancelled\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"elitd22\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"nostrud_6c\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5f1feac7-1c46-49fb-90df-e5c684b6ecee" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2fac7933-eb2d-49ee-ad66-e7090082b1f2" } ], "id": "5f393e07-6eea-4fbb-9b6e-9d031c23e8f3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5f393e07-6eea-4fbb-9b6e-9d031c23e8f3" }, { "name": "Get a list of confirmed order history", "id": "551f8792-3075-4090-969a-e9803d6714c4", "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}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "Get a list of confirmed order history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "d79deec1-8362-4a7f-8807-032647de8e02", "name": "A list of confirmed order history.", "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}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"orderList\": [\n {\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"USD\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"consectetur_d\": \"\",\n \"amet_d\": \"\",\n \"aute8\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"culpa_7\": \"\",\n \"fugiat1d\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"ordering\",\n \"paymentStatus\": \"delegating_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"proident_1d4\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"ipsum_c\": \"\",\n \"sint_2\": \"\",\n \"anim8\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n },\n {\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"USD\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"EUR\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"dolore_25e\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"EUR\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"nisi_9f\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"failed\",\n \"paymentStatus\": \"paying\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"proidentdb\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"animf\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d79deec1-8362-4a7f-8807-032647de8e02" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-551f8792-3075-4090-969a-e9803d6714c4" }, { "name": "Create Quotation", "id": "cd53fe20-caf2-43cc-9dbc-b49ddb1f2974", "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 \"orderItemList\": [\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "Creates a new order quotation. If the orderId is put in /orders/{order_id}/confirm, the order is complete." }, "response": [ { "id": "c7326327-0d34-42c5-8a13-d227347a6188", "name": "A new order quotation was 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 \"orderItemList\": [\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"appliedShippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ],\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"USD\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"mollita5\": \"\",\n \"Excepteur_1\": \"\",\n \"laborisc\": \"\",\n \"uta\": \"\",\n \"sint__7\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"dolor4ec\": \"\",\n \"dolore_9\": \"\",\n \"sunt_51a\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c7326327-0d34-42c5-8a13-d227347a6188" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cd53fe20-caf2-43cc-9dbc-b49ddb1f2974" } ], "id": "c98ec529-aca8-4637-9474-34f4e523ee34", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c98ec529-aca8-4637-9474-34f4e523ee34" }, { "name": "payment_history", "item": [ { "name": "transactions", "item": [ { "name": "{payment_transaction_id}", "item": [ { "name": "Get payment transaction result.", "id": "5e5f5c38-cd2d-4514-91d6-4a65a09df5d8", "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}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "id": "bc05a29a-b229-4ea3-9319-43093fdc78b4", "key": "payment_transaction_id", "value": "", "description": "(Required) Payment transaction ID. It can be obtained via [Billing:getBillingHistory API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling)." } ] }, "description": "Returns result of a payment transaction.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "0b82d946-17ee-4c5a-a0ae-dbece8041175", "name": "OK.", "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}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"paymentAmount\": \"\",\n \"subTotalAmount\": \"\",\n \"taxAmount\": \"\",\n \"taxFreeSubTotalAmount\": \"\",\n \"taxRate\": {},\n \"taxableSubTotalAmount\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n },\n \"description\": {\n \"description\": \"\",\n \"itemList\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\",\n \"messageCode\": \"incorrect_cvc\",\n \"status\": \"error\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0b82d946-17ee-4c5a-a0ae-dbece8041175" }, { "id": "c74299ee-09cb-4b32-9605-e17cbd5a5da6", "name": "Invalid payment transaction ID.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c74299ee-09cb-4b32-9605-e17cbd5a5da6" }, { "id": "ab8c2fff-3c70-42c6-9bf3-60ca980e72f1", "name": "Payment transaction result not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ab8c2fff-3c70-42c6-9bf3-60ca980e72f1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5e5f5c38-cd2d-4514-91d6-4a65a09df5d8" } ], "id": "b3f79398-9d31-40d8-ab95-28e44ee311e1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b3f79398-9d31-40d8-ab95-28e44ee311e1" } ], "id": "f6757dca-64be-4ef5-aa0d-26b5077b51b9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6757dca-64be-4ef5-aa0d-26b5077b51b9" } ], "id": "5eadb9f9-ee37-41cf-a4d7-526b4a2f3d71", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5eadb9f9-ee37-41cf-a4d7-526b4a2f3d71" }, { "name": "payment_methods", "item": [ { "name": "current", "item": [ { "name": "activate", "item": [ { "name": "Activate current payment method", "id": "3ff90e29-f3fe-48fb-b979-94bf0828477a", "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}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] }, "description": "Activates a current payment method that has an error." }, "response": [ { "id": "8027d5e5-51a7-43cb-a956-0e8dcd87aa11", "name": "OK.", "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}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8027d5e5-51a7-43cb-a956-0e8dcd87aa11" }, { "id": "43725311-1c75-429f-a932-d0646b620ff0", "name": "Payment method not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-43725311-1c75-429f-a932-d0646b620ff0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3ff90e29-f3fe-48fb-b979-94bf0828477a" } ], "id": "ade01358-784f-4ba1-b739-93398091f024", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ade01358-784f-4ba1-b739-93398091f024" }, { "name": "Get current payment method information.", "id": "aaf8ab5f-11b1-461a-aa7f-294dd80614b7", "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}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] }, "description": "Returns current payment methods. Detailed information is included in the properties." }, "response": [ { "id": "23d5f409-5c8f-4f86-82c5-e2f465384229", "name": "OK.", "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}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"invalid_cvc\",\n \"errorMessage\": \"\",\n \"properties\": \"\",\n \"providerType\": \"WebPay\",\n \"updateDate\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-23d5f409-5c8f-4f86-82c5-e2f465384229" }, { "id": "f1e849b8-881c-452a-84b3-cddc20f293e4", "name": "Payment method not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f1e849b8-881c-452a-84b3-cddc20f293e4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-aaf8ab5f-11b1-461a-aa7f-294dd80614b7" } ], "id": "0974240b-ffb9-4958-9217-010ac0ed3692", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0974240b-ffb9-4958-9217-010ac0ed3692" } ], "id": "4187f074-39ad-4127-b6eb-35f2e44b50da", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4187f074-39ad-4127-b6eb-35f2e44b50da" }, { "name": "payment_statements", "item": [ { "name": "{payment_statement_id}", "item": [ { "name": "export", "item": [ { "name": "Export payment statement", "id": "dee8abb8-8a8b-4bae-b93f-59a6c246d3f8", "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}}/payment_statements/:payment_statement_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "c9ec3624-77d0-471f-8660-64ff71f1c1ca", "key": "payment_statement_id", "value": "", "description": "(Required) Payment statement ID" } ] }, "description": "Export payment statement.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "52663c6e-a082-45f2-b6fa-111464e758f0", "name": "OK.", "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}}/payment_statements/:payment_statement_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "payment_statement_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-52663c6e-a082-45f2-b6fa-111464e758f0" }, { "id": "1feb6042-5c1a-4a0c-8f46-23d44183c01a", "name": "Invalid payment statement ID.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/:payment_statement_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "payment_statement_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1feb6042-5c1a-4a0c-8f46-23d44183c01a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dee8abb8-8a8b-4bae-b93f-59a6c246d3f8" } ], "id": "0a66a70c-3b3e-418d-8ec6-0fa02cfa38ff", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0a66a70c-3b3e-418d-8ec6-0fa02cfa38ff" } ], "id": "ad74873a-3d64-4ff5-8467-8d9bdd7a7dda", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ad74873a-3d64-4ff5-8467-8d9bdd7a7dda" }, { "name": "payer_information", "item": [ { "name": "Export payer information", "id": "6a76a56e-b01f-45ab-881c-2455a2d4998c", "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}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] }, "description": "Export payer information." }, "response": [ { "id": "882c61e1-2268-440b-a27a-79ab233da530", "name": "OK.", "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}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-882c61e1-2268-440b-a27a-79ab233da530" }, { "id": "c57624c1-1ed1-45f3-9db7-90a76aa1c3c5", "name": "Payer information not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c57624c1-1ed1-45f3-9db7-90a76aa1c3c5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6a76a56e-b01f-45ab-881c-2455a2d4998c" }, { "name": "Register payer information", "id": "781c88a2-678f-4983-a1d9-08571e92ccb9", "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" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] }, "description": "Register payer information." }, "response": [ { "id": "cf0ae776-9ea3-4a7b-8843-afebd0bc96d0", "name": "Created.", "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 \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cf0ae776-9ea3-4a7b-8843-afebd0bc96d0" }, { "id": "ee44df05-de73-4026-80f7-843b00da7b31", "name": "Invalid payer information.", "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 \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ee44df05-de73-4026-80f7-843b00da7b31" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-781c88a2-678f-4983-a1d9-08571e92ccb9" } ], "id": "814fd65e-18fa-42ce-8afc-861f796a0a2a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-814fd65e-18fa-42ce-8afc-861f796a0a2a" }, { "name": "List payment statements", "id": "42c9881a-ad31-4d6d-85cd-f448b9533ce9", "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}}/payment_statements", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements" ] }, "description": "List payment statements.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "662be4a6-6273-4b69-a9f6-b2912b7b43b0", "name": "OK.", "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}}/payment_statements", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"paymentStatementsList\": [\n {\n \"amount\": \"\",\n \"chargedYearMonths\": [\n \"\",\n \"\"\n ],\n \"currency\": \"EUR\",\n \"orderId\": \"\",\n \"paymentDateTime\": \"\",\n \"paymentInstrument\": \"\",\n \"paymentMethod\": \"\",\n \"paymentStatementId\": \"\",\n \"paymentStatementInfo\": \"\"\n },\n {\n \"amount\": \"\",\n \"chargedYearMonths\": [\n \"\",\n \"\"\n ],\n \"currency\": \"JPY\",\n \"orderId\": \"\",\n \"paymentDateTime\": \"\",\n \"paymentInstrument\": \"\",\n \"paymentMethod\": \"\",\n \"paymentStatementId\": \"\",\n \"paymentStatementInfo\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-662be4a6-6273-4b69-a9f6-b2912b7b43b0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-42c9881a-ad31-4d6d-85cd-f448b9533ce9" } ], "id": "dbaca4c8-ecea-49ee-9a58-bb3e9dac0e6a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dbaca4c8-ecea-49ee-9a58-bb3e9dac0e6a" }, { "name": "port_mappings", "item": [ { "name": "{ip_address}", "item": [ { "name": "{port}", "item": [ { "name": "Delete Napter On-Demand Remote Access entry", "id": "ddfffafa-7f30-4f23-a0cb-1081901d2808", "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}}/port_mappings/:ip_address/:port", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", ":ip_address", ":port" ], "variable": [ { "id": "eca10980-49c8-46fc-8616-0ea199bab308", "key": "ip_address", "value": "", "description": "(Required) IP address of the On-Demand Remote Access entry to be deleted." }, { "id": "2b4cde2b-1bc5-4759-a05e-3b6527807285", "key": "port", "value": "", "description": "(Required) Port number of the On-Demand Remote Access entry to be deleted." } ] }, "description": "Deletes the specified Napter On-Demand Remote Access entry." }, "response": [ { "id": "9323cc7a-eadd-4856-a4cb-45edc50bd53a", "name": "The specified On-Demand Remote Access entry has been deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/port_mappings/:ip_address/:port", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", ":ip_address", ":port" ], "variable": [ { "key": "ip_address" }, { "key": "port" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9323cc7a-eadd-4856-a4cb-45edc50bd53a" }, { "id": "5d9baa79-6d68-40e6-99e8-1f4d48bdeb75", "name": "The specified On-Demand Remote Access entry 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}}/port_mappings/:ip_address/:port", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", ":ip_address", ":port" ], "variable": [ { "key": "ip_address" }, { "key": "port" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5d9baa79-6d68-40e6-99e8-1f4d48bdeb75" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ddfffafa-7f30-4f23-a0cb-1081901d2808" } ], "id": "7d1bb4e7-339d-4007-b446-2076234e789c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7d1bb4e7-339d-4007-b446-2076234e789c" } ], "id": "e8cdc1d2-1556-484d-ae0b-86a33edf617c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e8cdc1d2-1556-484d-ae0b-86a33edf617c" }, { "name": "sims", "item": [ { "name": "{sim_id}", "item": [ { "name": "Retrieve a list of Napter On-Demand Remote Access entries created with specified SIM ID", "id": "f490604a-890e-485f-a087-f2ecf703c1b2", "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}}/port_mappings/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "sims", ":sim_id" ], "variable": [ { "id": "83530a1d-0d16-443d-bac5-47fef152b55d", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM." } ] }, "description": "Retrieves a list of Napter On-Demand Remote Access entries created with the specified SIM ID." }, "response": [ { "id": "5ca33bc8-3424-4573-9911-64e2a95c39a0", "name": "A list of On-Demand Remote Access entries created with the specified SIM ID.", "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}}/port_mappings/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "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 {\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"IMSI_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"air\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"AIR_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5ca33bc8-3424-4573-9911-64e2a95c39a0" }, { "id": "4d7ac8b9-469f-49c2-a683-af8236a23782", "name": "No On-Demand Remote Access entries exist for the specified SIM ID.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/port_mappings/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4d7ac8b9-469f-49c2-a683-af8236a23782" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f490604a-890e-485f-a087-f2ecf703c1b2" }, { "name": "Create Napter On-Demand Remote Access entry with specified SIM ID", "id": "ca62967c-4cd8-4e06-80fb-1fc360a464cb", "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 \"destination\": {\n \"port\": \"\",\n \"service\": \"air\"\n },\n \"duration\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/port_mappings/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "sims", ":sim_id" ], "variable": [ { "id": "a96ec1d6-d978-476f-a947-944e1eadb6dd", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target IoT SIM." } ] }, "description": "Create a new Napter On-Demand Remote Access entry with the specified SIM ID." }, "response": [ { "id": "39a16a48-bb24-47b8-a046-36af1033e79f", "name": "The On-Demand Remote Access entry 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 \"destination\": {\n \"port\": \"\",\n \"service\": \"air\"\n },\n \"duration\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/port_mappings/sims/:sim_id", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "sims", ":sim_id" ], "variable": [ { "key": "sim_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"ARC_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-39a16a48-bb24-47b8-a046-36af1033e79f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ca62967c-4cd8-4e06-80fb-1fc360a464cb" } ], "id": "8a643557-0c50-4ad5-ab42-fc831eb114d1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8a643557-0c50-4ad5-ab42-fc831eb114d1" } ], "id": "dc9dfb93-09da-4e76-b68c-ea7cf1b7b5af", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dc9dfb93-09da-4e76-b68c-ea7cf1b7b5af" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Retrieve a list of Napter On-Demand Remote Access entries created with specified IMSI", "id": "1e067b65-1c5c-4c28-8cbc-eccd96efdb0c", "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}}/port_mappings/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "subscribers", ":imsi" ], "variable": [ { "id": "43bb5fae-18c1-4d59-8089-f1a6d1d3de4a", "key": "imsi", "value": "", "description": "(Required) IMSI of the target." } ] }, "description": "Retrieves a list of Napter On-Demand Remote Access entries where `destinationChoosingStrategy` is `IMSI_PRIORITIZED` (entries created with specified IMSI).\n" }, "response": [ { "id": "af449f3a-016a-4a74-8037-4cd46b3e26c5", "name": "A list of On-Demand Remote Access entries where `destinationChoosingStrategy` is `IMSI_PRIORITIZED`.\n", "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}}/port_mappings/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"IMSI_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"air\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"AIR_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af449f3a-016a-4a74-8037-4cd46b3e26c5" }, { "id": "40c87f74-2825-4804-b6f5-204c3b3302b6", "name": "No On-Demand Remote Access entries exist for the specified IMSI.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/port_mappings/subscribers/:imsi", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings", "subscribers", ":imsi" ], "variable": [ { "key": "imsi" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-40c87f74-2825-4804-b6f5-204c3b3302b6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1e067b65-1c5c-4c28-8cbc-eccd96efdb0c" } ], "id": "036cb462-dd17-461f-978c-11bf1e244a0b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-036cb462-dd17-461f-978c-11bf1e244a0b" } ], "id": "c1d5f9db-3500-4331-ad7e-afb952faa954", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c1d5f9db-3500-4331-ad7e-afb952faa954" }, { "name": "Retrieve a list of Napter On-Demand Remote Access entries", "id": "0c055171-e18a-49e7-9615-c5847c2b13c0", "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}}/port_mappings?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings" ], "query": [ { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last On-Demand Remote Access ID retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next entry onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of Napter On-Demand Remote Access entries." }, "response": [ { "id": "1f1019cd-0f8f-4031-8c6d-7448a697231f", "name": "A list of On-Demand Remote Access 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}}/port_mappings?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings" ], "query": [ { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last On-Demand Remote Access ID retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next entry 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 \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"IMSI_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"air\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"AIR_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1f1019cd-0f8f-4031-8c6d-7448a697231f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0c055171-e18a-49e7-9615-c5847c2b13c0" }, { "name": "Create Napter On-Demand Remote Access entry", "id": "c72ffc7a-245f-4854-a133-5e56cc14d9f7", "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 \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"ARC_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/port_mappings", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings" ] }, "description": "Create a new Napter On-Demand Remote Access entry." }, "response": [ { "id": "3f3e6dd9-ce7a-45fe-88eb-ce63a246e8bb", "name": "The On-Demand Remote Access entry 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 \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"ARC_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/port_mappings", "host": [ "{{baseUrl}}" ], "path": [ "port_mappings" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"destination\": {\n \"port\": \"\",\n \"destinationChoosingStrategy\": \"ARC_PRIORITIZED\",\n \"imsi\": \"\",\n \"service\": \"arc\",\n \"simId\": \"\"\n },\n \"duration\": \"\",\n \"endpoint\": \"\",\n \"expired\": \"\",\n \"expiredTime\": \"\",\n \"hostname\": \"\",\n \"imsi\": \"\",\n \"ipAddress\": \"\",\n \"operatorId\": \"\",\n \"placement\": \"\",\n \"port\": \"\",\n \"simId\": \"\",\n \"source\": {\n \"ipRanges\": [\n \"\",\n \"\"\n ]\n },\n \"tlsRequired\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3f3e6dd9-ce7a-45fe-88eb-ce63a246e8bb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c72ffc7a-245f-4854-a133-5e56cc14d9f7" } ], "id": "37aa6a83-2f4b-4b1f-a78c-2bb7294e5c24", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-37aa6a83-2f4b-4b1f-a78c-2bb7294e5c24" }, { "name": "products", "item": [ { "name": "List products", "id": "bb9c089f-8f5e-4221-8269-2248b7758129", "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}}/products?campaign_code=", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "campaign_code", "value": "" } ] }, "description": "Returns a list of products." }, "response": [ { "id": "13fb479f-cf7b-41fa-a341-0e53354ce5d2", "name": "A list of available products.", "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}}/products?campaign_code=", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "campaign_code", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"productList\": [\n {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"consequat7\": \"\",\n \"in_1b\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"mollitb_\": \"\",\n \"pariatur_d5c\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n }\n ],\n \"shippingCostList\": [\n {\n \"currency\": \"EUR\",\n \"shippingArea\": \"shinetsu\",\n \"shippingAreaName\": \"\",\n \"shippingCost\": \"\",\n \"size\": \"\"\n },\n {\n \"currency\": \"JPY\",\n \"shippingArea\": \"kanto\",\n \"shippingAreaName\": \"\",\n \"shippingCost\": \"\",\n \"size\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-13fb479f-cf7b-41fa-a341-0e53354ce5d2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bb9c089f-8f5e-4221-8269-2248b7758129" } ], "id": "8d36f582-2671-4919-83ec-9744f8b4e5da", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8d36f582-2671-4919-83ec-9744f8b4e5da" }, { "name": "query", "item": [ { "name": "devices", "item": [ { "name": "Search Soracom Inventory devices by query", "id": "c43b122f-2d18-4b63-b386-ce3c4fceeea0", "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}}/query/devices?name=&name=&group=&group=&group_id=&group_id=&deviceId=&deviceId=&tag=&tag=&imsi=&imsi=&imei=&imei=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Soracom Inventory device ID to search.", "key": "deviceId", "value": "" }, { "description": "Soracom Inventory device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "IMSI of the device that was used on bootstrapping.", "key": "imsi", "value": "" }, { "description": "IMSI of the device that was used on bootstrapping.", "key": "imsi", "value": "" }, { "description": "IMEI of the device that was used on bootstrapping.", "key": "imei", "value": "" }, { "description": "IMEI of the device that was used on bootstrapping.", "key": "imei", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Soracom Inventory device ID of the last Inventory device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] }, "description": "Search Soracom Inventory devices by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all Soracom Inventory devices that include their group information.\n\n**Warning**: Use this API when the device ID of the target Inventory device is unknown, or when you want to retrieve a list of Inventory devices that match conditions. If you know the device ID, use the [Device:getDevice API](#/Device/getDevice).\n" }, "response": [ { "id": "7ecb7b38-fdbf-4a2a-a1aa-03029051fe4c", "name": "Returns result of searching.", "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}}/query/devices?name=&group=&group_id=&deviceId=&tag=&imsi=&imei=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Soracom Inventory device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "IMSI of the device that was used on bootstrapping.", "key": "imsi", "value": "" }, { "description": "IMEI of the device that was used on bootstrapping.", "key": "imei", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Soracom Inventory device ID of the last Inventory device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"laborum1\": \"\",\n \"officiaaa\": \"\",\n \"Lorem3\": \"\",\n \"irure_a75\": \"\"\n }\n },\n {\n \"device_id\": \"\",\n \"endpoint\": \"\",\n \"firmwareVersion\": \"\",\n \"groupId\": \"\",\n \"ipAddress\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastRegistrationUpdate\": \"\",\n \"manufacturer\": \"\",\n \"modelNumber\": \"\",\n \"objects\": {},\n \"online\": false,\n \"operatorId\": \"\",\n \"registrationId\": \"\",\n \"registrationLifeTime\": \"\",\n \"serialNumber\": \"\",\n \"tags\": {\n \"nulla_6\": \"\",\n \"ipsum_3\": \"\",\n \"anim_4d5\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7ecb7b38-fdbf-4a2a-a1aa-03029051fe4c" }, { "id": "f22e61a3-a5d5-4925-ad2c-2db587cee76c", "name": "Invalid search queries.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/query/devices?name=&group=&group_id=&deviceId=&tag=&imsi=&imei=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Soracom Inventory device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "IMSI of the device that was used on bootstrapping.", "key": "imsi", "value": "" }, { "description": "IMEI of the device that was used on bootstrapping.", "key": "imei", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Soracom Inventory device ID of the last Inventory device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f22e61a3-a5d5-4925-ad2c-2db587cee76c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c43b122f-2d18-4b63-b386-ce3c4fceeea0" } ], "id": "65cdc28d-b783-4936-9c72-c1a468fe89ba", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-65cdc28d-b783-4936-9c72-c1a468fe89ba" }, { "name": "sigfox_devices", "item": [ { "name": "Search Sigfox devices by query", "id": "8d26a1b5-408a-4dce-ba71-0eb4a329c083", "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}}/query/sigfox_devices?name=&name=&group=&group=&group_id=&group_id=&deviceId=&deviceId=&tag=&tag=&status=and®istration=and&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sigfox_devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Sigfox device ID to search.", "key": "deviceId", "value": "" }, { "description": "Sigfox device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Status of Sigfox devices.", "key": "status", "value": "and" }, { "description": "Registration status of Sigfox devices.", "key": "registration", "value": "and" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Sigfox device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] }, "description": "Search Sigfox devices by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all Sigfox devices that includes their group information.\n\n**Warning**: Use this API when the device ID of the target Sigfox device is unknown, or when you want to retrieve a list of Sigfox devices that match conditions. If you know the device ID, use the [SigfoxDevice:getSigfoxDevice API](#/SigfoxDevice/getSigfoxDevice).\n" }, "response": [ { "id": "af5c36a2-ccbf-4b37-b33b-68553e52f7b4", "name": "Returns result of searching.", "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}}/query/sigfox_devices?name=&group=&group_id=&deviceId=&tag=&status=and®istration=and&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sigfox_devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Sigfox device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Status of Sigfox devices.", "key": "status", "value": "and" }, { "description": "Registration status of Sigfox devices.", "key": "registration", "value": "and" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Sigfox device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"sit_b8b\": \"\"\n },\n \"terminationEnabled\": false\n },\n {\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"idc\": \"\"\n },\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af5c36a2-ccbf-4b37-b33b-68553e52f7b4" }, { "id": "fb5131fc-c73d-4095-933b-71c65846c32d", "name": "Invalid search queries.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/query/sigfox_devices?name=&group=&group_id=&deviceId=&tag=&status=and®istration=and&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sigfox_devices" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group ID to search.", "key": "group_id", "value": "" }, { "description": "Sigfox device ID to search.", "key": "deviceId", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Status of Sigfox devices.", "key": "status", "value": "and" }, { "description": "Registration status of Sigfox devices.", "key": "registration", "value": "and" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The Sigfox device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.", "key": "last_evaluated_key", "value": "" }, { "description": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fb5131fc-c73d-4095-933b-71c65846c32d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8d26a1b5-408a-4dce-ba71-0eb4a329c083" } ], "id": "6c210b2c-45a1-48df-9365-759fc528ec3f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6c210b2c-45a1-48df-9365-759fc528ec3f" }, { "name": "sims", "item": [ { "name": "Search SIMs by query terms", "id": "f82f44e0-4a6e-4bdf-bca4-16d93c581dcd", "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}}/query/sims?name=&name=&group=&group=&group_id=&group_id=&sim_id=&sim_id=&imsi=&imsi=&msisdn=&msisdn=&iccid=&iccid=&serial_number=&serial_number=&tag=&tag=&bundles=&bundles=&status=&status=&session_status=NA&subscription=&subscription=&module_type=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sims" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name of the [group](/en/docs/groups/) to which the IoT SIM belongs.", "key": "group", "value": "" }, { "description": "Name of the [group](/en/docs/groups/) to which the IoT SIM belongs.", "key": "group", "value": "" }, { "description": "Search for IoT SIMs whose group ID matches the specified value.", "key": "group_id", "value": "" }, { "description": "Search for IoT SIMs whose group ID matches the specified value.", "key": "group_id", "value": "" }, { "description": "Identifier of the SIM to search.", "key": "sim_id", "value": "" }, { "description": "Identifier of the SIM to search.", "key": "sim_id", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search. An identifier used to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber).", "key": "iccid", "value": "" }, { "description": "ICCID to search. An identifier used to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber).", "key": "iccid", "value": "" }, { "description": "Serial number to search. This is set only for IoT SIMs for specific regions.", "key": "serial_number", "value": "" }, { "description": "Serial number to search. This is set only for IoT SIMs for specific regions.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags).", "key": "tag", "value": "" }, { "description": "String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags).", "key": "tag", "value": "" }, { "description": "Bundles type to search.", "key": "bundles", "value": "" }, { "description": "Bundles type to search.", "key": "bundles", "value": "" }, { "description": "Status of the IoT SIM to search.\n\n- `ready`\n- `active`\n- `inactive`\n- `standby`\n- `suspended`\n- `terminated`\n- `shipped`\n", "key": "status", "value": "" }, { "description": "Status of the IoT SIM to search.\n\n- `ready`\n- `active`\n- `inactive`\n- `standby`\n- `suspended`\n- `terminated`\n- `shipped`\n", "key": "status", "value": "" }, { "description": "Status of the session to search. Specify one of the following:\n\n- `NA`: Any.\n- `ONLINE`: Online.\n- `OFFLINE`: Offline.\n", "key": "session_status", "value": "NA" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "The form factor of the physical SIM to search.\n\n- `mini`: standard (2FF) size.\n- `micro`: micro (3FF) size.\n- `nano`: nano (4FF) size.\n- `trio`: 3 in 1 (can be cut into 2FF/3FF/4FF depending on how you cut it).\n- `embedded`: Embedded (MFF2).\n- `virtual`: Virtual SIM/Subscriber.\n- `integrated`: Embedded (iSIM).\n- `profilePackage`: Profile Package (eSIM profile).\n", "key": "module_type", "value": "" }, { "description": "The form factor of the physical SIM to search.\n\n- `mini`: standard (2FF) size.\n- `micro`: micro (3FF) size.\n- `nano`: nano (4FF) size.\n- `trio`: 3 in 1 (can be cut into 2FF/3FF/4FF depending on how you cut it).\n- `embedded`: Embedded (MFF2).\n- `virtual`: Virtual SIM/Subscriber.\n- `integrated`: Embedded (iSIM).\n- `profilePackage`: Profile Package (eSIM profile).\n", "key": "module_type", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward.", "key": "last_evaluated_key", "value": "" }, { "description": "The type of search condition.\n\n- AND: SIMs which match all of the search parameters will be returned (default).\n- OR: SIMs which match any of the search parameters will be returned.\n\nIf the value of a search parameter contains a comma `,` (or `%2C` when URL-encoded), the value will be split at each comma and treated as multiple search values, each of which will be evaluated based on the specified AND or OR condition.\n", "key": "search_type", "value": "and" } ] }, "description": "Searches for SIMs using specified query parameters.\n\n- Supports partial matching.\n- Case-insensitive.\n- Multiple search values can be specified for the following parameters by separating each value with a comma `,` (or `%2C` when URL-encoded). Note that the literal character `,` itself cannot be used as part of a search value.\n - `name`\n - `group`\n - `sim_id`\n - `imsi`\n - `msisdn`\n - `iccid`\n - `serial_number`\n - `tag`\n - `status`\n - `subscription`\n - `module_type`\n- Each search value must be at least 2 characters long. When using a comma `,` to specify multiple search values, each value must also be at least 2 characters long (e.g., `ab,c` is invalid because `c` is only 1 character long).\n- When multiple query parameters are specified, the search type (AND search or OR search) can be specified using `search_type`.\n\n**Warning**: When this API permission is allowed, it grants the authority to search and retrieve all SIMs that include their group information.\n\n**Warning**: Use this API when the SIM ID of the target IoT SIM is unknown, or when you want to retrieve a list of SIMs that match certain conditions. If you know the SIM ID, please use the [Sim:getSim API](#/Sim/getSim) instead.\n" }, "response": [ { "id": "00e0adc1-3b18-4059-8a38-a8f99787674f", "name": "Returns result of searching.", "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}}/query/sims?name=&group=&group_id=&sim_id=&imsi=&msisdn=&iccid=&serial_number=&tag=&bundles=&status=&session_status=NA&subscription=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sims" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name of the [group](/en/docs/groups/) to which the IoT SIM belongs.", "key": "group", "value": "" }, { "description": "Search for IoT SIMs whose group ID matches the specified value.", "key": "group_id", "value": "" }, { "description": "Identifier of the SIM to search.", "key": "sim_id", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search. An identifier used to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber).", "key": "iccid", "value": "" }, { "description": "Serial number to search. This is set only for IoT SIMs for specific regions.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags).", "key": "tag", "value": "" }, { "description": "Bundles type to search.", "key": "bundles", "value": "" }, { "description": "Status of the IoT SIM to search.\n\n- `ready`\n- `active`\n- `inactive`\n- `standby`\n- `suspended`\n- `terminated`\n- `shipped`\n", "key": "status", "value": "" }, { "description": "Status of the session to search. Specify one of the following:\n\n- `NA`: Any.\n- `ONLINE`: Online.\n- `OFFLINE`: Offline.\n", "key": "session_status", "value": "NA" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "The form factor of the physical SIM to search.\n\n- `mini`: standard (2FF) size.\n- `micro`: micro (3FF) size.\n- `nano`: nano (4FF) size.\n- `trio`: 3 in 1 (can be cut into 2FF/3FF/4FF depending on how you cut it).\n- `embedded`: Embedded (MFF2).\n- `virtual`: Virtual SIM/Subscriber.\n- `integrated`: Embedded (iSIM).\n- `profilePackage`: Profile Package (eSIM profile).\n", "key": "module_type", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward.", "key": "last_evaluated_key", "value": "" }, { "description": "The type of search condition.\n\n- AND: SIMs which match all of the search parameters will be returned (default).\n- OR: SIMs which match any of the search parameters will be returned.\n\nIf the value of a search parameter contains a comma `,` (or `%2C` when URL-encoded), the value will be split at each comma and treated as multiple search values, each of which will be evaluated based on the specified AND or OR condition.\n", "key": "search_type", "value": "and" } ] } }, "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\": \"suspend\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"veniam_b7\": \"\",\n \"essed0\": \"\"\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\": \"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 \"profiles\": {\n \"amet5a\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"consectetur_2\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\n \"subscription\": \"\"\n },\n \"eu4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"non9\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"Lorembe\": {\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\": \"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-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"in9\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\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\": \"deleteSession\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"Excepteur_e3e\": \"\"\n },\n \"moduleType\": \"trio\",\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 \"ad_01\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam0e0\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"laborum_5\": \"\",\n \"Ute2\": \"\",\n \"eu717\": \"\",\n \"deserunt3\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-00e0adc1-3b18-4059-8a38-a8f99787674f" }, { "id": "d1e9f880-e5bb-4b7a-b944-c57e6b0bbebb", "name": "Invalid search queries.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/query/sims?name=&group=&group_id=&sim_id=&imsi=&msisdn=&iccid=&serial_number=&tag=&bundles=&status=&session_status=NA&subscription=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "sims" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name of the [group](/en/docs/groups/) to which the IoT SIM belongs.", "key": "group", "value": "" }, { "description": "Search for IoT SIMs whose group ID matches the specified value.", "key": "group_id", "value": "" }, { "description": "Identifier of the SIM to search.", "key": "sim_id", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search. An identifier used to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber).", "key": "iccid", "value": "" }, { "description": "Serial number to search. This is set only for IoT SIMs for specific regions.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags).", "key": "tag", "value": "" }, { "description": "Bundles type to search.", "key": "bundles", "value": "" }, { "description": "Status of the IoT SIM to search.\n\n- `ready`\n- `active`\n- `inactive`\n- `standby`\n- `suspended`\n- `terminated`\n- `shipped`\n", "key": "status", "value": "" }, { "description": "Status of the session to search. Specify one of the following:\n\n- `NA`: Any.\n- `ONLINE`: Online.\n- `OFFLINE`: Offline.\n", "key": "session_status", "value": "NA" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "The form factor of the physical SIM to search.\n\n- `mini`: standard (2FF) size.\n- `micro`: micro (3FF) size.\n- `nano`: nano (4FF) size.\n- `trio`: 3 in 1 (can be cut into 2FF/3FF/4FF depending on how you cut it).\n- `embedded`: Embedded (MFF2).\n- `virtual`: Virtual SIM/Subscriber.\n- `integrated`: Embedded (iSIM).\n- `profilePackage`: Profile Package (eSIM profile).\n", "key": "module_type", "value": "" }, { "description": "The maximum number of items to retrieve.", "key": "limit", "value": "10" }, { "description": "The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward.", "key": "last_evaluated_key", "value": "" }, { "description": "The type of search condition.\n\n- AND: SIMs which match all of the search parameters will be returned (default).\n- OR: SIMs which match any of the search parameters will be returned.\n\nIf the value of a search parameter contains a comma `,` (or `%2C` when URL-encoded), the value will be split at each comma and treated as multiple search values, each of which will be evaluated based on the specified AND or OR condition.\n", "key": "search_type", "value": "and" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d1e9f880-e5bb-4b7a-b944-c57e6b0bbebb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f82f44e0-4a6e-4bdf-bca4-16d93c581dcd" } ], "id": "4eab85ec-24ae-4b5b-9cb4-c529ddb05a11", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4eab85ec-24ae-4b5b-9cb4-c529ddb05a11" }, { "name": "subscribers", "item": [ { "name": "traffic_volume", "item": [ { "name": "ranking", "item": [ { "name": "Search traffic volume ranking of subscribers", "id": "3bec5457-2142-44da-bfa6-8c6f283feeb0", "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}}/query/subscribers/traffic_volume/ranking?from=&to=&limit=10&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "query", "subscribers", "traffic_volume", "ranking" ], "query": [ { "description": "(Required) The beginning point of searching range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "(Required) The end point of searching range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "The maximum number of item to retrieve.", "key": "limit", "value": "10" }, { "description": "The order of ranking.", "key": "order", "value": "desc" } ] }, "description": "Search traffic volume ranking of subscribers." }, "response": [ { "id": "0f843b25-fa4a-4dcc-b833-a1fbc64ca28d", "name": "OK.", "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}}/query/subscribers/traffic_volume/ranking?from=&to=&limit=10&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "query", "subscribers", "traffic_volume", "ranking" ], "query": [ { "description": "(Required) The beginning point of searching range (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "(Required) The end point of searching range (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "The maximum number of item to retrieve.", "key": "limit", "value": "10" }, { "description": "The order of ranking.", "key": "order", "value": "desc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"imsi\": \"\",\n \"trafficVolume\": \"\"\n },\n {\n \"imsi\": \"\",\n \"trafficVolume\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0f843b25-fa4a-4dcc-b833-a1fbc64ca28d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3bec5457-2142-44da-bfa6-8c6f283feeb0" } ], "id": "357798a2-729d-4422-9c1f-5d6843da273e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-357798a2-729d-4422-9c1f-5d6843da273e" } ], "id": "ec2cc6d0-39f7-4cc3-8e58-3295d605a4d6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ec2cc6d0-39f7-4cc3-8e58-3295d605a4d6" }, { "name": "(DEPRECATED) Search subscribers by query terms", "id": "97c55550-a588-4e78-8558-4ffd3b8881b2", "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}}/query/subscribers?name=&name=&group=&group=&imsi=&imsi=&msisdn=&msisdn=&iccid=&iccid=&serial_number=&serial_number=&tag=&tag=&subscription=&subscription=&module_type=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "subscribers" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search.", "key": "iccid", "value": "" }, { "description": "ICCID to search.", "key": "iccid", "value": "" }, { "description": "Serial number to search.", "key": "serial_number", "value": "" }, { "description": "Serial number to search.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "Module type (e.g. `mini`, `virtual`) to search.", "key": "module_type", "value": "" }, { "description": "Module type (e.g. `mini`, `virtual`) to search.", "key": "module_type", "value": "" }, { "description": "The maximum number of item to retrieve.", "key": "limit", "value": "10" }, { "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": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] }, "description": "(DEPRECATED: please consider to use `/query/sims` API instead ) Search subscribers by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information." }, "response": [ { "id": "47a170dd-6b03-49c0-9718-c72e9f1eddc2", "name": "Returns result of searching.", "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}}/query/subscribers?name=&group=&imsi=&msisdn=&iccid=&serial_number=&tag=&subscription=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "subscribers" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search.", "key": "iccid", "value": "" }, { "description": "Serial number to search.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "Module type (e.g. `mini`, `virtual`) to search.", "key": "module_type", "value": "" }, { "description": "The maximum number of item to retrieve.", "key": "limit", "value": "10" }, { "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": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "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\": \"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\": \"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\": \"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\": \"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\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"standby\",\n \"subscription\": \"\",\n \"tags\": {\n \"ex_109\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\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\": \"profilePackage\",\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\": \"LTE\",\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\": \"standby\",\n \"subscription\": \"\",\n \"tags\": {\n \"consectetur_de\": \"\",\n \"ind6\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-47a170dd-6b03-49c0-9718-c72e9f1eddc2" }, { "id": "367923ee-d0ea-48e8-90d4-8d8e17f64d50", "name": "Invalid search queries.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/query/subscribers?name=&group=&imsi=&msisdn=&iccid=&serial_number=&tag=&subscription=&module_type=&limit=10&last_evaluated_key=&search_type=and", "host": [ "{{baseUrl}}" ], "path": [ "query", "subscribers" ], "query": [ { "description": "Name to search.", "key": "name", "value": "" }, { "description": "Group name to search.", "key": "group", "value": "" }, { "description": "IMSI to search.", "key": "imsi", "value": "" }, { "description": "MSISDN to search.", "key": "msisdn", "value": "" }, { "description": "ICCID to search.", "key": "iccid", "value": "" }, { "description": "Serial number to search.", "key": "serial_number", "value": "" }, { "description": "String of tag values to search.", "key": "tag", "value": "" }, { "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n", "key": "subscription", "value": "" }, { "description": "Module type (e.g. `mini`, `virtual`) to search.", "key": "module_type", "value": "" }, { "description": "The maximum number of item to retrieve.", "key": "limit", "value": "10" }, { "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": "Type of the search ('AND searching' or 'OR searching').", "key": "search_type", "value": "and" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-367923ee-d0ea-48e8-90d4-8d8e17f64d50" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-97c55550-a588-4e78-8558-4ffd3b8881b2" } ], "id": "2a0573e9-ced7-4cc7-983e-d106c22fde6b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a0573e9-ced7-4cc7-983e-d106c22fde6b" } ], "id": "2ba54d38-8f81-494d-8c13-acaec201da85", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2ba54d38-8f81-494d-8c13-acaec201da85" }, { "name": "resource_summaries", "item": [ { "name": "{resource_summary_type}", "item": [ { "name": "Get the resource summary identified by resource_summary_type", "id": "14ee41a6-9a61-4742-b12e-dbb15b881e7b", "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}}/resource_summaries/:resource_summary_type", "host": [ "{{baseUrl}}" ], "path": [ "resource_summaries", ":resource_summary_type" ], "variable": [ { "id": "11b57284-a754-4847-bf9b-dc910b0e6a94", "key": "resource_summary_type", "value": "simsPerStatus", "description": "(Required) The type of the resource summary.\n\n- `simsPerStatus`: The number of IoT SIMs per status.\n" } ] }, "description": "Obtain a resource summary information identified by resource_summary_type." }, "response": [ { "id": "c9ec0411-021a-460b-9c89-f7f35ec3558d", "name": "The resource summary was found.", "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}}/resource_summaries/:resource_summary_type", "host": [ "{{baseUrl}}" ], "path": [ "resource_summaries", ":resource_summary_type" ], "variable": [ { "key": "resource_summary_type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resourceSummaryItems\": [\n {\n \"dimensions\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"updatedTime\": \"\",\n \"values\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"dimensions\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"updatedTime\": \"\",\n \"values\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"resourceSummaryType\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c9ec0411-021a-460b-9c89-f7f35ec3558d" }, { "id": "0c3ba702-7474-451c-917a-101fe6b11f90", "name": "No such resource summary.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/resource_summaries/:resource_summary_type", "host": [ "{{baseUrl}}" ], "path": [ "resource_summaries", ":resource_summary_type" ], "variable": [ { "key": "resource_summary_type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0c3ba702-7474-451c-917a-101fe6b11f90" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-14ee41a6-9a61-4742-b12e-dbb15b881e7b" } ], "id": "46a5cdd1-d4a3-46ff-9e1a-7b6e6aff2bce", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-46a5cdd1-d4a3-46ff-9e1a-7b6e6aff2bce" } ], "id": "299dc641-bce7-4654-8cf7-bdf093bfbcc5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-299dc641-bce7-4654-8cf7-bdf093bfbcc5" }, { "name": "sigfox_devices", "item": [ { "name": "{device_id}", "item": [ { "name": "data", "item": [ { "name": "Retrieves data sent from a Sigfox device to Harvest Data", "id": "6280dfff-1e58-46e8-ac03-0dfe9e5d16db", "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}}/sigfox_devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "43b434dd-bf69-4719-9ead-07774ed90aa4", "key": "device_id", "value": "", "description": "(Required) ID of the Sigfox device from which to retrieve data. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." } ] }, "description": "Retrieves data that matches the specified conditions from the data sent by the specified Sigfox device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, "response": [ { "id": "bc9195ad-0a2e-47c8-81cc-b440f0240326", "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}}/sigfox_devices/:device_id/data?from=&to=&sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "data" ], "query": [ { "description": "Start time of the target period (UNIX time in milliseconds).", "key": "from", "value": "" }, { "description": "End time of the target period (UNIX time in milliseconds).", "key": "to", "value": "" }, { "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`.", "key": "limit", "value": "" }, { "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "device_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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bc9195ad-0a2e-47c8-81cc-b440f0240326" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6280dfff-1e58-46e8-ac03-0dfe9e5d16db" }, { "name": "Send data to a Sigfox device.", "id": "486e66b2-7484-47f7-a857-0860e1b8f52b", "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" } ], "body": { "mode": "raw", "raw": "{\n \"data\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "data" ], "variable": [ { "id": "41fbbb4a-6e79-493b-ba35-0c16b2d09c8c", "key": "device_id", "value": "", "description": "(Required) ID of the recipient device." } ] }, "description": "Sends data to the specified Sigfox device. The data will be stored until the device sends a next uplink message. If another message destined for the same Sigfox device ID is already waiting to be sent, the existing message will be discarded, and the new message will be sent instead." }, "response": [ { "id": "858a87fa-6211-4fa2-8626-de950512abfa", "name": "Data has been received by server and waiting for the recipient device to retrieve.", "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 \"data\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-858a87fa-6211-4fa2-8626-de950512abfa" }, { "id": "e7641c4a-2def-4cb1-99a4-932a35b4d12d", "name": "No such device 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 \"data\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e7641c4a-2def-4cb1-99a4-932a35b4d12d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-486e66b2-7484-47f7-a857-0860e1b8f52b" } ], "id": "c62bd3a1-5c8c-4e68-a89b-c0ad2790269d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c62bd3a1-5c8c-4e68-a89b-c0ad2790269d" }, { "name": "disable_termination", "item": [ { "name": "Disable Termination of Sigfox device.", "id": "d2b5b564-8a79-4cb8-87b8-6a10deb7c40a", "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}}/sigfox_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "disable_termination" ], "variable": [ { "id": "17d34571-66b4-4a0e-8f38-b7713f04893a", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." } ] }, "description": "Disables termination of specified Sigfox device." }, "response": [ { "id": "a91c98b4-7b6a-4bc9-8819-91947b0bc51c", "name": "The Sigfox device'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}}/sigfox_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "disable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a91c98b4-7b6a-4bc9-8819-91947b0bc51c" }, { "id": "844de88e-27d7-4ff7-9dab-b4422851e533", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/disable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "disable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-844de88e-27d7-4ff7-9dab-b4422851e533" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d2b5b564-8a79-4cb8-87b8-6a10deb7c40a" } ], "id": "91e9d447-f682-4f92-98dc-3b9a0ff19d7c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-91e9d447-f682-4f92-98dc-3b9a0ff19d7c" }, { "name": "enable_termination", "item": [ { "name": "Enable Termination of Sigfox device.", "id": "43a9dd73-b05e-4583-a133-d3b56f74aa72", "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}}/sigfox_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "enable_termination" ], "variable": [ { "id": "ec2ca60f-96ce-4c73-bd18-1e921c216909", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." } ] }, "description": "Enables termination of specified Sigfox device." }, "response": [ { "id": "bd43a65b-85ab-46b7-8f08-f86602103c33", "name": "The Sigfox device'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}}/sigfox_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "enable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bd43a65b-85ab-46b7-8f08-f86602103c33" }, { "id": "3811a513-8e6b-43bb-9b65-7ea732e7624c", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/enable_termination", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "enable_termination" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3811a513-8e6b-43bb-9b65-7ea732e7624c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-43a9dd73-b05e-4583-a133-d3b56f74aa72" } ], "id": "3c897025-7a6b-4d44-a343-a55ba10b2d79", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3c897025-7a6b-4d44-a343-a55ba10b2d79" }, { "name": "register", "item": [ { "name": "Registers a Sigfox device.", "id": "c240e567-ce22-4f3f-980d-d1a4c3c6f6c6", "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 \"tags\": {\n \"deserunte80\": \"\",\n \"laborisc0a\": \"\",\n \"consequat17\": \"\",\n \"dolora98\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "register" ], "variable": [ { "id": "c263032e-d360-4f89-9778-9d1aef2899e2", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device to register." } ] }, "description": "Registers a Sigfox device." }, "response": [ { "id": "6ab832f5-6511-4cb5-8907-7ae2aaa4d1dc", "name": "Sigfox device successfully registered.", "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 \"tags\": {\n \"deserunte80\": \"\",\n \"laborisc0a\": \"\",\n \"consequat17\": \"\",\n \"dolora98\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "register" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6ab832f5-6511-4cb5-8907-7ae2aaa4d1dc" }, { "id": "ff57ca0f-6c8d-4a89-8bee-04bc84322b4a", "name": "PAC code is 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": "{\n \"registrationSecret\": \"\",\n \"tags\": {\n \"deserunte80\": \"\",\n \"laborisc0a\": \"\",\n \"consequat17\": \"\",\n \"dolora98\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "register" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ff57ca0f-6c8d-4a89-8bee-04bc84322b4a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c240e567-ce22-4f3f-980d-d1a4c3c6f6c6" } ], "id": "bf17e89c-3395-4c36-a968-94adfb03f573", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bf17e89c-3395-4c36-a968-94adfb03f573" }, { "name": "set_group", "item": [ { "name": "Adds a Sigfox device to a Sigfox group", "id": "966c8c3f-7a62-4b8a-8b1f-bb9db25139ed", "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}}/sigfox_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "set_group" ], "variable": [ { "id": "cfc81340-6c90-4a91-adb2-b3b2a2833417", "key": "device_id", "value": "", "description": "(Required) ID of the target Sigfox device. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." } ] }, "description": "Adds a Sigfox device to a Sigfox group." }, "response": [ { "id": "94f023fc-b13c-4925-9c3e-1e0a57d6e42c", "name": "Detailed information of the updated Sigfox 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 \"groupId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sigfox_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-94f023fc-b13c-4925-9c3e-1e0a57d6e42c" }, { "id": "2c743e44-237d-4ad7-91fe-64f682d10c13", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/set_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "set_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2c743e44-237d-4ad7-91fe-64f682d10c13" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-966c8c3f-7a62-4b8a-8b1f-bb9db25139ed" } ], "id": "e37169ef-8b36-4571-b062-a3ad70524fc7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e37169ef-8b36-4571-b062-a3ad70524fc7" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete Sigfox device Tag.", "id": "a2b30425-736d-41b2-9f24-826f0e85c73f", "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}}/sigfox_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "id": "c192e5b1-7e2f-4ea5-b984-ee477b56c984", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." }, { "id": "ae46bc30-c726-4efb-8549-1b1c58d8ccad", "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 Sigfox device." }, "response": [ { "id": "a08afe9a-e629-42f7-9b87-7eba09919953", "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}}/sigfox_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a08afe9a-e629-42f7-9b87-7eba09919953" }, { "id": "222d77fd-3701-4e47-90e7-a0c5249ba2f5", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags", ":tag_name" ], "variable": [ { "key": "device_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-222d77fd-3701-4e47-90e7-a0c5249ba2f5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2b30425-736d-41b2-9f24-826f0e85c73f" } ], "id": "e69db2e9-a9f1-43f8-8fcf-e7ba0c2443a9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e69db2e9-a9f1-43f8-8fcf-e7ba0c2443a9" }, { "name": "Bulk Insert or Update Sigfox device Tags.", "id": "3a6e8cd8-d5b7-4e8a-b38b-811d6201235a", "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}}/sigfox_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags" ], "variable": [ { "id": "b7ad83dc-e12c-41d9-8cef-ba9320e90e4f", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." } ] }, "description": "Inserts/updates tags for the specified Sigfox device." }, "response": [ { "id": "10825915-bbd4-4509-854a-ea37f7d52881", "name": "The Sigfox device'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}}/sigfox_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-10825915-bbd4-4509-854a-ea37f7d52881" }, { "id": "38232346-17ac-42f1-95bb-d04866277730", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "tags" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-38232346-17ac-42f1-95bb-d04866277730" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3a6e8cd8-d5b7-4e8a-b38b-811d6201235a" } ], "id": "c6c8e6c8-90df-4fdd-9524-8efbf7aae80e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c6c8e6c8-90df-4fdd-9524-8efbf7aae80e" }, { "name": "terminate", "item": [ { "name": "Terminate Sigfox device.", "id": "b52ba8f6-1d90-4d0e-9fb6-84d82af30c6e", "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}}/sigfox_devices/:device_id/terminate?delete_immediately=false", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "terminate" ], "query": [ { "description": "If the Sigfox device is deleted immediately.", "key": "delete_immediately", "value": "false" } ], "variable": [ { "id": "7d68c90b-a2e7-48c3-a813-fcb2a8ffa015", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." } ] }, "description": "Terminates the specified Sigfox device." }, "response": [ { "id": "4a52ad0c-337b-4a06-b249-9aa0649924b7", "name": "The Sigfox device'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}}/sigfox_devices/:device_id/terminate?delete_immediately=false", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "terminate" ], "query": [ { "description": "If the Sigfox device is deleted immediately.", "key": "delete_immediately", "value": "false" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4a52ad0c-337b-4a06-b249-9aa0649924b7" }, { "id": "177f4970-eaa1-4151-9a1f-b19cef67f750", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/terminate?delete_immediately=false", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "terminate" ], "query": [ { "description": "If the Sigfox device is deleted immediately.", "key": "delete_immediately", "value": "false" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-177f4970-eaa1-4151-9a1f-b19cef67f750" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b52ba8f6-1d90-4d0e-9fb6-84d82af30c6e" } ], "id": "87045a91-60bd-4c9d-a3a9-cf959ec5b9df", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-87045a91-60bd-4c9d-a3a9-cf959ec5b9df" }, { "name": "unset_group", "item": [ { "name": "Removes a Sigfox device from a Sigfox group", "id": "53772d86-5d1a-4b18-a2ec-9ab5b97a6ae8", "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}}/sigfox_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "unset_group" ], "variable": [ { "id": "fd8a89b9-2461-4000-b9d5-1f63c81722e3", "key": "device_id", "value": "", "description": "(Required) ID of the target Sigfox device. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." } ] }, "description": "Removes a Sigfox device from a Sigfox group." }, "response": [ { "id": "f8cb13cf-52d2-4e93-a3b9-184ba8dbeeb3", "name": "Detailed information of the updated Sigfox device.", "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}}/sigfox_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f8cb13cf-52d2-4e93-a3b9-184ba8dbeeb3" }, { "id": "53eeee9a-c07d-4d62-81fa-445cbd3b983f", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id/unset_group", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id", "unset_group" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-53eeee9a-c07d-4d62-81fa-445cbd3b983f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-53772d86-5d1a-4b18-a2ec-9ab5b97a6ae8" } ], "id": "6a61241f-dd53-4cf0-b5c6-cbfb4e06cef2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6a61241f-dd53-4cf0-b5c6-cbfb4e06cef2" }, { "name": "Get Sigfox device.", "id": "0ed4a061-5e64-4c1a-bf90-193a5733e1db", "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}}/sigfox_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id" ], "variable": [ { "id": "e1ea9d3f-c9a3-4171-b55d-5da2e45c5151", "key": "device_id", "value": "", "description": "(Required) Device ID of the target Sigfox device." } ] }, "description": "Returns information about the specified Sigfox device." }, "response": [ { "id": "40b4a881-7448-45b0-a33a-881b400b8543", "name": "The Sigfox device'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}}/sigfox_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"aliquab\": \"\",\n \"ex_f\": \"\"\n },\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-40b4a881-7448-45b0-a33a-881b400b8543" }, { "id": "5c278f5a-996f-4d4c-9d92-75a98d929c7c", "name": "The specified Sigfox device 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}}/sigfox_devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5c278f5a-996f-4d4c-9d92-75a98d929c7c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0ed4a061-5e64-4c1a-bf90-193a5733e1db" } ], "id": "1982a51a-6e0e-48b9-9c5e-de2c1a3ddbc8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1982a51a-6e0e-48b9-9c5e-de2c1a3ddbc8" }, { "name": "List Sigfox devices.", "id": "c38fc946-c585-4e06-abf6-81e34dffc751", "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}}/sigfox_devices?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices" ], "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": "Maximum number of Sigfox devices to retrieve.", "key": "limit", "value": "" }, { "description": "The device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of Sigfox devices that match certain criteria. If the total number of Sigfox devices 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": "8c6bb997-d0cd-4473-bf20-4ccdde7b97bf", "name": "A list of Sigfox devices.", "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}}/sigfox_devices?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "sigfox_devices" ], "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": "Maximum number of Sigfox devices to retrieve.", "key": "limit", "value": "" }, { "description": "The device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device 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 \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"sit_b8b\": \"\"\n },\n \"terminationEnabled\": false\n },\n {\n \"device_id\": \"\",\n \"groupId\": \"\",\n \"lastModifiedTime\": \"\",\n \"lastSeen\": {\n \"rssi\": \"\",\n \"snr\": \"\",\n \"time\": \"\"\n },\n \"operatorId\": \"\",\n \"status\": \"instock\",\n \"tags\": {\n \"idc\": \"\"\n },\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8c6bb997-d0cd-4473-bf20-4ccdde7b97bf" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c38fc946-c585-4e06-abf6-81e34dffc751" } ], "id": "3f5ee39c-2a47-4b5f-87b6-1e3963210418", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3f5ee39c-2a47-4b5f-87b6-1e3963210418" }, { "name": "sim_profile_orders", "item": [ { "name": "{profile_order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm an eSIM profile order", "id": "1d2fcdf5-48d7-4d96-b0a8-df9fdfc88c03", "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": "57d4b512-405b-452c-b314-c66e86d6a6a4", "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": "d0c6088b-367f-43ce-a649-3286d3c86cf1", "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\": \"COMPLETED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d0c6088b-367f-43ce-a649-3286d3c86cf1" }, { "id": "82364e6a-c496-4c76-9311-da073373c278", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-82364e6a-c496-4c76-9311-da073373c278" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1d2fcdf5-48d7-4d96-b0a8-df9fdfc88c03" } ], "id": "eb062a87-ba17-4fac-8fb2-2915785239bb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eb062a87-ba17-4fac-8fb2-2915785239bb" }, { "name": "profiles", "item": [ { "name": "List eSIM profiles created by the eSIM profile order", "id": "9484fcaf-0dec-430f-aefb-7dab047aa10c", "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": "e77dfaef-bd86-48f2-8e18-aeecf8b42da5", "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": "b8fe0b76-fd9e-480d-a0f2-67f41ca98304", "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\": \"INSTALLATION_SUCCEEDED\",\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"installedTime\": \"\",\n \"subscription\": \"\"\n },\n {\n \"profileOrderId\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"matchingId\": \"\",\n \"smdpAddress\": \"\",\n \"activationCode\": \"\",\n \"profileStatus\": \"INACTIVATION_FAILED\",\n \"createdTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"installedTime\": \"\",\n \"subscription\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b8fe0b76-fd9e-480d-a0f2-67f41ca98304" }, { "id": "2a67bcac-4934-4507-adf9-42492b3d537f", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a67bcac-4934-4507-adf9-42492b3d537f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9484fcaf-0dec-430f-aefb-7dab047aa10c" } ], "id": "fae5eab5-20d1-4d7b-b8ed-43aa02154bfd", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fae5eab5-20d1-4d7b-b8ed-43aa02154bfd" }, { "name": "Cancel an eSIM profile order", "id": "8279a84a-1d77-40ce-aa15-3abf7d4daa92", "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": "d8f48fc4-bb80-4ea2-9ab2-62bb11a5caf1", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Cancels an unconfirmed eSIM profile order.\n" }, "response": [ { "id": "da363cc2-9d5d-40d3-9443-6c8ad59f63b6", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-da363cc2-9d5d-40d3-9443-6c8ad59f63b6" }, { "id": "a7deaaef-ee54-4487-bb64-c2cfc8c033f8", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a7deaaef-ee54-4487-bb64-c2cfc8c033f8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8279a84a-1d77-40ce-aa15-3abf7d4daa92" }, { "name": "Get an eSIM profile order", "id": "9f642fda-ebe4-432c-9bfb-dc4246094109", "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": "cedaa91a-2593-4f2b-9961-ccf952739f67", "key": "profile_order_id", "value": "", "description": "(Required) The ID of the eSIM profile order." } ] }, "description": "Get an eSIM profile order.\n" }, "response": [ { "id": "15864d25-79f5-4521-8eae-0da66be634e8", "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\": \"COMPLETED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-15864d25-79f5-4521-8eae-0da66be634e8" }, { "id": "3237a79d-aa68-46ca-ad8d-565a12d5a8c2", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3237a79d-aa68-46ca-ad8d-565a12d5a8c2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9f642fda-ebe4-432c-9bfb-dc4246094109" } ], "id": "790f5127-47d6-4c18-8a4d-dc5a2e1f8d16", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-790f5127-47d6-4c18-8a4d-dc5a2e1f8d16" }, { "name": "List eSIM profile orders", "id": "819bfda5-0f58-49e0-82b4-a2dd49173755", "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": "d4063bd9-256f-4793-80b8-54bb85860499", "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\": \"IN_PROGRESS\",\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\": \"DRAFT\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d4063bd9-256f-4793-80b8-54bb85860499" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-819bfda5-0f58-49e0-82b4-a2dd49173755" }, { "name": "Create a new eSIM profile order", "id": "94ded5a6-119a-4ce4-844e-03daa773d720", "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 \"US-3GB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.fast\"\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": "6115fb4b-d6c8-46fe-b357-f5c8fb22d024", "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 \"US-3GB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.fast\"\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\": \"COMPLETED\",\n \"orderedTime\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"completedTime\": \"\",\n \"confirmedTime\": \"\",\n \"description\": \"\",\n \"speedClass\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6115fb4b-d6c8-46fe-b357-f5c8fb22d024" }, { "id": "dd68713b-deec-4069-b694-9a46d0f07a23", "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 \"US-3GB\"\n ],\n \"description\": \"\",\n \"speedClass\": \"s1.fast\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dd68713b-deec-4069-b694-9a46d0f07a23" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-94ded5a6-119a-4ce4-844e-03daa773d720" } ], "id": "ae9ef0bf-f2b7-4cb7-81fd-9e9255dbe2e9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ae9ef0bf-f2b7-4cb7-81fd-9e9255dbe2e9" }, { "name": "sims", "item": [ { "name": "{sim_id}", "item": [ { "name": "activate", "item": [ { "name": "Activate SIM", "id": "40c3d83a-039c-4e91-bfce-787b9a2ebc92", "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": "87d533bb-bf5f-43e3-bcf7-b2f6cb4eb5df", "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": "f6e9f187-d03b-4b18-bfca-7acae285b9cb", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f6e9f187-d03b-4b18-bfca-7acae285b9cb" }, { "id": "c8d61c20-9c6b-4d62-8e86-50fb8d55e08f", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c8d61c20-9c6b-4d62-8e86-50fb8d55e08f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-40c3d83a-039c-4e91-bfce-787b9a2ebc92" } ], "id": "40986550-0c4a-45f7-bc12-6706b7036ea7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-40986550-0c4a-45f7-bc12-6706b7036ea7" }, { "name": "credentials", "item": [ { "name": "arc", "item": [ { "name": "(DEPRECATED) Removes the credentials for Arc from a SIM", "id": "9366163a-834c-4a63-895a-add94123d4e2", "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": "3636047f-333b-4dd5-8005-cf6a8b10272c", "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": "91565b29-865e-445c-a416-63dfca6d678f", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-91565b29-865e-445c-a416-63dfca6d678f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9366163a-834c-4a63-895a-add94123d4e2" }, { "name": "(DEPRECATED) Attaches the credentials for Arc to a SIM", "id": "05be7b67-67d4-4294-87d7-5004fff2eeab", "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": "a05843b8-6868-4d57-84e6-a416a5e3a26d", "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": "8a896c85-e2dd-4717-9ee8-e5b3083d140a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8a896c85-e2dd-4717-9ee8-e5b3083d140a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-05be7b67-67d4-4294-87d7-5004fff2eeab" }, { "name": "Renew the credentials for Arc to a SIM", "id": "f938fb2e-06e7-4dd5-b0f1-2a6bcc669167", "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": "3e143c81-b2a1-4081-829b-73491a01a6ca", "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": "f14fcdd1-8056-4f93-a960-2dfc45806f1c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f14fcdd1-8056-4f93-a960-2dfc45806f1c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f938fb2e-06e7-4dd5-b0f1-2a6bcc669167" } ], "id": "9c0e0f60-ad2c-4b33-8477-98995395cbd3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9c0e0f60-ad2c-4b33-8477-98995395cbd3" } ], "id": "d2e6e510-c28a-4e64-87fa-cf868e725b3f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d2e6e510-c28a-4e64-87fa-cf868e725b3f" }, { "name": "data", "item": [ { "name": "Get data sent from a SIM to Harvest Data.", "id": "5b6a10e9-8dec-47ff-b341-e4c903ab0c03", "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": "893be040-db39-4ed2-9670-924f13b52891", "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": "f756a5fb-d5a0-4d93-b875-a1b7e950b87f", "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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f756a5fb-d5a0-4d93-b875-a1b7e950b87f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5b6a10e9-8dec-47ff-b341-e4c903ab0c03" } ], "id": "956af579-8623-4530-be4a-aa1fc6d9d071", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-956af579-8623-4530-be4a-aa1fc6d9d071" }, { "name": "deactivate", "item": [ { "name": "Deactivate SIM", "id": "1873569e-54c8-4416-ba0d-ced221f6e75d", "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": "ab218d1d-5154-49f3-99bb-55b14e643396", "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": "70ae13f2-8722-4d25-883b-484eed196c4f", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-70ae13f2-8722-4d25-883b-484eed196c4f" }, { "id": "eff846f4-aff9-494b-8e6e-462a9a7edd41", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-eff846f4-aff9-494b-8e6e-462a9a7edd41" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1873569e-54c8-4416-ba0d-ced221f6e75d" } ], "id": "a3ea9a28-52f2-4eac-948f-7fae3cce67e6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a3ea9a28-52f2-4eac-948f-7fae3cce67e6" }, { "name": "delete_session", "item": [ { "name": "Delete and reconnect the Session", "id": "a2823bb5-6490-4e76-9314-a9b0383d9583", "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": "41fe18d4-0ace-4a50-a95a-fa28054ea089", "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": "276f5ac3-8a09-4224-80b8-beb9518772a0", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-276f5ac3-8a09-4224-80b8-beb9518772a0" }, { "id": "60aad470-b227-4ff7-a8e8-34f9fca9291a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-60aad470-b227-4ff7-a8e8-34f9fca9291a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2823bb5-6490-4e76-9314-a9b0383d9583" } ], "id": "7258ba7f-bf49-471d-81dc-e793b12f4bad", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7258ba7f-bf49-471d-81dc-e793b12f4bad" }, { "name": "disable_termination", "item": [ { "name": "Disables termination of the SIM", "id": "0da97f64-4939-4c69-9b5c-5ec9cce34112", "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": "9f542329-d3f7-4992-a46e-719075146988", "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": "7cdc6b61-40bb-4cd2-8d91-38292113ed51", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7cdc6b61-40bb-4cd2-8d91-38292113ed51" }, { "id": "c36f0353-568a-4b57-89a1-6bf8adb0ddd4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c36f0353-568a-4b57-89a1-6bf8adb0ddd4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0da97f64-4939-4c69-9b5c-5ec9cce34112" } ], "id": "974daa17-8473-4296-8ba2-7156722f414f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-974daa17-8473-4296-8ba2-7156722f414f" }, { "name": "downlink", "item": [ { "name": "http", "item": [ { "name": "Send an HTTP request to a device using an IoT SIM", "id": "cfd879e1-1139-48bf-a96c-d501e7a7ddbf", "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 \"cupidatat_25\": \"\",\n \"aliquip322\": \"\",\n \"id169\": \"\",\n \"fugiat_ad\": \"\",\n \"aliquip_2b_\": \"\"\n },\n \"host\": \"\",\n \"method\": \"PATCH\",\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": "6d3c6d4b-2e12-4777-ae8a-2b8c9f115c2b", "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": "bc5bee11-7b98-4140-8c38-41e779a1b403", "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 \"cupidatat_25\": \"\",\n \"aliquip322\": \"\",\n \"id169\": \"\",\n \"fugiat_ad\": \"\",\n \"aliquip_2b_\": \"\"\n },\n \"host\": \"\",\n \"method\": \"PATCH\",\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 \"voluptate_5\": \"\",\n \"ad9\": \"\"\n },\n \"isBase64Encoded\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bc5bee11-7b98-4140-8c38-41e779a1b403" }, { "id": "7b4b19d8-ac3c-4bcf-a555-356a3448dd12", "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 \"cupidatat_25\": \"\",\n \"aliquip322\": \"\",\n \"id169\": \"\",\n \"fugiat_ad\": \"\",\n \"aliquip_2b_\": \"\"\n },\n \"host\": \"\",\n \"method\": \"PATCH\",\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b4b19d8-ac3c-4bcf-a555-356a3448dd12" }, { "id": "e3f97c8a-6f26-4c40-9811-7859d9bc594e", "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 \"cupidatat_25\": \"\",\n \"aliquip322\": \"\",\n \"id169\": \"\",\n \"fugiat_ad\": \"\",\n \"aliquip_2b_\": \"\"\n },\n \"host\": \"\",\n \"method\": \"PATCH\",\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e3f97c8a-6f26-4c40-9811-7859d9bc594e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cfd879e1-1139-48bf-a96c-d501e7a7ddbf" } ], "id": "147547b0-efd0-417d-9c15-3762fc471cef", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-147547b0-efd0-417d-9c15-3762fc471cef" }, { "name": "ping", "item": [ { "name": "Sends ping requests to a SIM.", "id": "c4a707a1-d024-4d57-a454-eb3ebb8eec65", "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": "62bf7582-aba8-469e-b53d-dde35769b54f", "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": "df4f5916-9b9e-4111-88a0-eda66c8e9e75", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-df4f5916-9b9e-4111-88a0-eda66c8e9e75" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c4a707a1-d024-4d57-a454-eb3ebb8eec65" } ], "id": "a345e87a-6388-4709-8467-16621047e573", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a345e87a-6388-4709-8467-16621047e573" }, { "name": "rtsp", "item": [ { "name": "Send a command to a RTSP stream to a device using an IoT SIM", "id": "0b2ac3ef-f32a-49e5-8b41-eb8f3a71c599", "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": "970dac05-4996-42ee-b56c-87c78dc743c1", "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": "17c6996c-c48d-42f1-a189-3a250d8ede63", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-17c6996c-c48d-42f1-a189-3a250d8ede63" }, { "id": "b8c36a30-8c99-44f5-a80b-761f397417a4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b8c36a30-8c99-44f5-a80b-761f397417a4" }, { "id": "82c68055-6bff-4256-be07-fff09661cf8e", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-82c68055-6bff-4256-be07-fff09661cf8e" }, { "id": "6f1b7e0e-a2ae-4dc0-b612-c3956a608e4d", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6f1b7e0e-a2ae-4dc0-b612-c3956a608e4d" }, { "id": "8a5a25ed-11be-4c23-bf93-68052332fc9f", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8a5a25ed-11be-4c23-bf93-68052332fc9f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0b2ac3ef-f32a-49e5-8b41-eb8f3a71c599" } ], "id": "7017b9f0-41c0-4f10-b176-b99b26bbc17a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7017b9f0-41c0-4f10-b176-b99b26bbc17a" }, { "name": "ssh", "item": [ { "name": "Connect to a device using an IoT SIM via SSH and execute a specified command", "id": "3b5dab2a-7bd4-467a-872b-9c6582688324", "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": "42b32ba5-d410-48ea-9fcb-353f1d0dc665", "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": "762fee9f-4617-4c72-9810-76f0b9313c2c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-762fee9f-4617-4c72-9810-76f0b9313c2c" }, { "id": "1e9020dc-a4c2-48ff-9b47-a54b81d49f40", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1e9020dc-a4c2-48ff-9b47-a54b81d49f40" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3b5dab2a-7bd4-467a-872b-9c6582688324" } ], "id": "4c5cb757-6eea-4f65-974d-55c103ac3a0b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4c5cb757-6eea-4f65-974d-55c103ac3a0b" }, { "name": "tcp", "item": [ { "name": "Connect to a device using an IoT SIM via TCP and send/receive data", "id": "63dbb73b-eca8-4f4d-aae5-1522d1edc86a", "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": "de868326-da31-4ae8-b9e3-0c33b4d02f7b", "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": "a9886a5a-12e5-46e7-bbf4-44541fdb6506", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a9886a5a-12e5-46e7-bbf4-44541fdb6506" }, { "id": "7b8343ea-d034-4977-8451-eba9096f2beb", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b8343ea-d034-4977-8451-eba9096f2beb" }, { "id": "5bf7ea1c-ebbd-4522-a06b-b10b7f6159ad", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5bf7ea1c-ebbd-4522-a06b-b10b7f6159ad" }, { "id": "5653300f-4b93-464a-a32a-dbe3fa603c52", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5653300f-4b93-464a-a32a-dbe3fa603c52" }, { "id": "9a065ac0-378e-48c1-b83d-95a66e9b6d6a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9a065ac0-378e-48c1-b83d-95a66e9b6d6a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-63dbb73b-eca8-4f4d-aae5-1522d1edc86a" } ], "id": "7667f55e-4960-4ca3-b9f1-951c600f2650", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7667f55e-4960-4ca3-b9f1-951c600f2650" }, { "name": "udp", "item": [ { "name": "Send data using IoT SIM via UDP", "id": "4be640ec-6c97-4d5f-9303-816407def8cb", "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": "ea649d77-7c0d-402e-9aeb-4e25b8296bd5", "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": "cbd4a9c1-a28e-43fd-b7ca-227146e3a5b2", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cbd4a9c1-a28e-43fd-b7ca-227146e3a5b2" }, { "id": "d7eed7f8-0087-431d-b336-69655a89c95a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d7eed7f8-0087-431d-b336-69655a89c95a" }, { "id": "6e3dfc2a-25a1-4889-ba66-8c39281fd348", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6e3dfc2a-25a1-4889-ba66-8c39281fd348" }, { "id": "bc0a1d8b-defa-414b-b3a7-85868406f6ff", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bc0a1d8b-defa-414b-b3a7-85868406f6ff" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4be640ec-6c97-4d5f-9303-816407def8cb" } ], "id": "d61512b4-3d19-49c2-8ddc-34ae943ae0c7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d61512b4-3d19-49c2-8ddc-34ae943ae0c7" } ], "id": "c8d1aeae-6d20-4d84-aaef-49d25381acd1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c8d1aeae-6d20-4d84-aaef-49d25381acd1" }, { "name": "enable_termination", "item": [ { "name": "Enables termination of the SIM.", "id": "87179a3e-ab93-4e80-bb82-d83bb96dc5cb", "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": "1f7e603b-adcb-4135-8dde-3bcc56268dca", "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": "1d83f124-e88e-4f40-8834-7b841347d357", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1d83f124-e88e-4f40-8834-7b841347d357" }, { "id": "532b0cbe-86db-4d8d-8eb8-c9e604485f53", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-532b0cbe-86db-4d8d-8eb8-c9e604485f53" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-87179a3e-ab93-4e80-bb82-d83bb96dc5cb" } ], "id": "050d6a61-44e7-4690-9c3c-a4c2f532c0e7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-050d6a61-44e7-4690-9c3c-a4c2f532c0e7" }, { "name": "events", "item": [ { "name": "sessions", "item": [ { "name": "Retrieves session event history (session history)", "id": "795df17b-d618-4f13-8b2a-724f263ba43b", "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": "150098f9-c2f0-4e0d-9632-b3d04b11b54a", "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": "2b4795f9-26c8-42b8-b022-bf0fe07895c0", "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\": \"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 {\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2b4795f9-26c8-42b8-b022-bf0fe07895c0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-795df17b-d618-4f13-8b2a-724f263ba43b" } ], "id": "86105871-d829-4a68-a463-f363947d54f1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-86105871-d829-4a68-a463-f363947d54f1" } ], "id": "e8a016df-0920-46ed-beb9-5921afef3a94", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e8a016df-0920-46ed-beb9-5921afef3a94" }, { "name": "packet_capture_sessions", "item": [ { "name": "{session_id}", "item": [ { "name": "stop", "item": [ { "name": "Stops a packet capture session associated with the SIM", "id": "6e15842a-512e-44b5-9543-d08ed741aefb", "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": "e628a39d-960d-415f-9f73-306585099948", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "10e7b836-8936-4199-bd47-13d14e3a571b", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Stops a packet capture session associated with the SIM." }, "response": [ { "id": "bba7bdd3-3e42-48a2-90e5-46d3f4db1b35", "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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bba7bdd3-3e42-48a2-90e5-46d3f4db1b35" }, { "id": "505b7dbe-db11-484b-840a-202a83980fd1", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-505b7dbe-db11-484b-840a-202a83980fd1" }, { "id": "e5b6b49c-8fbb-4a9a-bacd-f95103e12e13", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e5b6b49c-8fbb-4a9a-bacd-f95103e12e13" }, { "id": "79a628e1-47c5-4d25-9df0-3f4eb1eb7835", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-79a628e1-47c5-4d25-9df0-3f4eb1eb7835" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6e15842a-512e-44b5-9543-d08ed741aefb" } ], "id": "4c456ec3-a17b-4a3b-806b-828677bf3c55", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4c456ec3-a17b-4a3b-806b-828677bf3c55" }, { "name": "Deletes a packet capture session associated with the SIM", "id": "0769b573-2b86-4ab0-b561-8a718994684e", "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": "5a729ae7-6b6a-4949-a703-16418ba5baa6", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "b74d8e27-2de3-4c7e-8ba0-e94f0263d0b2", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Deletes a packet capture session associated with the SIM." }, "response": [ { "id": "38f83fa7-7d1c-4bce-b3cd-d7e9699e4bf6", "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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-38f83fa7-7d1c-4bce-b3cd-d7e9699e4bf6" }, { "id": "ae6ada07-749f-4508-9bf0-2e9c1aab8b8e", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ae6ada07-749f-4508-9bf0-2e9c1aab8b8e" }, { "id": "43b7c03c-7de1-4c40-b4ed-05c2494b57d5", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-43b7c03c-7de1-4c40-b4ed-05c2494b57d5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0769b573-2b86-4ab0-b561-8a718994684e" }, { "name": "Gets a packet capture session associated with the SIM", "id": "e79d51cd-3848-4073-9e20-966136ad5baa", "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": "5ca274da-5d58-4949-8585-8de1fcb51567", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "e9b275aa-0cf9-4944-861e-baa41a5d487b", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Gets a packet capture session associated with the SIM." }, "response": [ { "id": "6c6b20fc-7b52-4699-8ed2-0a78194235b7", "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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6c6b20fc-7b52-4699-8ed2-0a78194235b7" }, { "id": "da669736-1e4b-48e3-ba3f-e4586c2a6117", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-da669736-1e4b-48e3-ba3f-e4586c2a6117" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e79d51cd-3848-4073-9e20-966136ad5baa" } ], "id": "4d07e075-8f3e-4152-9610-de0585832bc5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4d07e075-8f3e-4152-9610-de0585832bc5" }, { "name": "Lists packet capture sessions associated with the SIM", "id": "6c344729-0fef-444a-83dd-cd4808bd1460", "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": "00a9ffb7-c5bf-42b4-be40-5cbb2dff4665", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Lists packet capture sessions associated with the SIM." }, "response": [ { "id": "0e3a2c3d-397a-4791-823f-b6c2291128fe", "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\": \"DONE\",\n \"url\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"FAILED\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0e3a2c3d-397a-4791-823f-b6c2291128fe" }, { "id": "754e3289-bd79-4480-bb4a-9c712bb962c4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-754e3289-bd79-4480-bb4a-9c712bb962c4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6c344729-0fef-444a-83dd-cd4808bd1460" }, { "name": "Creates a packet capture session associated with the SIM", "id": "67aaacb5-cdff-44d6-b79b-ffdfb3e322a4", "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\": \"p68NP\"\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": "0c1e874c-1341-47ae-a470-6403bb9b9185", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Creates a packet capture session associated with the SIM." }, "response": [ { "id": "263d3ee0-89da-46cb-b161-3fca7908097c", "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\": \"p68NP\"\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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-263d3ee0-89da-46cb-b161-3fca7908097c" }, { "id": "44a378fe-d934-4f4b-ada0-9cce947afd5a", "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\": \"p68NP\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-44a378fe-d934-4f4b-ada0-9cce947afd5a" }, { "id": "be02f601-8e3a-475b-be8c-7c2fd7fa57c0", "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\": \"p68NP\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-be02f601-8e3a-475b-be8c-7c2fd7fa57c0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-67aaacb5-cdff-44d6-b79b-ffdfb3e322a4" } ], "id": "75f35a12-3c9e-4937-a121-500b7d75c5d7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-75f35a12-3c9e-4937-a121-500b7d75c5d7" }, { "name": "profiles", "item": [ { "name": "{iccid}", "item": [ { "name": "add_subscription", "item": [ { "name": "Adds a new secondary subscription to an IoT SIM", "id": "80cbb564-b155-402f-839c-4a82625b2ac3", "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\": \"planArc01\",\n \"enable\": \"\",\n \"type\": \"cellular\"\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": "84aca745-efe1-42a7-b2ce-89c9005898e2", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." }, { "id": "0332ef2e-d0db-4439-9097-5ce19f66a787", "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": "8e2475a1-0344-40a9-af83-098c471cc9b7", "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\": \"planArc01\",\n \"enable\": \"\",\n \"type\": \"cellular\"\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 \"sit_e0\": {\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8e2475a1-0344-40a9-af83-098c471cc9b7" }, { "id": "852c5e2d-4aac-45ee-bcaf-2f681d56bf2f", "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\": \"planArc01\",\n \"enable\": \"\",\n \"type\": \"cellular\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-852c5e2d-4aac-45ee-bcaf-2f681d56bf2f" }, { "id": "bda54843-a98f-4bfb-9be0-7a8cb3cf27e2", "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\": \"planArc01\",\n \"enable\": \"\",\n \"type\": \"cellular\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bda54843-a98f-4bfb-9be0-7a8cb3cf27e2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-80cbb564-b155-402f-839c-4a82625b2ac3" } ], "id": "7e8f1e13-33da-4a02-8607-7911d66d83ed", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7e8f1e13-33da-4a02-8607-7911d66d83ed" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "cancel_download", "item": [ { "name": "Cancel the OTA to the subscription container for an additional subscription", "id": "d053090a-e39c-4f69-be3c-fad0c63a553f", "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": "a06f7189-e06e-4e90-b59d-c130d916ae40", "key": "sim_id", "value": "", "description": "(Required) The SIM ID of the target SIM." }, { "id": "e359d4e5-9d9f-4252-a5bd-5e3f5c295c4c", "key": "iccid", "value": "", "description": "(Required) The ICCID of the target subscription container." }, { "id": "033d4a2a-4bab-4844-98c3-f93c9c58ce62", "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": "d6c0c7ee-c462-4320-9236-7dab2c43ac75", "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 \"nulla8\": {\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\": \"embedded\",\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\": \"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\": \"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 \"ex_ea3\": \"\",\n \"aliquaf4\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n }\n },\n {\n \"containerId\": \"\",\n \"downloaded\": \"\",\n \"subscriber\": {\n \"tempor3f\": {\n \"apn\": \"\",\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"createdAt\": \"\",\n \"createdTime\": \"\",\n \"expiredAt\": \"\",\n \"expiryAction\": \"(null value)\",\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\",\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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"inactive\",\n \"subscription\": \"\",\n \"tags\": {\n \"suntae4\": \"\",\n \"deserunt5b\": \"\",\n \"adipisicing__b_\": \"\",\n \"in_4\": \"\",\n \"dolor_d42\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\n \"utda6\": {\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\": \"(null value)\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\",\n \"tags\": {\n \"deserunt_a3b\": \"\",\n \"labore_6\": \"\",\n \"irure6\": \"\",\n \"veniam77\": \"\",\n \"Lorem__\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n }\n }\n ],\n \"countryMapping\": {\n \"deserunt2c\": {\n \"mappingRecord\": {\n \"containerId\": \"\",\n \"subscription\": \"\"\n },\n \"plmnCode\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d6c0c7ee-c462-4320-9236-7dab2c43ac75" }, { "id": "e08c0142-e560-47d0-93ce-9e5b4463d231", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e08c0142-e560-47d0-93ce-9e5b4463d231" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d053090a-e39c-4f69-be3c-fad0c63a553f" } ], "id": "476d1ca7-70a3-4bbb-9413-dc4d5f64e75f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-476d1ca7-70a3-4bbb-9413-dc4d5f64e75f" }, { "name": "terminate", "item": [ { "name": "Terminates subscription container", "id": "28391539-181a-4ef1-a3e3-09a37427bd38", "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": "fb5f376a-1831-465d-b0e2-0994b9eff01d", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target subscription container." }, { "id": "72ce5976-0287-4d32-8629-8c9c69edd346", "key": "iccid", "value": "", "description": "(Required) ICCID of the target subscription container." }, { "id": "7af812ec-7b88-45ad-bd5a-b9dad7354ed9", "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": "4166ba72-2446-4569-ab72-514e075a8ad3", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4166ba72-2446-4569-ab72-514e075a8ad3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-28391539-181a-4ef1-a3e3-09a37427bd38" } ], "id": "c6c12de8-0a26-4ddd-85ca-c63cb686402a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c6c12de8-0a26-4ddd-85ca-c63cb686402a" } ], "id": "2befbebc-6815-415a-86e7-114990382d97", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2befbebc-6815-415a-86e7-114990382d97" } ], "id": "8ce3fb22-adb4-40ce-898c-43f831d8a449", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8ce3fb22-adb4-40ce-898c-43f831d8a449" } ], "id": "7739939e-e41e-45a3-a091-8df5f7c866aa", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7739939e-e41e-45a3-a091-8df5f7c866aa" } ], "id": "dca2c99f-510d-4c55-9323-b99cbc99349c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dca2c99f-510d-4c55-9323-b99cbc99349c" }, { "name": "register", "item": [ { "name": "Registers an IoT SIM to an operator", "id": "fbbea686-436f-4b7b-956a-ef9da630a7db", "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 \"ipsum4\": \"\",\n \"dolore_9d\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sims/:sim_id/register", "host": [ "{{baseUrl}}" ], "path": [ "sims", ":sim_id", "register" ], "variable": [ { "id": "33c77719-7273-4f9b-9e64-eadb710acb3c", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Registers an IoT SIM to an operator." }, "response": [ { "id": "64d47200-b62e-4522-8fd9-0a65e4ae63cd", "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 \"ipsum4\": \"\",\n \"dolore_9d\": \"\"\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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-64d47200-b62e-4522-8fd9-0a65e4ae63cd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fbbea686-436f-4b7b-956a-ef9da630a7db" } ], "id": "6567c0e1-1955-4790-834d-449903ba6034", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6567c0e1-1955-4790-834d-449903ba6034" }, { "name": "report_local_info", "item": [ { "name": "Gets SIM local information report", "id": "64545360-44fb-4f4f-823b-ce11bfd7eb52", "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": "d932d7f4-e8e0-4376-8d28-568868134b92", "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": "d3609cf2-dca3-4eb4-8d93-274647665651", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d3609cf2-dca3-4eb4-8d93-274647665651" }, { "id": "5260572e-d572-4606-b372-30251750892c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5260572e-d572-4606-b372-30251750892c" }, { "id": "3f19f723-5f8a-46a2-afa0-b4fed512e4b7", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3f19f723-5f8a-46a2-afa0-b4fed512e4b7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-64545360-44fb-4f4f-823b-ce11bfd7eb52" } ], "id": "6fa9a957-168b-45f1-8466-539e27b27e2e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6fa9a957-168b-45f1-8466-539e27b27e2e" }, { "name": "send_sms", "item": [ { "name": "Send an SMS to an IoT SIM", "id": "6cec8bc2-ac64-434a-8347-ce7616f99c75", "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": "774def54-b546-4790-90a3-040cd068c61f", "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": "1ac2a695-7729-49eb-8444-ee7048c97d26", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1ac2a695-7729-49eb-8444-ee7048c97d26" }, { "id": "b253c315-888f-4494-b52c-6f069044f9e6", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b253c315-888f-4494-b52c-6f069044f9e6" }, { "id": "dc89feed-5cc0-4aa1-b4e3-1609d3ea9e13", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc89feed-5cc0-4aa1-b4e3-1609d3ea9e13" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6cec8bc2-ac64-434a-8347-ce7616f99c75" } ], "id": "045dc78b-1808-4e99-8b63-09c643747d83", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-045dc78b-1808-4e99-8b63-09c643747d83" }, { "name": "sessions", "item": [ { "name": "arc", "item": [ { "name": "Creates a Soracom Arc session", "id": "66ed4a0b-959d-4de1-90df-340ced7ff6a3", "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": "4b67299a-93cb-4dda-8c07-1f874c664fc3", "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": "23118dc3-d12b-40ac-9c78-3280cd2b5025", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-23118dc3-d12b-40ac-9c78-3280cd2b5025" }, { "id": "8db800e7-9436-4e89-aa98-1b7e5cf20a18", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8db800e7-9436-4e89-aa98-1b7e5cf20a18" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-66ed4a0b-959d-4de1-90df-340ced7ff6a3" } ], "id": "1f3e18ac-d0e1-47a8-bb29-151fe91e6242", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1f3e18ac-d0e1-47a8-bb29-151fe91e6242" } ], "id": "fa19b6e8-5529-4a92-b007-b5b01a0522ce", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fa19b6e8-5529-4a92-b007-b5b01a0522ce" }, { "name": "set_expiry_time", "item": [ { "name": "Sets expiry time of IoT SIM", "id": "41614f01-d0b7-4947-b597-6654a4f32ae6", "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\": \"deleteSession\"\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": "ba68fdca-84f5-4201-8fc2-b121b02e35aa", "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": "4dd17ebf-7bc9-4d0e-9a06-75de027cf3e5", "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\": \"deleteSession\"\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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4dd17ebf-7bc9-4d0e-9a06-75de027cf3e5" }, { "id": "113c28dd-9b36-4259-beef-00dc0090e5fb", "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\": \"deleteSession\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-113c28dd-9b36-4259-beef-00dc0090e5fb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-41614f01-d0b7-4947-b597-6654a4f32ae6" } ], "id": "4aa18fd5-40b5-4778-95b2-72e2b1e0609a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4aa18fd5-40b5-4778-95b2-72e2b1e0609a" }, { "name": "set_group", "item": [ { "name": "Adds a SIM to a SIM group", "id": "6212245b-b5b0-46a5-bf4a-8b878e14742c", "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": "25e39f46-e37a-4b54-9e8f-d0d240c18374", "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": "307679ac-dfd1-4abb-9dc0-68d1d20761d1", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-307679ac-dfd1-4abb-9dc0-68d1d20761d1" }, { "id": "2a6991c6-c37e-4b19-a0bc-459e9d34690d", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a6991c6-c37e-4b19-a0bc-459e9d34690d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6212245b-b5b0-46a5-bf4a-8b878e14742c" } ], "id": "f6bfd20b-42b1-4a01-8192-197df6144d77", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6bfd20b-42b1-4a01-8192-197df6144d77" }, { "name": "set_imei_lock", "item": [ { "name": "Sets IMEI lock configuration for the SIM", "id": "69385bf1-9ec7-49ff-841b-17241b29d58f", "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": "5f1c32b0-da73-46ad-929e-88b534e137c8", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Sets IMEI that the SIM should be locked to." }, "response": [ { "id": "3595e975-7831-4c1b-9f93-aad8e1146932", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3595e975-7831-4c1b-9f93-aad8e1146932" }, { "id": "78b5028a-7bad-49a6-ab7e-fd5d0fd89383", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-78b5028a-7bad-49a6-ab7e-fd5d0fd89383" }, { "id": "5dc0cc40-f2a7-4bf6-a131-b587abae5b6a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5dc0cc40-f2a7-4bf6-a131-b587abae5b6a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-69385bf1-9ec7-49ff-841b-17241b29d58f" } ], "id": "36cb6181-25d0-401b-a67a-265fb0d6cbad", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-36cb6181-25d0-401b-a67a-265fb0d6cbad" }, { "name": "set_to_standby", "item": [ { "name": "Set SIM to standby mode.", "id": "01bba3a7-5cc0-4ccc-b78a-0e018a98fb17", "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": "36f48a4c-c7e1-4990-9ffd-e312c37ae8a4", "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": "0d0d7267-13d7-4c2d-b502-07634a15c146", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0d0d7267-13d7-4c2d-b502-07634a15c146" }, { "id": "89631c57-4811-4ed9-a275-2c69241e5b66", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-89631c57-4811-4ed9-a275-2c69241e5b66" }, { "id": "e4fa9527-60f7-41a3-b59b-2a7d02a63786", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e4fa9527-60f7-41a3-b59b-2a7d02a63786" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-01bba3a7-5cc0-4ccc-b78a-0e018a98fb17" } ], "id": "d7514e17-d222-46a0-83d1-dabb82e48558", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d7514e17-d222-46a0-83d1-dabb82e48558" }, { "name": "statuses", "item": [ { "name": "history", "item": [ { "name": "List IoT SIM status operation history", "id": "8fd3b31e-b49b-46d8-812d-7ddea84c4310", "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": "8551bae7-3d18-4232-be57-826c11a8d2ee", "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": "dc812d0f-0ea3-4f5c-87ab-ce6fd5cac572", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc812d0f-0ea3-4f5c-87ab-ce6fd5cac572" }, { "id": "59bdd18e-27bd-491d-bcbc-70a42d3f3c46", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-59bdd18e-27bd-491d-bcbc-70a42d3f3c46" }, { "id": "d8fd3fa3-0406-4dc7-a818-a6796d96d5ec", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d8fd3fa3-0406-4dc7-a818-a6796d96d5ec" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8fd3b31e-b49b-46d8-812d-7ddea84c4310" } ], "id": "4bc580c0-115e-4c73-9372-dae7e636e393", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4bc580c0-115e-4c73-9372-dae7e636e393" } ], "id": "753eaaff-70b5-4c77-86c3-b24a065a2d25", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-753eaaff-70b5-4c77-86c3-b24a065a2d25" }, { "name": "suspend", "item": [ { "name": "Suspend SIM", "id": "529e2a54-4cb8-4170-ac6d-17a524dac76e", "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": "4cf9a072-2536-491f-b9af-f2b9613a3834", "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": "42a5eab3-6fd3-4d1b-8f52-e9ce0fe4ff6d", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-42a5eab3-6fd3-4d1b-8f52-e9ce0fe4ff6d" }, { "id": "f59e6c97-2c53-4f95-b441-16b38c2d17cc", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f59e6c97-2c53-4f95-b441-16b38c2d17cc" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-529e2a54-4cb8-4170-ac6d-17a524dac76e" } ], "id": "830f5d9c-84bd-48d3-860d-17e6438cf7d2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-830f5d9c-84bd-48d3-860d-17e6438cf7d2" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Deletes a tag from the specified SIM", "id": "9a48f50b-9ff0-4346-b499-1d0dffd7bed1", "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": "5479d429-3e3e-4b13-85e8-6b30de1bc5bf", "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": "e488c86d-e43a-4fd1-b8ca-a1044905d99b", "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": "c8576215-d467-4116-b445-0870e245c8fa", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c8576215-d467-4116-b445-0870e245c8fa" }, { "id": "53ca6169-175b-408b-b3d3-830b49a2be6c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-53ca6169-175b-408b-b3d3-830b49a2be6c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9a48f50b-9ff0-4346-b499-1d0dffd7bed1" } ], "id": "a9fd4a18-58a2-4759-b0cd-1e924f9c3198", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a9fd4a18-58a2-4759-b0cd-1e924f9c3198" }, { "name": "Bulk Add or Update tags for an IoT SIM", "id": "204ca540-8379-490e-bab8-99d7c16cd8f8", "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": "7caaa70f-3f7a-440b-8802-68913cd30fba", "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": "34298552-a035-48ba-afa9-e36578f47f04", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-34298552-a035-48ba-afa9-e36578f47f04" }, { "id": "6f11210f-d195-410d-82e3-de9eb9b26e58", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6f11210f-d195-410d-82e3-de9eb9b26e58" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-204ca540-8379-490e-bab8-99d7c16cd8f8" } ], "id": "0de67b7d-f815-450e-bf62-a31dad630617", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0de67b7d-f815-450e-bf62-a31dad630617" }, { "name": "terminate", "item": [ { "name": "Terminate an IoT SIM", "id": "0bd6f5bf-1272-4dfe-bbf2-95416e917af1", "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": "152d9af3-f733-4828-8ea7-81a667d54bcb", "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": "dfcc4c93-dec9-47d7-a3c3-b301c4b9cd25", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dfcc4c93-dec9-47d7-a3c3-b301c4b9cd25" }, { "id": "93044916-eaf4-4c18-9b7d-88f542679f67", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-93044916-eaf4-4c18-9b7d-88f542679f67" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0bd6f5bf-1272-4dfe-bbf2-95416e917af1" } ], "id": "e01eae6d-2563-48a6-8cd4-bd3bde592915", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e01eae6d-2563-48a6-8cd4-bd3bde592915" }, { "name": "testing", "item": [ { "name": "usage", "item": [ { "name": "Get usage of IoT SIM in testing status", "id": "c9d30054-6221-4d90-a446-08f38f3ec1d5", "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": "fdd7c68d-3fa8-46b4-8b89-83d3e30d1052", "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": "dff5f3d8-2b69-4e56-adfe-e0da8b3516ea", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dff5f3d8-2b69-4e56-adfe-e0da8b3516ea" }, { "id": "5aa06ddf-9aff-4a11-97cb-09b2001c994c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5aa06ddf-9aff-4a11-97cb-09b2001c994c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c9d30054-6221-4d90-a446-08f38f3ec1d5" } ], "id": "b612e5ed-8357-432b-9474-02ad1fa818f5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b612e5ed-8357-432b-9474-02ad1fa818f5" } ], "id": "f6cbff79-bb76-4b11-993f-f8533162e198", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f6cbff79-bb76-4b11-993f-f8533162e198" }, { "name": "unset_expiry_time", "item": [ { "name": "Deletes expiry time of the SIM", "id": "9198ba95-0388-4808-90d2-c34dad41d76e", "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": "1ee0bb11-8dc6-4b7a-ae6e-eaa9dd48098b", "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": "6651dc3c-4718-41c5-9bcf-af9a0773751b", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6651dc3c-4718-41c5-9bcf-af9a0773751b" }, { "id": "2b3054ca-e518-4287-8f75-13537d5a2765", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2b3054ca-e518-4287-8f75-13537d5a2765" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9198ba95-0388-4808-90d2-c34dad41d76e" } ], "id": "cca5735c-289d-4fd1-a80a-184487a6cd36", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cca5735c-289d-4fd1-a80a-184487a6cd36" }, { "name": "unset_group", "item": [ { "name": "Removes a SIM from a SIM group", "id": "7d4cc6bc-bb5d-478b-8093-0e9e529e46b8", "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": "ee2af4c6-8211-4dc0-bfc8-7c8c3458f27d", "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": "af086b75-0915-4f86-95b4-1ebe05ac2f8d", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af086b75-0915-4f86-95b4-1ebe05ac2f8d" }, { "id": "5e3d9e23-9a4e-4d26-80d1-7dd0c8a4a901", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5e3d9e23-9a4e-4d26-80d1-7dd0c8a4a901" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7d4cc6bc-bb5d-478b-8093-0e9e529e46b8" } ], "id": "b8f0e465-6f72-4410-a5ff-8221f80ec82b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b8f0e465-6f72-4410-a5ff-8221f80ec82b" }, { "name": "unset_imei_lock", "item": [ { "name": "Unsets IMEI lock of SIM", "id": "7c6ccc16-5c4d-4929-9ebd-d74a02a0c604", "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": "c9c5b141-5368-49b8-a3bc-857e7135ffda", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Unsets the IMEI lock of the specified SIM." }, "response": [ { "id": "c38fc0d2-eb14-4973-9d46-7db443eb9ee4", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c38fc0d2-eb14-4973-9d46-7db443eb9ee4" }, { "id": "6e4087f5-0f77-4b06-9ab1-98dfe5a243d3", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6e4087f5-0f77-4b06-9ab1-98dfe5a243d3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7c6ccc16-5c4d-4929-9ebd-d74a02a0c604" } ], "id": "5061e1fd-660b-4550-af7a-eef048a73a05", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5061e1fd-660b-4550-af7a-eef048a73a05" }, { "name": "update_speed_class", "item": [ { "name": "Updates the IoT SIM speed class", "id": "0f8ed7ca-b450-43f0-985b-79b41700ff9c", "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.4xfast\"\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": "6e5dd4e1-ecc6-4af9-aa08-ce073122f015", "key": "sim_id", "value": "", "description": "(Required) SIM ID of the target SIM." } ] }, "description": "Updates the IoT SIM speed class." }, "response": [ { "id": "7a4a3ba4-6b6a-414f-b808-5159f82e9323", "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.4xfast\"\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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7a4a3ba4-6b6a-414f-b808-5159f82e9323" }, { "id": "0d56d589-01c1-46b0-8026-b69e871bc794", "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.4xfast\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0d56d589-01c1-46b0-8026-b69e871bc794" }, { "id": "34b93ffd-1cb9-4faf-8f55-e51c03108244", "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.4xfast\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-34b93ffd-1cb9-4faf-8f55-e51c03108244" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0f8ed7ca-b450-43f0-985b-79b41700ff9c" } ], "id": "b0a16b73-0dc7-4413-b1eb-5d7ef0281e35", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b0a16b73-0dc7-4413-b1eb-5d7ef0281e35" }, { "name": "Gets information about the IoT SIM", "id": "6d049944-66d5-4da0-9e46-817f0e209d1d", "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": "8a78fd79-3b92-4491-8335-ae447ae3649a", "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": "35febee7-a3ab-401c-b2c3-f44f3eed6512", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-35febee7-a3ab-401c-b2c3-f44f3eed6512" }, { "id": "f1b3fce3-819d-4a5f-9e4f-5ba0fa55b287", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f1b3fce3-819d-4a5f-9e4f-5ba0fa55b287" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6d049944-66d5-4da0-9e46-817f0e209d1d" } ], "id": "3c5360b2-82ef-4441-8e8d-3b378cb5eacd", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3c5360b2-82ef-4441-8e8d-3b378cb5eacd" }, { "name": "List SIMs", "id": "88ab8525-5e2c-4e1a-8cc7-a6cff40640cf", "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": "05b12f34-9257-4e83-b406-b7d206b8f532", "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\": \"suspend\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"veniam_b7\": \"\",\n \"essed0\": \"\"\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\": \"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 \"profiles\": {\n \"amet5a\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"consectetur_2\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\n \"subscription\": \"\"\n },\n \"eu4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"non9\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"Lorembe\": {\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\": \"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-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"in9\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\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\": \"deleteSession\",\n \"expiryTime\": \"\",\n \"groupId\": \"\",\n \"imeiLock\": {\n \"imei\": \"\"\n },\n \"lastModifiedTime\": \"\",\n \"lastPortMappingCreatedTime\": \"\",\n \"localInfo\": {\n \"Excepteur_e3e\": \"\"\n },\n \"moduleType\": \"trio\",\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 \"ad_01\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"veniam0e0\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"ap-northeast-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"laborum_5\": \"\",\n \"Ute2\": \"\",\n \"eu717\": \"\",\n \"deserunt3\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"uicc\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05b12f34-9257-4e83-b406-b7d206b8f532" }, { "id": "93884dfa-bd9e-4c84-a034-d53f78adb8a2", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-93884dfa-bd9e-4c84-a034-d53f78adb8a2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-88ab8525-5e2c-4e1a-8cc7-a6cff40640cf" }, { "name": "Creates a new virtual SIM/Subscriber", "id": "ba94719a-c6a8-4c9c-a311-38353feb5c80", "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": "9850e99f-603b-4fba-a935-fb967f8f2938", "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\": \"eu-central-1\"\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 \"ut8e\": \"\",\n \"nulla_23\": \"\"\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\": \"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 \"dolore_e8\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"cupidatat_1\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"cupidatat_d__\": {\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 \"ad9\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"ipsum21\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"ready\",\n \"subscription\": \"\"\n },\n \"eiusmod_3\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_4\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n }\n }\n },\n \"labore_a3\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"aliquab5c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"active\",\n \"subscription\": \"\"\n },\n \"ut18\": {\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 \"sedc7d\": {\n \"arcClientPeerPrivateKey\": \"\",\n \"arcClientPeerPublicKey\": \"\",\n \"iccid\": \"\",\n \"otaSupported\": \"\",\n \"primaryImsi\": \"\",\n \"subscribers\": {\n \"non_c\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"shipped\",\n \"subscription\": \"\"\n },\n \"in667\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"terminated\",\n \"subscription\": \"\"\n },\n \"laboris_5\": {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"capabilities\": {\n \"data\": \"\",\n \"sms\": \"\"\n },\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"status\": \"delivered\",\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\": \"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\": \"eu-central-1\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"active\",\n \"tags\": {\n \"veniam_4e\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"testmodeExhaustedTime\": \"\",\n \"type\": \"virtual\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9850e99f-603b-4fba-a935-fb967f8f2938" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ba94719a-c6a8-4c9c-a311-38353feb5c80" } ], "id": "527963aa-e7fc-4490-a76c-6484b31d8762", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-527963aa-e7fc-4490-a76c-6484b31d8762" }, { "name": "sora_cam", "item": [ { "name": "devices", "item": [ { "name": "{device_id}", "item": [ { "name": "atom_cam", "item": [ { "name": "firmware", "item": [ { "name": "update", "item": [ { "name": "Retrieve firmware update information for a SoraCam compatible camera device", "id": "b8f1d702-b8b7-4cd2-8cf0-d8f2a1ace30e", "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}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "id": "17ebd03b-5170-49ec-9eed-ddc2bcf62e79", "key": "device_id", "value": "", "description": "(Required) " } ] }, "description": "Returns available firmware update information for a SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "b69e0849-2e1f-4a77-8c7a-be3a389dd267", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceId\": \"\",\n \"firmwareVersion\": \"\",\n \"timeout\": \"\"\n },\n {\n \"deviceId\": \"\",\n \"firmwareVersion\": \"\",\n \"timeout\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b69e0849-2e1f-4a77-8c7a-be3a389dd267" }, { "id": "e46b8fce-d78c-45e0-b420-ebcf067fab29", "name": "There are no firmware versions available for update for the specified SoraCam compatible camera device.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e46b8fce-d78c-45e0-b420-ebcf067fab29" }, { "id": "4baf0f15-9d61-40c8-92ea-90c3e12a6f5a", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4baf0f15-9d61-40c8-92ea-90c3e12a6f5a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b8f1d702-b8b7-4cd2-8cf0-d8f2a1ace30e" }, { "name": "Update a firmware for a SoraCam compatible camera device", "id": "368d1489-4343-4cd8-950a-590b7924ca00", "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}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "id": "d9ed5361-1ac9-4c37-8498-ffdd0e3a0ea8", "key": "device_id", "value": "", "description": "(Required) " } ] }, "description": "Update a firmware for a SoraCam compatible camera device if it is available. The SoraCam compatible camera device will be offline while updating.\n\n**Warning**: Please do not turn off the power while updating.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "35744c4d-13b2-4051-9f56-5fa75c924e8d", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-35744c4d-13b2-4051-9f56-5fa75c924e8d" }, { "id": "113f390c-0d51-4564-89d6-3c714b449705", "name": "No firmware update found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-113f390c-0d51-4564-89d6-3c714b449705" }, { "id": "d5621870-f114-4443-a39f-807858f2563f", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/firmware/update", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "firmware", "update" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d5621870-f114-4443-a39f-807858f2563f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-368d1489-4343-4cd8-950a-590b7924ca00" } ], "id": "bd759f5c-2147-467d-a25e-48798aca9365", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bd759f5c-2147-467d-a25e-48798aca9365" } ], "id": "30a10116-1ec3-4b58-b51f-70559429e0c8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-30a10116-1ec3-4b58-b51f-70559429e0c8" }, { "name": "license", "item": [ { "name": "Unassign the license from a SoraCam compatible camera device", "id": "e11c4d22-ed56-4a02-badf-13b1f04963ae", "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}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "id": "d324066e-9ac3-4e16-b2e7-fe8c68459112", "key": "device_id", "value": "", "description": "(Required) " } ] }, "description": "Unassigns the license from a specified SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Devices will not undergo cloud recording by Soracom Cloud Camera Services unless a license is assigned.\n\n**Warning**: A license is required to view footage already recorded to the cloud. This does not affect already exported videos/still images.\n\n**Warning**: Unassigning the license will not stop license charges from being applied. To stop billing, cancel the license after unassigning it via the [SoraCam:listSoraCamLicensePacks API](#/SoraCam/listSoraCamLicensePacks) or the User Console.\n" }, "response": [ { "id": "05326b28-b7cf-4f46-937c-f194ef585819", "name": "License successfully unassigned.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05326b28-b7cf-4f46-937c-f194ef585819" }, { "id": "ceb1da94-7731-4393-b54b-299051c7b465", "name": "Unable to unassign the license. Possible reasons include:\n\n- Insufficient permissions.\n- The device is shared by another operator.\n", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ceb1da94-7731-4393-b54b-299051c7b465" }, { "id": "e9eb2342-6696-46a0-90aa-22ebbf40991f", "name": "The specified device could not be found under the operator or has no assigned license.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e9eb2342-6696-46a0-90aa-22ebbf40991f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e11c4d22-ed56-4a02-badf-13b1f04963ae" }, { "name": "Update the assigned license for a SoraCam compatible camera device", "id": "468718b0-f3cf-4161-8055-7de55d30db68", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "id": "709dd888-9bea-4cde-bdb5-d056651d918d", "key": "device_id", "value": "", "description": "(Required) " } ] }, "description": "Updates the license for a specified SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "4303878e-408f-4e32-82f3-dcc5aa4946e7", "name": "License successfully updated.", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"MR14-SC\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4303878e-408f-4e32-82f3-dcc5aa4946e7" }, { "id": "09eb479f-7ca9-4085-9cfc-73745d12d07c", "name": "No changes were made to the existing license.", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Modified", "code": 304, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-09eb479f-7ca9-4085-9cfc-73745d12d07c" }, { "id": "3732d148-5ff0-4bbb-8396-f7c1783e39f6", "name": "Invalid input data or license type specified.", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3732d148-5ff0-4bbb-8396-f7c1783e39f6" }, { "id": "3d17fc0b-6c61-4cf6-ba42-280e150088a9", "name": "Unable to assign the license. Possible reasons include:\n\n- Insufficient permissions.\n- No available purchased licenses.\n- The device is shared by another operator.\n", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3d17fc0b-6c61-4cf6-ba42-280e150088a9" }, { "id": "d8326107-ed86-4dd2-8e61-3fc8ab8b9e02", "name": "The specified device could not be found under the operator.", "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 \"type\": \"MR14-SC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/license", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "license" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d8326107-ed86-4dd2-8e61-3fc8ab8b9e02" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-468718b0-f3cf-4161-8055-7de55d30db68" } ], "id": "f5249054-8cd5-4d0c-9d31-1b4f8d637b3d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f5249054-8cd5-4d0c-9d31-1b4f8d637b3d" }, { "name": "live_image", "item": [ { "name": "Get a live image from a SoraCam compatible camera device", "id": "7f84d483-1371-4de1-a531-e49a72d4520a", "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}}/sora_cam/devices/:device_id/atom_cam/live_image", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "live_image" ], "variable": [ { "id": "1e8266ed-aa23-46e6-92d1-7723311d84da", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Gets a live image from a SoraCam compatible camera device. Images are captured at the time the API is called and a download URL is returned.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must enable real-time access.\n" }, "response": [ { "id": "b22efe02-5b37-4ebb-aaac-d9298366cc82", "name": "Successfully retrieved live image URL.", "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}}/sora_cam/devices/:device_id/atom_cam/live_image", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "live_image" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b22efe02-5b37-4ebb-aaac-d9298366cc82" }, { "id": "09c39387-1a2c-4ac2-8d8e-82d95d28e6c2", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/live_image", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "live_image" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-09c39387-1a2c-4ac2-8d8e-82d95d28e6c2" }, { "id": "5b33803a-9931-4aae-a58d-8fdfa5e93f89", "name": "The SoraCam compatible camera device and server cannot be connected. This may occur when the device is offline or real-time access is not enabled.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/live_image", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "live_image" ], "variable": [ { "key": "device_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5b33803a-9931-4aae-a58d-8fdfa5e93f89" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7f84d483-1371-4de1-a531-e49a72d4520a" } ], "id": "08bd7e53-9383-4f21-a7b7-90680676ed1f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-08bd7e53-9383-4f21-a7b7-90680676ed1f" }, { "name": "options", "item": [ { "name": "real_time_access", "item": [ { "name": "Enable or disable real-time access for a SoraCam-compatible camera", "id": "b53656d9-60ef-4b36-9173-cc432e3b38ed", "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 \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/options/real_time_access", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options", "real_time_access" ], "variable": [ { "id": "b1ce1128-fee3-463e-be94-00c80094eecd", "key": "device_id", "value": "", "description": "(Required) The device ID of the SoraCam-compatible camera." } ] }, "description": "Enables or disables the real-time access feature for a SoraCam-compatible camera.\nWhen enabled, the camera can be accessed directly via P2P communication for retrieving camera feed and performing operations in real time.\n\n**Warning:** Real-time access is a paid feature. For more details, see the [documentation](https://users.soracom.io/ja-jp/docs/soracom-cloud-camera-services/real-time-access/) (Japanese).\n" }, "response": [ { "id": "cebb9bfa-eb56-4702-b20c-0acd3a557813", "name": "Real-time access has been enabled/disabled.", "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 \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/options/real_time_access", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options", "real_time_access" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cebb9bfa-eb56-4702-b20c-0acd3a557813" }, { "id": "cb6eeed5-fba9-4158-ba1f-61cef3102396", "name": "The request payload is invalid.", "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 \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/options/real_time_access", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options", "real_time_access" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cb6eeed5-fba9-4158-ba1f-61cef3102396" }, { "id": "4080d560-2d79-490c-9ba7-020324f6948d", "name": "The specified SoraCam-compatible camera was not 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 \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/options/real_time_access", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options", "real_time_access" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4080d560-2d79-490c-9ba7-020324f6948d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b53656d9-60ef-4b36-9173-cc432e3b38ed" } ], "id": "1319e800-bc78-4f54-91d0-aa27d17b44f9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1319e800-bc78-4f54-91d0-aa27d17b44f9" }, { "name": "Retrieve enabled options for a SoraCam-compatible camera", "id": "befcc17b-4388-46b9-9ebb-7a4f4cf9251d", "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}}/sora_cam/devices/:device_id/atom_cam/options", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options" ], "variable": [ { "id": "c6af9e63-b00e-4d2b-9420-75e1a86f42e6", "key": "device_id", "value": "", "description": "(Required) The device ID of the SoraCam-compatible camera." } ] }, "description": "Gets a list of whether the following options are enabled for a SoraCam-compatible camera.\n\n- [Real-time access](https://users.soracom.io/ja-jp/docs/soracom-cloud-camera-services/real-time-access/) (Japanese)\n" }, "response": [ { "id": "e5ae5edb-b4d6-4cb5-a7e5-4c389c7393ea", "name": "A list of enabled optional features for the SoraCam-compatible camera.", "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}}/sora_cam/devices/:device_id/atom_cam/options", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"realTimeAccess\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e5ae5edb-b4d6-4cb5-a7e5-4c389c7393ea" }, { "id": "6e4dfafe-9bc8-4344-87b7-03e5c771e811", "name": "The specified SoraCam-compatible camera 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}}/sora_cam/devices/:device_id/atom_cam/options", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "options" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6e4dfafe-9bc8-4344-87b7-03e5c771e811" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-befcc17b-4388-46b9-9ebb-7a4f4cf9251d" } ], "id": "e3f20aff-9b09-4a8e-b1ee-b001d103b151", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e3f20aff-9b09-4a8e-b1ee-b001d103b151" }, { "name": "settings", "item": [ { "name": "logo", "item": [ { "name": "Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image", "id": "5770960f-7b58-4350-a8e4-db6e375a8f6c", "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}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "id": "cfbab780-c00c-4432-a0bb-d4f10a72ba4a", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "e0b2b727-dd35-46d3-af11-f244e75b10f2", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e0b2b727-dd35-46d3-af11-f244e75b10f2" }, { "id": "113f4f17-c179-429d-bd0d-a76bf6d1a7cb", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-113f4f17-c179-429d-bd0d-a76bf6d1a7cb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5770960f-7b58-4350-a8e4-db6e375a8f6c" }, { "name": "Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image", "id": "ace24875-b366-4f35-8c10-bbe1e3814e14", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "id": "653ea1d6-2e12-4d4b-af57-3e308731d9ee", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "088cc3a6-55bd-4fe8-9461-5d09f67686fe", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-088cc3a6-55bd-4fe8-9461-5d09f67686fe" }, { "id": "cd0729a0-d8d5-4b48-b51e-c99eedbd39b6", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cd0729a0-d8d5-4b48-b51e-c99eedbd39b6" }, { "id": "9037d32f-3d9a-4fad-bfbb-88124daebd2a", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "logo" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9037d32f-3d9a-4fad-bfbb-88124daebd2a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ace24875-b366-4f35-8c10-bbe1e3814e14" } ], "id": "448d1c11-ca2f-42bf-af37-5199d742d055", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-448d1c11-ca2f-42bf-af37-5199d742d055" }, { "name": "motion", "item": [ { "name": "Retrieve the settings for motion detection", "id": "25f6e1a2-9fe2-4822-88fa-f5155f4c3cbd", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "id": "50815183-4e95-499a-aa26-0bf5dc7e0a66", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for motion detection. If motion detection is enabled, recording will start when the SoraCam compatible camera device detects moving objects.\n\n**Warning**: Even if a Cloud Motion Detection \"Unlimited\" Recording License is assigned to the SoraCam compatible camera device, no recording will occur if motion detection is disabled, as it will not detect any moving objects.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "a5e6d2f3-4ecc-4424-a7bd-9202bb2c71de", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a5e6d2f3-4ecc-4424-a7bd-9202bb2c71de" }, { "id": "febf9af4-82bb-4509-908b-c7aaf78d0928", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-febf9af4-82bb-4509-908b-c7aaf78d0928" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-25f6e1a2-9fe2-4822-88fa-f5155f4c3cbd" }, { "name": "Change the settings for motion", "id": "d152c1eb-bd2d-437b-a924-695ec1d4aef3", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "id": "bbfea577-52c3-404b-89e5-818fcacfe106", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for motion detection. If motion detection is enabled, recording will start when the SoraCam compatible camera device detects moving objects.\n\n**Warning**: Even if a Cloud Motion Detection \"Unlimited\" Recording License is assigned to the SoraCam compatible camera device, no recording will occur if motion detection is disabled, as it will not detect any moving objects.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "a443da53-e7bf-4cf8-931b-080443eb0784", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a443da53-e7bf-4cf8-931b-080443eb0784" }, { "id": "e46b0ef5-a057-4d11-8b79-35e72ce257e1", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e46b0ef5-a057-4d11-8b79-35e72ce257e1" }, { "id": "91ef1a19-3b67-4b08-a63f-97808af29800", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-91ef1a19-3b67-4b08-a63f-97808af29800" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d152c1eb-bd2d-437b-a924-695ec1d4aef3" } ], "id": "0ab0fa40-9c7d-47e1-bd4b-692a11bdecca", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0ab0fa40-9c7d-47e1-bd4b-692a11bdecca" }, { "name": "motion_sensitivity", "item": [ { "name": "Retrieve the settings for motion sensitivity", "id": "43f4bbd6-6780-431e-9723-2c5d33e7a6fa", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "id": "3fb4b4c7-e1f8-41c2-a08a-7f83fbbfeb8f", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for motion sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "a3db3a9a-809e-452a-b067-20035ec6f573", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"low\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a3db3a9a-809e-452a-b067-20035ec6f573" }, { "id": "b6192a57-080f-4115-ad68-360a4db40b72", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b6192a57-080f-4115-ad68-360a4db40b72" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-43f4bbd6-6780-431e-9723-2c5d33e7a6fa" }, { "name": "Change the settings for motion sensitivity", "id": "863b66e8-7ca0-4776-95b6-dd5eb2c11846", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "id": "03cca3e6-02d7-4b61-9a73-8ef51173beb8", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for motion sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "feff3469-1930-418c-9098-8c9494587c4b", "name": "OK.", "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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-feff3469-1930-418c-9098-8c9494587c4b" }, { "id": "ccf9885d-45e5-4195-9957-afcc8d441e92", "name": "The specified value 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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ccf9885d-45e5-4195-9957-afcc8d441e92" }, { "id": "ee065fae-3572-4b12-a0df-cef83ef6b08b", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ee065fae-3572-4b12-a0df-cef83ef6b08b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-863b66e8-7ca0-4776-95b6-dd5eb2c11846" } ], "id": "cb888dbc-2e4f-4efd-abe6-8dd502fc0f63", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cb888dbc-2e4f-4efd-abe6-8dd502fc0f63" }, { "name": "motion_tagging", "item": [ { "name": "Retrieve the display settings for motion tagging", "id": "d8041945-6245-4233-b158-7cc00883a58f", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "id": "222fb559-ad65-43d0-be3a-0c81be5f91be", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "8254e4c1-3eea-40dc-a54d-bea03b7d399a", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8254e4c1-3eea-40dc-a54d-bea03b7d399a" }, { "id": "177e4a33-cd23-4c03-b555-f899d57c9f13", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-177e4a33-cd23-4c03-b555-f899d57c9f13" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d8041945-6245-4233-b158-7cc00883a58f" }, { "name": "Change the display settings for motion tagging", "id": "4247db82-4bc6-48e1-9f07-ea1fcdd3c7d2", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "id": "e92a1750-a198-4c48-a70a-d1dc8dde305a", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "1fb38189-478c-40c9-abfa-369a70be04e3", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1fb38189-478c-40c9-abfa-369a70be04e3" }, { "id": "2aba6537-78dd-4175-b9c8-7a6e8cc9e315", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2aba6537-78dd-4175-b9c8-7a6e8cc9e315" }, { "id": "ae270548-67af-4074-9738-3d725b66cb84", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "motion_tagging" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ae270548-67af-4074-9738-3d725b66cb84" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4247db82-4bc6-48e1-9f07-ea1fcdd3c7d2" } ], "id": "87a0559e-f80a-4ec1-beb1-3d09e4fdf6fb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-87a0559e-f80a-4ec1-beb1-3d09e4fdf6fb" }, { "name": "night_vision", "item": [ { "name": "Retrieve the settings for night vision mode", "id": "b667e036-2410-497b-99ed-29b51b77781c", "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}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "id": "2a4e84e9-7d76-41a0-bd4c-869c92fce650", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for night vision mode.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "1826bb35-bab4-4cd9-aaf7-d336ca27a111", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"auto\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1826bb35-bab4-4cd9-aaf7-d336ca27a111" }, { "id": "79a85beb-02b1-4ebb-a990-7eb03160503c", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-79a85beb-02b1-4ebb-a990-7eb03160503c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b667e036-2410-497b-99ed-29b51b77781c" }, { "name": "Change the settings for night vision mode", "id": "84c0dc75-9857-4902-bf93-f4825fdd41ef", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "id": "90860b86-80eb-43d1-a5e7-c405cb301aa8", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for night vision mode.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "032c33c9-50a5-47e7-a092-cd28726bd350", "name": "OK.", "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 \"state\": \"auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-032c33c9-50a5-47e7-a092-cd28726bd350" }, { "id": "9f760018-94d5-4762-8c51-f759e32e9b7a", "name": "The specified value 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 \"state\": \"auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9f760018-94d5-4762-8c51-f759e32e9b7a" }, { "id": "baa8a029-37ef-4d10-bf07-07d7166c1ba9", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "night_vision" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-baa8a029-37ef-4d10-bf07-07d7166c1ba9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-84c0dc75-9857-4902-bf93-f4825fdd41ef" } ], "id": "854bf8ef-cc45-47d0-9695-9abcc3910c93", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-854bf8ef-cc45-47d0-9695-9abcc3910c93" }, { "name": "quality", "item": [ { "name": "Retrieve the quality settings", "id": "e4f6927f-fc3d-49d2-bd54-c3ddd5e86022", "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}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "id": "c1379a79-18c2-4c10-a375-aef62340d2ea", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the quality settings.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "a0513484-f740-4ab0-b3d2-311e239a4510", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"medium\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a0513484-f740-4ab0-b3d2-311e239a4510" }, { "id": "0918caab-8a29-4b98-9697-e30a1279e346", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0918caab-8a29-4b98-9697-e30a1279e346" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e4f6927f-fc3d-49d2-bd54-c3ddd5e86022" }, { "name": "Change the quality settings", "id": "4358794b-31c7-45a3-86b9-f8c1e180e1ce", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "id": "6d591000-ef87-4e90-860a-456546a7eb49", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Changes the quality settings. The quality settings will be applied to all videos and still images captured by the specified SoraCam compatible camera device. Note that if the Wi-Fi bandwidth is insufficient, the quality settings may automatically be adjusted.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "96d29441-2955-43f7-9a5d-1c6d64479dc3", "name": "OK.", "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 \"state\": \"medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-96d29441-2955-43f7-9a5d-1c6d64479dc3" }, { "id": "df4b7cae-5e40-443a-a9b8-d3a827c62e3a", "name": "The specified value 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 \"state\": \"medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-df4b7cae-5e40-443a-a9b8-d3a827c62e3a" }, { "id": "ddfe8d05-33d2-4880-b7aa-2879dc6be610", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/quality", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "quality" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ddfe8d05-33d2-4880-b7aa-2879dc6be610" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4358794b-31c7-45a3-86b9-f8c1e180e1ce" } ], "id": "4a787ccf-13aa-443d-ae0a-187ea475b226", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4a787ccf-13aa-443d-ae0a-187ea475b226" }, { "name": "rotation", "item": [ { "name": "Retrieve the settings for rotating the image by 180 degrees", "id": "d440cdde-05d3-412e-8679-5443163b2214", "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}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "id": "232ce907-e3b2-4d09-8a32-20532371feea", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for rotating the image by 180 degrees.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "229686f7-570a-4a73-bd24-07d441387ee6", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": 180\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-229686f7-570a-4a73-bd24-07d441387ee6" }, { "id": "9519d3ae-96e5-45a5-921b-203f3c9eae7c", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9519d3ae-96e5-45a5-921b-203f3c9eae7c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d440cdde-05d3-412e-8679-5443163b2214" }, { "name": "Change the settings for rotating the image by 180 degrees", "id": "e26889e0-6a7c-4718-8ee7-63c81e0ca5f4", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": 180\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "id": "b8dd359a-3bef-4252-b5fa-87a71d31b6c2", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for rotating the image by 180 degrees.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "d96641aa-2c58-4f4e-a2f3-9357952ab6ce", "name": "OK.", "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 \"state\": 180\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d96641aa-2c58-4f4e-a2f3-9357952ab6ce" }, { "id": "678fe4f3-def1-4986-8859-1574c8b212f4", "name": "The specified value 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 \"state\": 180\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-678fe4f3-def1-4986-8859-1574c8b212f4" }, { "id": "72dfeec2-6faf-44f2-b476-dab8b83ab7f9", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": 180\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/rotation", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "rotation" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-72dfeec2-6faf-44f2-b476-dab8b83ab7f9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e26889e0-6a7c-4718-8ee7-63c81e0ca5f4" } ], "id": "3d3dd640-1275-4ad4-8e62-c71d07df0eb0", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3d3dd640-1275-4ad4-8e62-c71d07df0eb0" }, { "name": "sound", "item": [ { "name": "Retrieve the settings for sound detection", "id": "616eff74-4fc6-4e49-97fd-470d3f4f20ec", "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}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "id": "b84fe57e-5408-44b4-9885-fbbe3c672c6a", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for sound detection. If sound detection is enabled, recording will start when the SoraCam compatible camera device detects sound.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Video recorded via sound detection cannot be downloaded separately via the Soracom User Console, Soracom CLI, or Soracom API. However, if a Cloud Continuous Recording License is assigned, you can check the time that sound was detected using [SoraCam:listSoraCamDeviceEventsForDevice API](#/SoraCam/listSoraCamDeviceEventsForDevice) and then download the video recorded during that time.\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "b413105a-67af-4301-9d54-64686d1084f5", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b413105a-67af-4301-9d54-64686d1084f5" }, { "id": "86a672e4-873a-4da7-b8b0-218aa9784a0c", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-86a672e4-873a-4da7-b8b0-218aa9784a0c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-616eff74-4fc6-4e49-97fd-470d3f4f20ec" }, { "name": "Change the settings for sound detection", "id": "c2b18d56-5a25-47c1-8dd3-744c34e8839d", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "id": "85031977-0d92-4bac-80e0-3b8e5694e18b", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for sound detection. If sound detection is enabled, recording will start when the SoraCam compatible camera device detects sound.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Video recorded via sound detection cannot be downloaded separately via the Soracom User Console, Soracom CLI, or Soracom API. However, if a Cloud Continuous Recording License is assigned, you can check the time that sound was detected using [SoraCam:listSoraCamDeviceEventsForDevice API](#/SoraCam/listSoraCamDeviceEventsForDevice) and then download the video recorded during that time.\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "79653278-d4f0-4624-8902-e78c2c320995", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-79653278-d4f0-4624-8902-e78c2c320995" }, { "id": "ac1ccb5f-c2d0-49c5-acd4-e860f78a0907", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ac1ccb5f-c2d0-49c5-acd4-e860f78a0907" }, { "id": "7a601122-64a7-4644-afe3-74061251480d", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7a601122-64a7-4644-afe3-74061251480d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c2b18d56-5a25-47c1-8dd3-744c34e8839d" } ], "id": "910961af-210d-46b4-92f7-a7dbc4652cd6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-910961af-210d-46b4-92f7-a7dbc4652cd6" }, { "name": "sound_sensitivity", "item": [ { "name": "Retrieve the settings for sound sensitivity", "id": "653248a7-f016-4c3b-bf51-13e19b0e00fe", "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}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "id": "6ff20d64-c6e9-439c-b44d-4cba3fc953e4", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for sound sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "dddd23ad-972d-49cf-ab0d-57bced3aef39", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"low\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dddd23ad-972d-49cf-ab0d-57bced3aef39" }, { "id": "6346f0a7-5c44-43d9-a710-2751d822516d", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6346f0a7-5c44-43d9-a710-2751d822516d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-653248a7-f016-4c3b-bf51-13e19b0e00fe" }, { "name": "Change the settings for sound sensitivity", "id": "9bf4cc99-18c8-4750-81b0-41a79df506e4", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "id": "cfc5d4a0-f59e-4a94-89bd-a7137745f975", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for sound sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "45024d31-0429-4cb3-a437-257ecee143a3", "name": "OK.", "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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-45024d31-0429-4cb3-a437-257ecee143a3" }, { "id": "21f43f2c-b685-4263-a0f0-76d5875179c1", "name": "The specified value 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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-21f43f2c-b685-4263-a0f0-76d5875179c1" }, { "id": "bd2945b1-7216-4582-b7e1-7abb0c7bbe15", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "sound_sensitivity" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bd2945b1-7216-4582-b7e1-7abb0c7bbe15" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9bf4cc99-18c8-4750-81b0-41a79df506e4" } ], "id": "2c3e69c3-2483-48bf-9c23-2361a3667282", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2c3e69c3-2483-48bf-9c23-2361a3667282" }, { "name": "status_light", "item": [ { "name": "Retrieve the settings for the status light (indicator light that shows the status of the camera)", "id": "edbcfd9f-4b0d-4779-b3af-796cd24a10b1", "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}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "id": "2f07c7bd-dc4c-4259-a564-e6a90dd8b308", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the settings for the status light (indicator light that shows the status of the camera).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "eaf5571e-e2fc-4415-a76a-189a056c7142", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-eaf5571e-e2fc-4415-a76a-189a056c7142" }, { "id": "3f9711b8-148f-49fc-8144-dcf9e67e7ca4", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3f9711b8-148f-49fc-8144-dcf9e67e7ca4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-edbcfd9f-4b0d-4779-b3af-796cd24a10b1" }, { "name": "Change the settings for the status light (indicator light that shows the status of the camera)", "id": "a1482846-d162-45ef-bdc6-70dd53357e44", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "id": "22a0b43e-bcf4-4e51-9e3a-48467d1cbebf", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the settings for the status light (indicator light that shows the status of the camera).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "1cf28b2f-a34a-4bff-bb8f-2330d135802d", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1cf28b2f-a34a-4bff-bb8f-2330d135802d" }, { "id": "6bf87b0f-b54f-4974-81dd-03888052e481", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6bf87b0f-b54f-4974-81dd-03888052e481" }, { "id": "c3968a80-d5f8-4164-8403-2effc864280f", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/status_light", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "status_light" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c3968a80-d5f8-4164-8403-2effc864280f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a1482846-d162-45ef-bdc6-70dd53357e44" } ], "id": "df95b332-9efd-4008-a0fe-2dcfcca5adac", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-df95b332-9efd-4008-a0fe-2dcfcca5adac" }, { "name": "timestamp", "item": [ { "name": "Retrieve the display settings for the timestamp shown on the bottom right of the captured image", "id": "e185add9-6457-46a8-9f34-ed841549ed7d", "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}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "id": "d4b8f9cc-86d2-4f65-8871-2af3dabcc8c7", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the display settings for the timestamp shown on the bottom right of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "c710ecfb-8f1d-463a-b407-23a643c3f628", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state\": \"on\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c710ecfb-8f1d-463a-b407-23a643c3f628" }, { "id": "6f275bae-487a-406a-a9d2-f013b51c3761", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6f275bae-487a-406a-a9d2-f013b51c3761" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e185add9-6457-46a8-9f34-ed841549ed7d" }, { "name": "Change the display settings for the timestamp shown on the bottom right of the captured image", "id": "729004f8-dabf-49b5-bb1f-0623ffc3d221", "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" } ], "body": { "mode": "raw", "raw": "{\n \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "id": "fa586d31-a91d-4732-aa61-698e98667dc7", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Change the display settings for the timestamp shown on the bottom right of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "cc3f4f7b-a1f7-447c-ad46-8cf92fa33218", "name": "OK.", "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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cc3f4f7b-a1f7-447c-ad46-8cf92fa33218" }, { "id": "ca779549-a32a-43ca-86f6-dd20fa93ce76", "name": "The specified value 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ca779549-a32a-43ca-86f6-dd20fa93ce76" }, { "id": "3899db14-f0b2-4d71-b7f7-d740f6fbd4e8", "name": "The specified SoraCam compatible camera device could not be 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 \"state\": \"on\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings", "timestamp" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3899db14-f0b2-4d71-b7f7-d740f6fbd4e8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-729004f8-dabf-49b5-bb1f-0623ffc3d221" } ], "id": "6ca7dc62-16fc-450e-a904-c5116780a810", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6ca7dc62-16fc-450e-a904-c5116780a810" }, { "name": "Retrieve the camera's various settings", "id": "ec2cdf62-7d20-4dae-8026-7998c2dab0cc", "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}}/sora_cam/devices/:device_id/atom_cam/settings", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings" ], "variable": [ { "id": "037a0c9c-0b21-4e9f-b189-47eb7482d4da", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Retrieve the camera's various settings.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, "response": [ { "id": "f03d54c5-63cf-4101-a8bd-016d2b30d317", "name": "OK.", "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}}/sora_cam/devices/:device_id/atom_cam/settings", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"quality\": \"medium\",\n \"statusLight\": \"on\",\n \"timestamp\": \"on\",\n \"logo\": \"off\",\n \"motion\": \"off\",\n \"motionSensitivity\": \"medium\",\n \"motionTagging\": \"off\",\n \"sound\": \"off\",\n \"soundSensitivity\": \"high\",\n \"nightVision\": \"on\",\n \"rotation\": 180\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f03d54c5-63cf-4101-a8bd-016d2b30d317" }, { "id": "6800f473-03e0-4dd8-818d-52fcc3098852", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/atom_cam/settings", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "atom_cam", "settings" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6800f473-03e0-4dd8-818d-52fcc3098852" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ec2cdf62-7d20-4dae-8026-7998c2dab0cc" } ], "id": "af8f0d87-7642-4ae7-b334-28b1db2cb0a0", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-af8f0d87-7642-4ae7-b334-28b1db2cb0a0" } ], "id": "77b005a3-1f54-427a-8b75-69fd04b682e8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-77b005a3-1f54-427a-8b75-69fd04b682e8" }, { "name": "data", "item": [ { "name": "{time}", "item": [ { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device and timestamp", "id": "ee40f492-8c6c-4480-9110-89e9435e8304", "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" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/data/:time", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data", ":time" ], "variable": [ { "id": "75d8511f-467a-4722-a09b-2966004fb75b", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "c167c075-9c41-4435-993e-ba27e6101119", "key": "time", "value": "", "description": "(Required) The timestamp of the target data entry (UNIX time in milliseconds)." } ] }, "description": "Saves arbitrary data to Harvest Data with a particular timestamp that will be associated to a SoraCam compatible camera device specified by its device ID (`device_id`).\n\n- If no data exists for the specified timestamp, a new data entry will be created.\n- If data already exists for the specified timestamp, it will be overwritten according to the specifications of Harvest Data.\n\nFor example, to save JSON data, set `Content-Type: application/json` in the header and specify `{ \"person_count\": 5 }` in the request body.\n\n**Warning**: When using a SAM user's API key and API token to execute this API, you must grant the SAM user the `OAuth2:authorize` permission in addition to the permissions required to call this API (e.g., `SoraCam:*`). For details about permission settings, refer to [Configuring SAM User Permissions](/en/docs/sam/set-permissions/).\n\n**Info**: To retrieve saved data entries, use the [DataEntry:getDataEntry API](#/DataEntry/getDataEntry). To delete data entries, use the [DataEntry:deleteDataEntry API](#/DataEntry/deleteDataEntry).\n\n**Info**: For more information about Harvest Data, please refer to [Soracom Harvest](/en/docs/harvest/).\n" }, "response": [ { "id": "6fb63d2c-3c99-41ef-b510-38db4c572c03", "name": "Data was successfully saved to Harvest Data.", "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": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/data/:time", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data", ":time" ], "variable": [ { "key": "device_id" }, { "key": "time" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6fb63d2c-3c99-41ef-b510-38db4c572c03" }, { "id": "8db0574c-b34b-4f33-8c90-85d5c6be8fee", "name": "The specified SoraCam compatible camera device could not be 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": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/data/:time", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data", ":time" ], "variable": [ { "key": "device_id" }, { "key": "time" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8db0574c-b34b-4f33-8c90-85d5c6be8fee" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ee40f492-8c6c-4480-9110-89e9435e8304" } ], "id": "205365f2-5218-475d-a55b-508fc4075b5d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-205365f2-5218-475d-a55b-508fc4075b5d" }, { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device", "id": "aca45521-f89b-44fd-8056-03ccdaf945cb", "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" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data" ], "variable": [ { "id": "a2ef1dd9-daca-4e4b-b319-bda085d755c6", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Saves arbitrary data to Harvest Data that will be associated to a SoraCam compatible camera device specified by its device ID (`device_id`).\n\nFor example, to save JSON data, set `Content-Type: application/json` in the header and specify `{ \"person_count\": 5 }` in the request body.\n\n**Warning**: When using a SAM user's API key and API token to execute this API, you must grant the SAM user the `OAuth2:authorize` permission in addition to the permissions required to call this API (e.g., `SoraCam:*`). For details about permission settings, refer to [Configuring SAM User Permissions](/en/docs/sam/set-permissions/).\n\n**Info**: To retrieve saved data entries, use the [DataEntry:getDataEntry API](#/DataEntry/getDataEntry). To delete data entries, use the [DataEntry:deleteDataEntry API](#/DataEntry/deleteDataEntry).\n\n**Info**: For more information about Harvest Data, please refer to [Soracom Harvest](/en/docs/harvest/).\n" }, "response": [ { "id": "7b49d9e8-d063-4d88-9315-6a73768ce826", "name": "Data has been successfully saved to Harvest Data.", "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}}/sora_cam/devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b49d9e8-d063-4d88-9315-6a73768ce826" }, { "id": "d74be495-5d59-4b9b-a7b6-9bcee06d9578", "name": "The specified SoraCam compatible camera device could not be 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": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/data", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "data" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d74be495-5d59-4b9b-a7b6-9bcee06d9578" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-aca45521-f89b-44fd-8056-03ccdaf945cb" } ], "id": "81d11ef9-ea87-4587-a072-7873fb22213d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-81d11ef9-ea87-4587-a072-7873fb22213d" }, { "name": "events", "item": [ { "name": "List SoraCam events for the specified device.", "id": "0a2e1f1b-a9ba-42ea-9aed-aa65c240b4e3", "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}}/sora_cam/devices/:device_id/events?last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by target SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by target SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "id": "c41673ff-4ac8-4d9b-87dc-f773ead114f4", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Returns list of SoraCam events for the specified device.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "8aed9eeb-c45d-42f9-8075-bd7aa3fcc3c1", "name": "OK.", "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}}/sora_cam/devices/:device_id/events?last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by target SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by target SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceId\": \"\",\n \"eventId\": \"\",\n \"time\": \"\",\n \"deviceType\": \"\",\n \"eventInfo\": {\n \"infoType\": \"\",\n \"atomEventV1\": {\n \"endTime\": \"\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"movie\": \"\",\n \"picture\": \"\",\n \"recordingStatus\": \"recording\",\n \"startTime\": \"\",\n \"type\": \"sound\"\n }\n }\n },\n {\n \"deviceId\": \"\",\n \"eventId\": \"\",\n \"time\": \"\",\n \"deviceType\": \"\",\n \"eventInfo\": {\n \"infoType\": \"\",\n \"atomEventV1\": {\n \"endTime\": \"\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"movie\": \"\",\n \"picture\": \"\",\n \"recordingStatus\": \"completed\",\n \"startTime\": \"\",\n \"type\": \"motion\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8aed9eeb-c45d-42f9-8075-bd7aa3fcc3c1" }, { "id": "ff512c7e-ab6d-4c15-a5aa-ce148aa4189c", "name": "The specified value is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/events?last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by target SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by target SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ff512c7e-ab6d-4c15-a5aa-ce148aa4189c" }, { "id": "b64dec1d-0acc-49f0-85d7-cb0f97791012", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/events?last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by target SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by target SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b64dec1d-0acc-49f0-85d7-cb0f97791012" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0a2e1f1b-a9ba-42ea-9aed-aa65c240b4e3" } ], "id": "745d3d50-6dba-4e26-bdf5-ecdebb4ff515", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-745d3d50-6dba-4e26-bdf5-ecdebb4ff515" }, { "name": "exports", "item": [ { "name": "usage", "item": [ { "name": "limit_override", "item": [ { "name": "Reset the monthly limit on the recorded video time available for export for SoraCam compatible camera device to the default value.", "id": "5ee3769a-45d7-42cc-8f05-6d97e1be9224", "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}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "id": "157e5e5a-4699-41f1-9cf8-1c210381fec3", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "7945cd63-ec0d-41f9-9492-2d75c0401b63", "name": "OK, deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "key": "device_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7945cd63-ec0d-41f9-9492-2d75c0401b63" }, { "id": "859ee9d4-1a1d-45a3-af29-a7bf5c82960b", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-859ee9d4-1a1d-45a3-af29-a7bf5c82960b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5ee3769a-45d7-42cc-8f05-6d97e1be9224" }, { "name": "Set the monthly limit on the recorded video time available for export for SoraCam compatible camera device.", "id": "8c0e56ee-f954-4aed-b11a-ab7dcf0d90bd", "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 \"limitHours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "id": "b5eca901-c9c5-4c98-87e1-64743078e0c3", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set.\n\n**Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Services [about fees](https://soracom.jp/sora_cam/#pricing) (Japanese).\n\n**Warning**: The monthly limit can be set to less than 72 hours. In such cases, there will be no change in the charge.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "04d92583-9d2d-486b-8206-b149dd07f90d", "name": "OK, updated.", "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 \"limitHours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceId\": \"\",\n \"meteredYearMonth\": \"\",\n \"video\": {\n \"billedSeconds\": \"\",\n \"limitSeconds\": \"\",\n \"remainingSeconds\": \"\",\n \"usedSeconds\": \"\"\n },\n \"image\": {\n \"billedFrames\": \"\",\n \"limitFrames\": \"\",\n \"remainingFrames\": \"\",\n \"usedFrames\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-04d92583-9d2d-486b-8206-b149dd07f90d" }, { "id": "326055ce-bb7a-4bdb-b14c-57a54ef66228", "name": "The specified limit override is not acceptable.", "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 \"limitHours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-326055ce-bb7a-4bdb-b14c-57a54ef66228" }, { "id": "ef7cf19b-bcaa-4ea8-a4dd-c3071d398399", "name": "The specified SoraCam compatible camera device could not be 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 \"limitHours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage/limit_override", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage", "limit_override" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ef7cf19b-bcaa-4ea8-a4dd-c3071d398399" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8c0e56ee-f954-4aed-b11a-ab7dcf0d90bd" } ], "id": "cd48814e-fe21-4e36-b72f-d4fe8de45aea", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cd48814e-fe21-4e36-b72f-d4fe8de45aea" }, { "name": "Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.", "id": "81038f34-1b71-4514-bf06-04bfa3c8a35c", "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}}/sora_cam/devices/:device_id/exports/usage", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage" ], "variable": [ { "id": "e1339398-ad25-4ebf-8edf-53fb7eecbfbb", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.\n\n**Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "17d7b0a4-9058-4799-b2f8-5ff1004d033a", "name": "OK.", "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}}/sora_cam/devices/:device_id/exports/usage", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceId\": \"\",\n \"meteredYearMonth\": \"\",\n \"video\": {\n \"billedSeconds\": \"\",\n \"limitSeconds\": \"\",\n \"remainingSeconds\": \"\",\n \"usedSeconds\": \"\"\n },\n \"image\": {\n \"billedFrames\": \"\",\n \"limitFrames\": \"\",\n \"remainingFrames\": \"\",\n \"usedFrames\": \"\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-17d7b0a4-9058-4799-b2f8-5ff1004d033a" }, { "id": "df119263-698a-49d6-8fe4-97a5a7a5a696", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/exports/usage", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "exports", "usage" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-df119263-698a-49d6-8fe4-97a5a7a5a696" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-81038f34-1b71-4514-bf06-04bfa3c8a35c" } ], "id": "bfc1cc9f-3867-47d5-8407-3802833a1dee", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bfc1cc9f-3867-47d5-8407-3802833a1dee" } ], "id": "07134dd4-3ce1-42f1-89ab-4daf4d34d8fa", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-07134dd4-3ce1-42f1-89ab-4daf4d34d8fa" }, { "name": "images", "item": [ { "name": "exports", "item": [ { "name": "{export_id}", "item": [ { "name": "Get the current status of the process of exporting still images from recorded video taken with a SoraCam compatible camera device", "id": "f88ade30-01d8-42e3-95b0-21759592fad3", "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}}/sora_cam/devices/:device_id/images/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports", ":export_id" ], "variable": [ { "id": "859b4976-fd64-4998-abf8-7e03f74d0239", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "45e9d462-d775-4836-85d9-0a1f76493796", "key": "export_id", "value": "", "description": "(Required) Export ID of the target export operation." } ] }, "description": "Gets the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one export process.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "dc93b42e-bdcb-4316-8d51-c8ee4bec28db", "name": "OK.", "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}}/sora_cam/devices/:device_id/images/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports", ":export_id" ], "variable": [ { "key": "device_id" }, { "key": "export_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"limitExceeded\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc93b42e-bdcb-4316-8d51-c8ee4bec28db" }, { "id": "6626d56b-cc2b-4d82-9dc3-90de58a2d4dd", "name": "The specified SoraCam compatible camera device or export process could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports", ":export_id" ], "variable": [ { "key": "device_id" }, { "key": "export_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6626d56b-cc2b-4d82-9dc3-90de58a2d4dd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f88ade30-01d8-42e3-95b0-21759592fad3" } ], "id": "fd6b2eff-2865-4d10-b7cc-608167da5650", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fd6b2eff-2865-4d10-b7cc-608167da5650" }, { "name": "Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.", "id": "1e70de4f-d85f-426a-bef9-d988c601bc0a", "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}}/sora_cam/devices/:device_id/images/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "id": "8332fcb7-6cdb-4a75-a150-3f098ed46ee2", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Gets the list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one SoraCam compatible camera device.\n\nIf the target is not limited to one SoraCam compatible camera device, but all SoraCam compatible camera devices owned by the operator, use [SoraCam:listSoraCamDeviceImageExports API](#!/SoraCam/listSoraCamDeviceImageExports).\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime`. Additionally, over time, it will be removed from the list.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "cfeb4372-db8d-45d0-a5e0-3295fe2335fe", "name": "OK.", "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}}/sora_cam/devices/:device_id/images/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"failed\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cfeb4372-db8d-45d0-a5e0-3295fe2335fe" }, { "id": "8956ec83-2d2d-4c70-82c5-394475d5f8fd", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8956ec83-2d2d-4c70-82c5-394475d5f8fd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1e70de4f-d85f-426a-bef9-d988c601bc0a" }, { "name": "Start the process of exporting still images from recorded video saved on the cloud", "id": "e7950d6c-de04-4ce9-b2fc-ea66e9ef5e2d", "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 \"time\": \"\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n },\n \"imageFilters\": [\n \"wide_angle_correction\",\n \"wide_angle_correction\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "variable": [ { "id": "74ff1a48-57a9-4911-99ed-ce1a7ce9f3f4", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Starts the process of extracting and exporting still images from recorded video saved on the cloud. The export process is processed asynchronously. The progress of the export process and the URL of the exported file can be obtained with the [SoraCam:listSoraCamDeviceImageExports API](#!/SoraCam/listSoraCamDeviceImageExports). The URL has an expiration time.\n\n- At the time of obtaining the URL, the available video viewing time (72 hours per month by default) will be consumed regardless of whether the download has started or not.\n- Exporting results are not cached. If you export the same time twice, it will consume twice the available video viewing time (72 hours per month by default).\n- Exporting to Harvest Files will incur costs according to Harvest Files fees, and files will be retained for a period according to the Harvest Files retention period. For details, refer to [Pricing & Fee Schedule](/en/docs/reference/fees/#soracom-harvest-files).\n\n**Warning**: Images from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection \"Unlimited\" Recording License cannot be exported.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. Additionally, to export to Harvest Files, the [FileEntry:putFile API](#/FileEntry/putFile) permission must be granted. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: The image size of the exported still images is 1920 x 1080 pixels.\n" }, "response": [ { "id": "441dc94b-2682-4e38-93c1-b5ac51f8fcfc", "name": "OK.", "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 \"time\": \"\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n },\n \"imageFilters\": [\n \"wide_angle_correction\",\n \"wide_angle_correction\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"limitExceeded\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-441dc94b-2682-4e38-93c1-b5ac51f8fcfc" }, { "id": "06ec5025-eee7-4908-b104-bc52c97ba46e", "name": "The value specified for `time` 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 \"time\": \"\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n },\n \"imageFilters\": [\n \"wide_angle_correction\",\n \"wide_angle_correction\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-06ec5025-eee7-4908-b104-bc52c97ba46e" }, { "id": "c1f79d1d-5fc0-44c3-8b8d-584aefebaabc", "name": "You do not have the required permission (FileEntry:putFile) to export to Harvest Files.", "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 \"time\": \"\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n },\n \"imageFilters\": [\n \"wide_angle_correction\",\n \"wide_angle_correction\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c1f79d1d-5fc0-44c3-8b8d-584aefebaabc" }, { "id": "e6276c1d-8b36-4a10-a4a2-e97b478dafbb", "name": "The specified SoraCam compatible camera device could not be 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 \"time\": \"\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n },\n \"imageFilters\": [\n \"wide_angle_correction\",\n \"wide_angle_correction\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/images/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "images", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e6276c1d-8b36-4a10-a4a2-e97b478dafbb" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e7950d6c-de04-4ce9-b2fc-ea66e9ef5e2d" } ], "id": "8d2cdad6-6b92-460c-97fc-54600165ffec", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8d2cdad6-6b92-460c-97fc-54600165ffec" } ], "id": "10782d2b-807e-412c-a5f6-34b63ca6d3f1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-10782d2b-807e-412c-a5f6-34b63ca6d3f1" }, { "name": "name", "item": [ { "name": "Get the current name of the SoraCam compatible camera device.", "id": "a7a88be2-4605-47ac-bf08-be69401cce43", "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}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "id": "df9d6623-18a4-4558-a344-5cb3688256d5", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Get the current name of the SoraCam compatible camera device." }, "response": [ { "id": "5e700fc9-4b19-40ea-8fe7-9bbc571cf7a6", "name": "OK.", "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}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5e700fc9-4b19-40ea-8fe7-9bbc571cf7a6" }, { "id": "77783ecd-f6b6-420f-a667-6b198d1c397a", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-77783ecd-f6b6-420f-a667-6b198d1c397a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a7a88be2-4605-47ac-bf08-be69401cce43" }, { "name": "Changes the name of the SoraCam compatible camera device.", "id": "b60993c9-8bac-45c7-99e6-2faf385d1514", "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" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "id": "1c45c9d4-df0f-4398-8dec-e732bc695577", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Changes the name of the SoraCam compatible camera device." }, "response": [ { "id": "1586562b-2f47-49ea-9b1a-d7a26811ee11", "name": "OK.", "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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1586562b-2f47-49ea-9b1a-d7a26811ee11" }, { "id": "9f295b85-9ab4-40ec-8889-24ad9cc9e2d5", "name": "The specified value 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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9f295b85-9ab4-40ec-8889-24ad9cc9e2d5" }, { "id": "a8305557-0fc7-4fee-a084-c8416176ffcf", "name": "The specified SoraCam compatible camera device could not be 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 \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/name", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "name" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a8305557-0fc7-4fee-a084-c8416176ffcf" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b60993c9-8bac-45c7-99e6-2faf385d1514" } ], "id": "58c4223c-baa7-45f3-87c1-748c465dec53", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-58c4223c-baa7-45f3-87c1-748c465dec53" }, { "name": "power_state", "item": [ { "name": "Get the current power state of the SoraCam compatible camera device.", "id": "50733b86-6966-4a9a-9cc5-3988488c1ea5", "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}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "id": "0d1d4f21-53e4-46d0-ac29-3487ec1377d8", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Get the current power state of the SoraCam compatible camera device." }, "response": [ { "id": "499fa6a7-f5d7-40ab-9da4-71484367637d", "name": "OK.", "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}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"powerState\": \"sleep\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-499fa6a7-f5d7-40ab-9da4-71484367637d" }, { "id": "3ca62fa1-1959-4114-8951-bf5011e88e59", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3ca62fa1-1959-4114-8951-bf5011e88e59" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-50733b86-6966-4a9a-9cc5-3988488c1ea5" }, { "name": "Changes the power state of the SoraCam compatible camera device.", "id": "df825826-e4b8-4d67-8f4e-89b890ab1802", "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" } ], "body": { "mode": "raw", "raw": "{\n \"powerState\": \"sleep\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "id": "81fb6dfe-c6db-46ac-b66d-9b022360e7d4", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Changes the power state of the SoraCam compatible camera device." }, "response": [ { "id": "9f35872f-a222-41ce-abf2-6ea4f23bf387", "name": "OK.", "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 \"powerState\": \"sleep\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9f35872f-a222-41ce-abf2-6ea4f23bf387" }, { "id": "4c434bfc-a875-400a-a891-b414477e4897", "name": "The specified value 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 \"powerState\": \"sleep\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4c434bfc-a875-400a-a891-b414477e4897" }, { "id": "6399de17-4afa-4207-931f-6d04d9e0af56", "name": "The specified SoraCam compatible camera device could not be 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 \"powerState\": \"sleep\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/power_state", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "power_state" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6399de17-4afa-4207-931f-6d04d9e0af56" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-df825826-e4b8-4d67-8f4e-89b890ab1802" } ], "id": "76f3f14d-33d7-4629-a54b-352e9346db6d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-76f3f14d-33d7-4629-a54b-352e9346db6d" }, { "name": "reboot", "item": [ { "name": "Reboot the SoraCam compatible camera device.", "id": "ad7f5a5e-9954-4e37-a465-8a029cd7203a", "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}}/sora_cam/devices/:device_id/reboot", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "reboot" ], "variable": [ { "id": "af6a6719-d034-493b-9634-9c7f3148a829", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Reboot the SoraCam compatible camera device." }, "response": [ { "id": "62c4a136-c45a-467c-bdb7-f44f11a689b2", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/reboot", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "reboot" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-62c4a136-c45a-467c-bdb7-f44f11a689b2" }, { "id": "745e05b2-7841-41d5-8507-39e40ab47d3f", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/reboot", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "reboot" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-745e05b2-7841-41d5-8507-39e40ab47d3f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ad7f5a5e-9954-4e37-a465-8a029cd7203a" } ], "id": "1eb72025-e9c2-4e3d-8667-651dee8cd573", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1eb72025-e9c2-4e3d-8667-651dee8cd573" }, { "name": "recordings_and_events", "item": [ { "name": "Retrieve a list of recording periods and events for a SoraCam compatible camera device", "id": "72f27930-bf99-488f-ae56-82eb7d6de7f7", "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}}/sora_cam/devices/:device_id/recordings_and_events?last_evaluated_key=&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "recordings_and_events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Start time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest time within the retention period of the license that is assigned to the SoraCam compatible camera device.", "key": "from", "value": "" }, { "description": "End time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Recordings and events list sort order.\n\n- `desc`: Descending order (newest data first).\n- `asc`: Ascending order (oldest data first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "id": "8f6712ba-6550-47d8-92bb-082c589039d3", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Returns a list of recordings and events for a SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "318ffa5a-db93-4dc6-9c2a-bc2a6e0fe75d", "name": "OK.", "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}}/sora_cam/devices/:device_id/recordings_and_events?last_evaluated_key=&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "recordings_and_events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Start time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest time within the retention period of the license that is assigned to the SoraCam compatible camera device.", "key": "from", "value": "" }, { "description": "End time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Recordings and events list sort order.\n\n- `desc`: Descending order (newest data first).\n- `asc`: Ascending order (oldest data first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"events\": [\n {\n \"startTime\": \"\",\n \"type\": \"motion\",\n \"endTime\": \"\"\n },\n {\n \"startTime\": \"\",\n \"type\": \"sound\",\n \"endTime\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-318ffa5a-db93-4dc6-9c2a-bc2a6e0fe75d" }, { "id": "c4e0656b-372c-462d-a19b-0f0afd1d7492", "name": "The specified argument is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/recordings_and_events?last_evaluated_key=&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "recordings_and_events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Start time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest time within the retention period of the license that is assigned to the SoraCam compatible camera device.", "key": "from", "value": "" }, { "description": "End time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Recordings and events list sort order.\n\n- `desc`: Descending order (newest data first).\n- `asc`: Ascending order (oldest data first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c4e0656b-372c-462d-a19b-0f0afd1d7492" }, { "id": "185a5a07-e321-4aff-98a6-a82126fc976a", "name": "The specified SoraCam compatible camera device, or the recordings for the specified period, could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/recordings_and_events?last_evaluated_key=&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "recordings_and_events" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Start time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest time within the retention period of the license that is assigned to the SoraCam compatible camera device.", "key": "from", "value": "" }, { "description": "End time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Recordings and events list sort order.\n\n- `desc`: Descending order (newest data first).\n- `asc`: Ascending order (oldest data first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-185a5a07-e321-4aff-98a6-a82126fc976a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-72f27930-bf99-488f-ae56-82eb7d6de7f7" } ], "id": "1d24c506-6d56-4bee-9e22-a4fe0b1d3227", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1d24c506-6d56-4bee-9e22-a4fe0b1d3227" }, { "name": "stream", "item": [ { "name": "Get information for streaming recorded video from the cloud.", "id": "641fc154-fec1-44e4-a396-52faf495e7bc", "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}}/sora_cam/devices/:device_id/stream?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "stream" ], "query": [ { "description": "Start time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n", "key": "from", "value": "" }, { "description": "End time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n- The maximum duration that can be viewed in a single API call is 900 seconds (15 minutes). Make sure the difference between `from` and `to` does not exceed 900 seconds.\n", "key": "to", "value": "" } ], "variable": [ { "id": "33f03ebd-6a27-45ae-a628-4af5e7c3c27d", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Get information for streaming recorded video from the cloud. Specifically, you can get an array of URLs that support a streaming method called MPEG-DASH (Dynamic Adaptive Streaming over HTTP). The URL has an expiration time.\n\n- To stream the latest video, omit both `from` and `to`. Please be aware of the following points in that case:\n - You can get a URL to stream the latest 300 seconds (5 minutes) of video based on the time of the API called. To continue watching, call the API again to get the next URL.\n - At the time of obtaining the URL, 5 minutes of the available video viewing time (72 hours per month by default) will be consumed regardless of the viewing status.\n- To stream recorded video at a specific point in time, specify either `from` or `to`. Please be aware of the following points:\n - You can get a URL to stream up to 900 seconds (15 minutes) of recorded video.\n - At the time of obtaining the URL, the available video viewing time (72 hours per month by default) will be consumed regardless of the viewing status.\n\n**Warning**: **Latest video** refers to the most recent recorded footage saved in the cloud. This API cannot be used to play **Live streaming video** that can be played on the ATOM app. To view **Live streaming video**, use real-time access (Early access).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "54ea1771-803f-454d-81df-bb988f54ef29", "name": "Successfully retrieved streaming video 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}}/sora_cam/devices/:device_id/stream?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "stream" ], "query": [ { "description": "Start time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n", "key": "from", "value": "" }, { "description": "End time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n- The maximum duration that can be viewed in a single API call is 900 seconds (15 minutes). Make sure the difference between `from` and `to` does not exceed 900 seconds.\n", "key": "to", "value": "" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"expiryTime\": \"\",\n \"playList\": [\n {\n \"url\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n },\n {\n \"url\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-54ea1771-803f-454d-81df-bb988f54ef29" }, { "id": "be0c5449-e0b2-46eb-a4c7-ed6b104c42c5", "name": "Invalid parameters. Check that from/to values are valid timestamps and time range does not exceed 900 seconds.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/stream?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "stream" ], "query": [ { "description": "Start time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n", "key": "from", "value": "" }, { "description": "End time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n- The maximum duration that can be viewed in a single API call is 900 seconds (15 minutes). Make sure the difference between `from` and `to` does not exceed 900 seconds.\n", "key": "to", "value": "" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-be0c5449-e0b2-46eb-a4c7-ed6b104c42c5" }, { "id": "b362505f-a8d5-4d8d-b1ec-3487e922f1c1", "name": "The specified SoraCam compatible camera device could not be found or has no recorded video for the specified time range.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/stream?from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "stream" ], "query": [ { "description": "Start time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n", "key": "from", "value": "" }, { "description": "End time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n- The maximum duration that can be viewed in a single API call is 900 seconds (15 minutes). Make sure the difference between `from` and `to` does not exceed 900 seconds.\n", "key": "to", "value": "" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b362505f-a8d5-4d8d-b1ec-3487e922f1c1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-641fc154-fec1-44e4-a396-52faf495e7bc" } ], "id": "06f1731a-5958-4f11-ad2b-4788b8517188", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-06f1731a-5958-4f11-ad2b-4788b8517188" }, { "name": "videos", "item": [ { "name": "exports", "item": [ { "name": "{export_id}", "item": [ { "name": "Get the current status of the process of exporting recorded video taken with a SoraCam compatible camera device", "id": "1d54e246-f27e-4598-8bb5-eaff0df0d4d5", "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}}/sora_cam/devices/:device_id/videos/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports", ":export_id" ], "variable": [ { "id": "82c580b5-d2e3-455f-a1b3-cd82aed5c595", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "48ae022c-5ed7-4071-8bd1-4bbeac587b37", "key": "export_id", "value": "", "description": "(Required) Export ID of the target export operation." } ] }, "description": "Gets the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one export process.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "04c1274c-d87c-4778-9eda-64615d7c728a", "name": "OK.", "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}}/sora_cam/devices/:device_id/videos/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports", ":export_id" ], "variable": [ { "key": "device_id" }, { "key": "export_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"processing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-04c1274c-d87c-4778-9eda-64615d7c728a" }, { "id": "c350c199-1986-40aa-bcf3-8057656bde7d", "name": "The specified SoraCam compatible camera device or export process could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports", ":export_id" ], "variable": [ { "key": "device_id" }, { "key": "export_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c350c199-1986-40aa-bcf3-8057656bde7d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1d54e246-f27e-4598-8bb5-eaff0df0d4d5" } ], "id": "c04146f1-101e-424f-87de-2b5dab2e9bd2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c04146f1-101e-424f-87de-2b5dab2e9bd2" }, { "name": "Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.", "id": "3e716092-7632-4096-b387-072400b8b23b", "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}}/sora_cam/devices/:device_id/videos/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "id": "f133a0fd-e368-40d3-817f-a99ba5cd0ae3", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Gets the list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one SoraCam compatible camera device.\n\nIf the target is not limited to one SoraCam compatible camera device, but all SoraCam compatible camera devices owned by the operator, use [SoraCam:listSoraCamDeviceVideoExports API](#!/SoraCam/listSoraCamDeviceVideoExports).\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime`. Additionally, over time, it will be removed from the list.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "dcf03d0a-4b85-47b1-96cf-54d845ad5835", "name": "OK.", "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}}/sora_cam/devices/:device_id/videos/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"retrying\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dcf03d0a-4b85-47b1-96cf-54d845ad5835" }, { "id": "51da3ff1-55bf-477a-a54f-18c35ffe5049", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports?last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "query": [ { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-51da3ff1-55bf-477a-a54f-18c35ffe5049" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3e716092-7632-4096-b387-072400b8b23b" }, { "name": "Start the process of exporting recorded video saved on the cloud", "id": "cd95e12a-d41d-449e-ba79-c80f95c95268", "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 \"from\": \"\",\n \"to\": \"\",\n \"archive\": true,\n \"audioCodec\": \"pcm_s16le\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "variable": [ { "id": "ef473601-2ffb-4aae-9e6b-a4ae2ca465a3", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Starts the process of exporting recorded video saved on the cloud in a format that can be downloaded (zipped mp4 files). The export process is processed asynchronously. The progress of the export process and the URL of the exported file can be obtained with the [SoraCam:listSoraCamDeviceVideoExports API](#!/SoraCam/listSoraCamDeviceVideoExports). The URL has an expiration time.\n\n- The maximum export time for a single URL is 900 seconds (15 minutes).\n- At the time of obtaining the URL, the available video viewing time (72 hours per month by default) will be consumed regardless of whether the download has started or not.\n- Exporting results are not cached. If you export the same time twice, it will consume twice the available video viewing time (72 hours per month by default).\n- Exporting to Harvest Files will incur costs according to Harvest Files fees, and files will be retained for a period according to the Harvest Files retention period. For details, refer to [Pricing & Fee Schedule](/en/docs/reference/fees/#soracom-harvest-files).\n\n**Warning**: Recordings from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection \"Unlimited\" Recording License cannot be exported.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. Additionally, to export to Harvest Files, the [FileEntry:putFile API](#/FileEntry/putFile) permission must be granted. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "97a13d90-5985-453d-9c9a-ce2c68a2bedb", "name": "OK.", "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 \"from\": \"\",\n \"to\": \"\",\n \"archive\": true,\n \"audioCodec\": \"pcm_s16le\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"processing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-97a13d90-5985-453d-9c9a-ce2c68a2bedb" }, { "id": "543ce16f-7dde-4833-9d3a-ff71dfbfa524", "name": "- The value specified for `from` or `to` is invalid.\n- No exportable recordings were found in the specified time range.\n- `Content-Type: application/json` header is not specified.\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 \"from\": \"\",\n \"to\": \"\",\n \"archive\": true,\n \"audioCodec\": \"pcm_s16le\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-543ce16f-7dde-4833-9d3a-ff71dfbfa524" }, { "id": "c203e627-95fc-4545-8144-39384265c278", "name": "You do not have the required permission (FileEntry:putFile) to export to Harvest Files.", "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 \"from\": \"\",\n \"to\": \"\",\n \"archive\": true,\n \"audioCodec\": \"pcm_s16le\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c203e627-95fc-4545-8144-39384265c278" }, { "id": "36748118-b622-42b7-aab3-c9207a40cdb4", "name": "The specified SoraCam compatible camera device could not be 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 \"from\": \"\",\n \"to\": \"\",\n \"archive\": true,\n \"audioCodec\": \"pcm_s16le\",\n \"harvestFiles\": {\n \"pathPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id/videos/exports", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id", "videos", "exports" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-36748118-b622-42b7-aab3-c9207a40cdb4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cd95e12a-d41d-449e-ba79-c80f95c95268" } ], "id": "dacec16c-5843-4147-8091-b1e59f0b2fa7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dacec16c-5843-4147-8091-b1e59f0b2fa7" } ], "id": "2232a295-8c82-4a4b-a894-51e35a4ea895", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2232a295-8c82-4a4b-a894-51e35a4ea895" }, { "name": "Delete the SoraCam compatible camera device identified by device_id.", "id": "ed18a262-2fbc-45bf-a72b-5e767c7271aa", "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}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "id": "a55beb7d-45cb-487d-ae8a-0826683e956d", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Delete a SoraCam compatible camera device from the operator identified by device_id.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "92500541-df03-4357-835b-cf4eb744acb3", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-92500541-df03-4357-835b-cf4eb744acb3" }, { "id": "89ea2eaf-7dc1-4220-9ca2-3cfc14cefcb9", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-89ea2eaf-7dc1-4220-9ca2-3cfc14cefcb9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ed18a262-2fbc-45bf-a72b-5e767c7271aa" }, { "name": "Get the SoraCam compatible camera device information identified by device_id.", "id": "0191b9e5-5ddd-4fc8-950e-42d47e033856", "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}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "id": "8f06c9df-cc95-4220-8013-495a3cb150af", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Obtain a SoraCam compatible camera device record for the device identified by device_id.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "bb7a8259-bfab-4d18-b38b-41cfc2e30053", "name": "OK.", "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}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceId\": \"\",\n \"name\": \"\",\n \"firmwareVersion\": \"\",\n \"productDisplayName\": \"\",\n \"powerState\": \"sleep\",\n \"appliedLicenses\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"configuration\": {\n \"audioAlarmEnabled\": \"\",\n \"motionDetectionEnabled\": \"\",\n \"smokeAlarmEnabled\": \"\"\n },\n \"connected\": \"\",\n \"deviceCategory\": \"\",\n \"isShared\": \"\",\n \"lastConnectedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bb7a8259-bfab-4d18-b38b-41cfc2e30053" }, { "id": "57477eb1-a1f3-4e14-847f-12d42fc9cb74", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-57477eb1-a1f3-4e14-847f-12d42fc9cb74" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0191b9e5-5ddd-4fc8-950e-42d47e033856" } ], "id": "620dd076-9c71-4003-bc57-86c789d11e09", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-620dd076-9c71-4003-bc57-86c789d11e09" }, { "name": "atom_cam", "item": [ { "name": "firmware", "item": [ { "name": "updates", "item": [ { "name": "Retrieve a list of SoraCam compatible camera devices that can update the firmware", "id": "8ce08c7f-6706-41e6-8b0d-29a63be78593", "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}}/sora_cam/devices/atom_cam/firmware/updates", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "atom_cam", "firmware", "updates" ] }, "description": "Returns a list of SoraCam compatible camera devices that can update the firmware.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "34a84f98-841a-4c55-9705-8a548f191cad", "name": "OK.", "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}}/sora_cam/devices/atom_cam/firmware/updates", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "atom_cam", "firmware", "updates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceId\": \"\",\n \"firmwareVersion\": \"\",\n \"timeout\": \"\"\n },\n {\n \"deviceId\": \"\",\n \"firmwareVersion\": \"\",\n \"timeout\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-34a84f98-841a-4c55-9705-8a548f191cad" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8ce08c7f-6706-41e6-8b0d-29a63be78593" } ], "id": "3aad43be-aeb1-4147-a7d1-0e32378f14bb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3aad43be-aeb1-4147-a7d1-0e32378f14bb" } ], "id": "c10d61c2-840e-42a0-b84b-92fd1f920f43", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c10d61c2-840e-42a0-b84b-92fd1f920f43" } ], "id": "e719f056-cba2-4637-9fa4-68bf5663a37a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e719f056-cba2-4637-9fa4-68bf5663a37a" }, { "name": "events", "item": [ { "name": "List SoraCam events.", "id": "3675afda-e7f4-49c2-9894-355951e596d3", "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}}/sora_cam/devices/events?device_id=&last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "events" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, retrieves event history for all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ] }, "description": "Returns list of SoraCam events." }, "response": [ { "id": "658bda36-5a0f-45b1-a485-3f40f6b6cfb1", "name": "OK.", "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}}/sora_cam/devices/events?device_id=&last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "events" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, retrieves event history for all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceId\": \"\",\n \"eventId\": \"\",\n \"time\": \"\",\n \"deviceType\": \"\",\n \"eventInfo\": {\n \"infoType\": \"\",\n \"atomEventV1\": {\n \"endTime\": \"\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"movie\": \"\",\n \"picture\": \"\",\n \"recordingStatus\": \"recording\",\n \"startTime\": \"\",\n \"type\": \"sound\"\n }\n }\n },\n {\n \"deviceId\": \"\",\n \"eventId\": \"\",\n \"time\": \"\",\n \"deviceType\": \"\",\n \"eventInfo\": {\n \"infoType\": \"\",\n \"atomEventV1\": {\n \"endTime\": \"\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"movie\": \"\",\n \"picture\": \"\",\n \"recordingStatus\": \"completed\",\n \"startTime\": \"\",\n \"type\": \"motion\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-658bda36-5a0f-45b1-a485-3f40f6b6cfb1" }, { "id": "1da18aa7-afc3-4be3-9594-998a2a4b590b", "name": "The specified value is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/events?device_id=&last_evaluated_key=&limit=10&from=&to=&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "events" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, retrieves event history for all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit.", "key": "limit", "value": "10" }, { "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time.", "key": "from", "value": "" }, { "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time.", "key": "to", "value": "" }, { "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by SoraCam compatible camera device first).\n", "key": "sort", "value": "desc" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1da18aa7-afc3-4be3-9594-998a2a4b590b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3675afda-e7f4-49c2-9894-355951e596d3" } ], "id": "1fe31c94-0af6-4aee-bbca-9aca1cd13bdf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1fe31c94-0af6-4aee-bbca-9aca1cd13bdf" }, { "name": "images", "item": [ { "name": "exports", "item": [ { "name": "Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.", "id": "74d31f7a-ef75-4b67-bd14-ac310d156af1", "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}}/sora_cam/devices/images/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "images", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] }, "description": "Gets the list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API can target all devices owned by the operator, or limit it to one SoraCam compatible camera device.\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime`. Additionally, over time, it will be removed from the list.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "ce7b012d-3077-496b-8f5e-d53955059e8b", "name": "A list of image export processes.", "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}}/sora_cam/devices/images/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "images", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"failed\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ce7b012d-3077-496b-8f5e-d53955059e8b" }, { "id": "68bb5d3b-e15f-4cfe-9af5-22d33ba97010", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/images/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "images", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-68bb5d3b-e15f-4cfe-9af5-22d33ba97010" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-74d31f7a-ef75-4b67-bd14-ac310d156af1" } ], "id": "7fa211ab-90dc-47ae-9497-8acb0b0adb9d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7fa211ab-90dc-47ae-9497-8acb0b0adb9d" } ], "id": "0c8809a5-3cc7-459f-b066-53dacfb3c850", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0c8809a5-3cc7-459f-b066-53dacfb3c850" }, { "name": "videos", "item": [ { "name": "exports", "item": [ { "name": "Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.", "id": "a52ccc4a-8632-4359-99b1-fd0fa94bbacd", "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}}/sora_cam/devices/videos/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "videos", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] }, "description": "Gets the list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API can target all devices owned by the operator, or limit it to one SoraCam compatible camera device.\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime`. Additionally, over time, it will be removed from the list.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "b1b2b379-a580-4683-b5c1-a6f0676719e0", "name": "A list of video export processes.", "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}}/sora_cam/devices/videos/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "videos", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"retrying\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b1b2b379-a580-4683-b5c1-a6f0676719e0" }, { "id": "a74c2c2b-3d08-4cb2-aef1-f77f772432e6", "name": "The specified SoraCam compatible camera device could not be found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/devices/videos/exports?device_id=&last_evaluated_key=&limit=10&sort=desc", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices", "videos", "exports" ], "query": [ { "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator.", "key": "device_id", "value": "" }, { "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination.", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit.", "key": "limit", "value": "10" }, { "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n", "key": "sort", "value": "desc" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a74c2c2b-3d08-4cb2-aef1-f77f772432e6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a52ccc4a-8632-4359-99b1-fd0fa94bbacd" } ], "id": "9638736d-63ef-46d4-93c7-d59306c7425d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9638736d-63ef-46d4-93c7-d59306c7425d" } ], "id": "ddd6cb08-2a1f-4957-92f7-61648a4d4aa8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ddd6cb08-2a1f-4957-92f7-61648a4d4aa8" }, { "name": "List SoraCam compatible camera devices.", "id": "46c1fa68-6988-4883-a7b1-a08f61879801", "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}}/sora_cam/devices", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices" ] }, "description": "Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, "response": [ { "id": "10b2b960-f69b-44fa-80cb-8f0b803f9018", "name": "A list of SoraCam compatible camera devices.", "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}}/sora_cam/devices", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "devices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceId\": \"\",\n \"name\": \"\",\n \"firmwareVersion\": \"\",\n \"productDisplayName\": \"\",\n \"powerState\": \"sleep\",\n \"appliedLicenses\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"configuration\": {\n \"audioAlarmEnabled\": \"\",\n \"motionDetectionEnabled\": \"\",\n \"smokeAlarmEnabled\": \"\"\n },\n \"connected\": \"\",\n \"deviceCategory\": \"\",\n \"isShared\": \"\",\n \"lastConnectedTime\": \"\"\n },\n {\n \"deviceId\": \"\",\n \"name\": \"\",\n \"firmwareVersion\": \"\",\n \"productDisplayName\": \"\",\n \"powerState\": \"sleep\",\n \"appliedLicenses\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"configuration\": {\n \"audioAlarmEnabled\": \"\",\n \"motionDetectionEnabled\": \"\",\n \"smokeAlarmEnabled\": \"\"\n },\n \"connected\": \"\",\n \"deviceCategory\": \"\",\n \"isShared\": \"\",\n \"lastConnectedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-10b2b960-f69b-44fa-80cb-8f0b803f9018" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-46c1fa68-6988-4883-a7b1-a08f61879801" } ], "id": "43fe8425-2549-435f-9e56-99b98688d237", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-43fe8425-2549-435f-9e56-99b98688d237" }, { "name": "license_packs", "item": [ { "name": "{license_pack_id}", "item": [ { "name": "quantity", "item": [ { "name": "Update the license quantity of Soracom Cloud Camera Services", "id": "b8291639-16de-4b87-bdda-7dd25c6f6cde", "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" } ], "body": { "mode": "raw", "raw": "{\n \"currentQuantity\": \"\",\n \"desiredQuantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/license_packs/:license_pack_id/quantity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs", ":license_pack_id", "quantity" ], "variable": [ { "id": "00407285-6e3d-4155-9529-25ff1b890a19", "key": "license_pack_id", "value": "", "description": "(Required) ID of the license pack." } ] }, "description": "Updates the license quantity for the license pack identified by license_pack_id. This operation will cost you monthly fee based on number of licenses. Currently, this API is only available for Japan coverage." }, "response": [ { "id": "192fcb9f-3028-4176-a8a1-0712ed850061", "name": "The license quantity was updated.", "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 \"currentQuantity\": \"\",\n \"desiredQuantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/license_packs/:license_pack_id/quantity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs", ":license_pack_id", "quantity" ], "variable": [ { "key": "license_pack_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-192fcb9f-3028-4176-a8a1-0712ed850061" }, { "id": "b31a6a06-90ef-4aad-a828-13dcde303602", "name": "The updating request is invalid.", "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 \"currentQuantity\": \"\",\n \"desiredQuantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sora_cam/license_packs/:license_pack_id/quantity", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs", ":license_pack_id", "quantity" ], "variable": [ { "key": "license_pack_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b31a6a06-90ef-4aad-a828-13dcde303602" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b8291639-16de-4b87-bdda-7dd25c6f6cde" } ], "id": "da0e5bd7-7b4e-420f-93f8-2d2d3a8c6d2c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-da0e5bd7-7b4e-420f-93f8-2d2d3a8c6d2c" } ], "id": "3c518f9c-82c2-49cb-85de-68ad9f35f7c4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3c518f9c-82c2-49cb-85de-68ad9f35f7c4" }, { "name": "List license packs of Soracom Cloud Camera Services", "id": "6985a59b-dbf6-4f89-ab38-98df886bcd37", "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}}/sora_cam/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs" ] }, "description": "Returns the list of license packs which you can use. Currently, this API is only available for Japan coverage." }, "response": [ { "id": "74ea2907-2d8c-4704-a6c8-4aada3930fa6", "name": "The license pack list was returned.", "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}}/sora_cam/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"quantity\": \"\",\n \"quantityInUse\": \"\",\n \"salesChannel\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"quantity\": \"\",\n \"quantityInUse\": \"\",\n \"salesChannel\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-74ea2907-2d8c-4704-a6c8-4aada3930fa6" }, { "id": "2dcd5d7e-334c-40bd-8871-a2ea1ee4ab06", "name": "The request is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/sora_cam/license_packs", "host": [ "{{baseUrl}}" ], "path": [ "sora_cam", "license_packs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2dcd5d7e-334c-40bd-8871-a2ea1ee4ab06" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6985a59b-dbf6-4f89-ab38-98df886bcd37" } ], "id": "eb8c4452-1b54-49de-b835-71b30780a034", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eb8c4452-1b54-49de-b835-71b30780a034" } ], "id": "3e6a1071-cf81-474e-b5da-2ee738cf1975", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3e6a1071-cf81-474e-b5da-2ee738cf1975" }, { "name": "soralets", "item": [ { "name": "{soralet_id}", "item": [ { "name": "logs", "item": [ { "name": "Get log messages from Soralet", "id": "84c45155-ebf8-43df-ac71-a0ce5092cba2", "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}}/soralets/:soralet_id/logs?sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "logs" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last log message retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next log message onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "f4964932-f203-4f0a-9ed4-03e7d480a362", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Returns a list of log messages from the specified Soralet." }, "response": [ { "id": "445de044-fb29-4e73-9990-4fb7fadc3434", "name": "OK.", "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}}/soralets/:soralet_id/logs?sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "logs" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last log message retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next log message onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "soralet_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createdTime\": \"\",\n \"message\": \"\",\n \"operatorId\": \"\",\n \"soraletId\": \"\",\n \"version\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"message\": \"\",\n \"operatorId\": \"\",\n \"soraletId\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-445de044-fb29-4e73-9990-4fb7fadc3434" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-84c45155-ebf8-43df-ac71-a0ce5092cba2" } ], "id": "f36740b0-9ca3-4b90-9e48-6aae9f8ae05d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f36740b0-9ca3-4b90-9e48-6aae9f8ae05d" }, { "name": "test", "item": [ { "name": "Execute Soralet with arguments", "id": "80503aab-001a-4caf-978f-470064a90589", "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 \"version\": \"\",\n \"direction\": \"downlink\",\n \"contentType\": \"\",\n \"payload\": \"\",\n \"source\": {\n \"nostrud58\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n },\n \"occaecatd\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n },\n \"non3a\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n }\n },\n \"encodingType\": \"binary\",\n \"userdata\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/test", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "test" ], "variable": [ { "id": "0c6d580b-0e09-40d0-8f21-c604fe7e08e2", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Execute the specified Soralet with the specified arguments." }, "response": [ { "id": "f315916d-0659-4b6f-b182-ae92065dd45d", "name": "OK.", "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 \"version\": \"\",\n \"direction\": \"downlink\",\n \"contentType\": \"\",\n \"payload\": \"\",\n \"source\": {\n \"nostrud58\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n },\n \"occaecatd\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n },\n \"non3a\": {\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n }\n },\n \"encodingType\": \"binary\",\n \"userdata\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/test", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "test" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"body\": \"\",\n \"contentType\": \"\",\n \"encodingType\": \"\",\n \"resultCode\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f315916d-0659-4b6f-b182-ae92065dd45d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-80503aab-001a-4caf-978f-470064a90589" } ], "id": "504deef5-06b8-4df5-91b6-46e242985c7d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-504deef5-06b8-4df5-91b6-46e242985c7d" }, { "name": "versions", "item": [ { "name": "{version}", "item": [ { "name": "Delete a Soralet version", "id": "84079296-365b-401b-99a4-fe1fb7278e8c", "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}}/soralets/:soralet_id/versions/:version", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions", ":version" ], "variable": [ { "id": "6c0a6d17-9ec3-4574-b4f5-c5694852eca9", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." }, { "id": "63e259fc-6732-469b-a358-b045f2686e64", "key": "version", "value": "", "description": "(Required) Soralet version." } ] }, "description": "Delete the specified Soralet version." }, "response": [ { "id": "78f48c97-362d-4339-b30e-b41e8e121062", "name": "Successfully deleted the specified Soralet version.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/versions/:version", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions", ":version" ], "variable": [ { "key": "soralet_id" }, { "key": "version" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-78f48c97-362d-4339-b30e-b41e8e121062" }, { "id": "c1cdce9f-26c0-44b0-9916-e0b1c0420e08", "name": "The specified Soralet version is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/versions/:version", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions", ":version" ], "variable": [ { "key": "soralet_id" }, { "key": "version" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c1cdce9f-26c0-44b0-9916-e0b1c0420e08" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-84079296-365b-401b-99a4-fe1fb7278e8c" } ], "id": "be594556-8cd8-4cda-a647-0534210a9225", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-be594556-8cd8-4cda-a647-0534210a9225" }, { "name": "List versions of Soralet", "id": "90ef07fd-cc64-41a0-9733-b15877f86ae2", "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}}/soralets/:soralet_id/versions?sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last version retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next version onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "f82045b9-769d-4594-a1e0-add74410f553", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Returns a list of Soralet versions." }, "response": [ { "id": "ac037e01-ce25-4d4b-b0ea-029e64a99c7c", "name": "OK.", "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}}/soralets/:soralet_id/versions?sort=desc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "desc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last version retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next version onward.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "soralet_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"createdTime\": \"\",\n \"hash\": \"\",\n \"operatorId\": \"\",\n \"size\": \"\",\n \"soraletId\": \"\",\n \"srn\": \"\",\n \"version\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"hash\": \"\",\n \"operatorId\": \"\",\n \"size\": \"\",\n \"soraletId\": \"\",\n \"srn\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ac037e01-ce25-4d4b-b0ea-029e64a99c7c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-90ef07fd-cc64-41a0-9733-b15877f86ae2" }, { "name": "Upload code and create a new version", "id": "8c6156bb-61cb-4568-8456-97e0dcdbfb62", "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": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions" ], "variable": [ { "id": "64516307-935e-403d-bdf0-3bab6dcbced4", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Upload code and create a new version." }, "response": [ { "id": "eb9e1c5a-fe87-4375-bbbd-40b32cdabc00", "name": "Successfully created a new version.", "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": "file", "file": {}, "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets/:soralet_id/versions", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id", "versions" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"hash\": \"\",\n \"operatorId\": \"\",\n \"size\": \"\",\n \"soraletId\": \"\",\n \"srn\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-eb9e1c5a-fe87-4375-bbbd-40b32cdabc00" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8c6156bb-61cb-4568-8456-97e0dcdbfb62" } ], "id": "de0b563e-a207-425b-913b-fda4d63d2440", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-de0b563e-a207-425b-913b-fda4d63d2440" }, { "name": "Delete Soralet", "id": "c6d789e4-bd0c-4937-a4ca-ea9c9ccc5d46", "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}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "id": "0646349b-d23e-412e-9743-1b4076d2a473", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Delete the specified Soralet." }, "response": [ { "id": "80ee2f59-280c-4476-a759-d789c69b7b63", "name": "Successfully deleted the specified Soralet.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-80ee2f59-280c-4476-a759-d789c69b7b63" }, { "id": "0584e0b4-a84a-4ebe-872d-340d31518673", "name": "The specified Soralet is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0584e0b4-a84a-4ebe-872d-340d31518673" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c6d789e4-bd0c-4937-a4ca-ea9c9ccc5d46" }, { "name": "Get a Soralet", "id": "0e874769-9330-4de9-ae2c-976a25d69abf", "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}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "id": "5b01b9bc-c05d-4b12-9822-6046fe34ca96", "key": "soralet_id", "value": "", "description": "(Required) The identifier of Soralet." } ] }, "description": "Returns a Soralet." }, "response": [ { "id": "9b111645-8f21-42f2-84d3-f6df0b4db898", "name": "OK.", "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}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdTime\": \"\",\n \"description\": \"\",\n \"operatorId\": \"\",\n \"soraletId\": \"\",\n \"updatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9b111645-8f21-42f2-84d3-f6df0b4db898" }, { "id": "e253a0b6-c46d-4067-88f6-d397c33e8066", "name": "The specified Soralet is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/soralets/:soralet_id", "host": [ "{{baseUrl}}" ], "path": [ "soralets", ":soralet_id" ], "variable": [ { "key": "soralet_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e253a0b6-c46d-4067-88f6-d397c33e8066" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0e874769-9330-4de9-ae2c-976a25d69abf" } ], "id": "7eccd125-80fc-4d11-902b-9006cb19e5be", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7eccd125-80fc-4d11-902b-9006cb19e5be" }, { "name": "List Soralets", "id": "448e7f11-63fa-4a10-b1e7-15d535455902", "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}}/soralets?sort=asc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "asc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last Soralet retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Soralet onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of Soralets." }, "response": [ { "id": "e95d6b14-caee-4648-862a-4ac1a71d2cc3", "name": "OK.", "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}}/soralets?sort=asc&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "soralets" ], "query": [ { "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).", "key": "sort", "value": "asc" }, { "description": "The maximum number of items in a response.", "key": "limit", "value": "" }, { "description": "The identifier of the last Soralet retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Soralet 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 \"createdTime\": \"\",\n \"description\": \"\",\n \"operatorId\": \"\",\n \"soraletId\": \"\",\n \"updatedTime\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"operatorId\": \"\",\n \"soraletId\": \"\",\n \"updatedTime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e95d6b14-caee-4648-862a-4ac1a71d2cc3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-448e7f11-63fa-4a10-b1e7-15d535455902" }, { "name": "Create a Soralet", "id": "47077d38-64f9-4aa4-971b-1ecc12bf89f1", "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" } ], "body": { "mode": "raw", "raw": "{\n \"soraletId\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets", "host": [ "{{baseUrl}}" ], "path": [ "soralets" ] }, "description": "Create a Soralet." }, "response": [ { "id": "3f31cf0a-d730-483b-b980-c33e08e9c40e", "name": "Successfully created a new Soralet.", "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 \"soraletId\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets", "host": [ "{{baseUrl}}" ], "path": [ "soralets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3f31cf0a-d730-483b-b980-c33e08e9c40e" }, { "id": "1fa27e99-f218-4f16-a41b-652b6fbe6464", "name": "The specified Soralet already exists or the specified soralet_id was 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 \"soraletId\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/soralets", "host": [ "{{baseUrl}}" ], "path": [ "soralets" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1fa27e99-f218-4f16-a41b-652b6fbe6464" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-47077d38-64f9-4aa4-971b-1ecc12bf89f1" } ], "id": "b668bde2-25b6-4a9d-912f-5f50dee06b34", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b668bde2-25b6-4a9d-912f-5f50dee06b34" }, { "name": "stats", "item": [ { "name": "air", "item": [ { "name": "groups", "item": [ { "name": "{group_id}", "item": [ { "name": "Get Air Usage Report of a Group.", "id": "c1f9f4c9-82a4-4314-ad77-a0a6db8610db", "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}}/stats/air/groups/:group_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "groups", ":group_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "id": "9af9339a-8d88-490e-843d-f6188248c7fb", "key": "group_id", "value": "", "description": "(Required) Group ID" } ] }, "description": "Retrieves the usage report aggregating all SIMs that belong to the specified Group." }, "response": [ { "id": "04b5a735-249b-440a-a23e-8db0887b9fac", "name": "OK.", "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}}/stats/air/groups/:group_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "groups", ":group_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"downloadByteSizeTotal\": \"\",\n \"unixtime\": \"\",\n \"uploadByteSizeTotal\": \"\"\n },\n {\n \"downloadByteSizeTotal\": \"\",\n \"unixtime\": \"\",\n \"uploadByteSizeTotal\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-04b5a735-249b-440a-a23e-8db0887b9fac" }, { "id": "7dff2ec4-7968-48e5-83bf-122dbf3bcce1", "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}}/stats/air/groups/:group_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "groups", ":group_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "key": "group_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7dff2ec4-7968-48e5-83bf-122dbf3bcce1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c1f9f4c9-82a4-4314-ad77-a0a6db8610db" } ], "id": "b8c2c978-6639-4bec-9471-a9948d97cde6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b8c2c978-6639-4bec-9471-a9948d97cde6" } ], "id": "acbb1c89-c914-4a33-a5fb-d0d9e97160f8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-acbb1c89-c914-4a33-a5fb-d0d9e97160f8" }, { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "export", "item": [ { "name": "Export Air Usage Report of All Subscribers", "id": "1dbfba44-9c84-49d3-8de4-e0b7cb7fa229", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/air/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "operators", ":operator_id", "export" ], "query": [ { "description": "Specify how to obtain the URL to download the Air Data Usage Report CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "9ed370a9-af9e-40be-8cba-e6b920999609", "key": "operator_id", "value": "", "description": "(Required) Operator ID. The operator ID can be obtained from the [Operator:getOperator API](#!/Operator/getOperator)." } ] }, "description": "Download the Air Data Traffic Actual Data CSV file that contains the usage report of all the IoT SIMs for the specified operator.\n\n**Warning**: If there is no data usage during the specified period, a CSV file with only a header row will be output.\n**Info**: You can also check the data usage of terminated IoT SIMs.\n" }, "response": [ { "id": "6bc99ca7-30f1-4ccc-9cd2-a2ffe51cd878", "name": "OK.", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/air/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "operators", ":operator_id", "export" ], "query": [ { "description": "Specify how to obtain the URL to download the Air Data Usage Report CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6bc99ca7-30f1-4ccc-9cd2-a2ffe51cd878" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1dbfba44-9c84-49d3-8de4-e0b7cb7fa229" } ], "id": "2a436714-959f-43f5-9462-79f613b18056", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2a436714-959f-43f5-9462-79f613b18056" }, { "name": "Get Air Usage Report of an Operator.", "id": "97fdd879-357f-41bb-bcec-c55c1fe46da1", "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}}/stats/air/operators/:operator_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "operators", ":operator_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "id": "cfc21ac3-fc71-4815-b2b1-5b55a379050d", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Retrieves the usage report aggregating all SIMs that belong to the specified Operator." }, "response": [ { "id": "b91351f9-977e-4859-8389-09f4e9ff8700", "name": "OK.", "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}}/stats/air/operators/:operator_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "operators", ":operator_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"downloadByteSizeTotal\": \"\",\n \"unixtime\": \"\",\n \"uploadByteSizeTotal\": \"\"\n },\n {\n \"downloadByteSizeTotal\": \"\",\n \"unixtime\": \"\",\n \"uploadByteSizeTotal\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b91351f9-977e-4859-8389-09f4e9ff8700" }, { "id": "05a15803-a66e-4410-8128-f2fcaf53312d", "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}}/stats/air/operators/:operator_id?from=&to=&period=month", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "operators", ":operator_id" ], "query": [ { "description": "(Required) Specify the start month/day of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n", "key": "period", "value": "month" } ], "variable": [ { "key": "operator_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05a15803-a66e-4410-8128-f2fcaf53312d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-97fdd879-357f-41bb-bcec-c55c1fe46da1" } ], "id": "b703da5b-65ff-49d5-9b5d-a8262e4914e5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b703da5b-65ff-49d5-9b5d-a8262e4914e5" } ], "id": "6d685780-aca0-4140-b7ce-e92632f9bea0", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6d685780-aca0-4140-b7ce-e92632f9bea0" }, { "name": "sims", "item": [ { "name": "{sim_id}", "item": [ { "name": "Get Air Usage Report of SIM.", "id": "34943f46-5bf2-41a4-918b-e25be0f1f935", "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}}/stats/air/sims/:sim_id?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "sims", ":sim_id" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "39a2a684-6c51-4d1f-96b2-323472bd6b15", "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 the usage report for the SIM specified by the SIM ID.\n\n**Warning**: The data traffic of the terminated IoT SIM cannot be confirmed.\n" }, "response": [ { "id": "8b0a5343-b538-4ebb-b953-d95f961770bd", "name": "OK.", "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}}/stats/air/sims/:sim_id?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "sims", ":sim_id" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "sim_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"dataTrafficStatsMap\": {\n \"tempor_95\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n },\n \"sit_1_\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n },\n \"dolor33\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n },\n {\n \"dataTrafficStatsMap\": {\n \"fugiat_4\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8b0a5343-b538-4ebb-b953-d95f961770bd" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-34943f46-5bf2-41a4-918b-e25be0f1f935" } ], "id": "c5ca4229-5c3b-424f-a281-61081ff38813", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c5ca4229-5c3b-424f-a281-61081ff38813" } ], "id": "5cc8ebae-1de8-4106-affc-99ebd4a45efc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5cc8ebae-1de8-4106-affc-99ebd4a45efc" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Get Air Usage Report of Subscriber.", "id": "aeebedb6-00b2-4f1b-b939-e42b265d6f87", "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}}/stats/air/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "e83b8825-5e07-4b6e-8797-d98cc486624f", "key": "imsi", "value": "", "description": "(Required) The target IMSI. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims)." } ] }, "description": "Retrieves the usage report for the subscriber specified by the IMSI.\n\n**Warning**: The data traffic of the terminated IoT SIM cannot be confirmed.\n" }, "response": [ { "id": "1f86f2d4-2e21-43a2-84af-277b23ef47d3", "name": "OK.", "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}}/stats/air/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "air", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"dataTrafficStatsMap\": {\n \"tempor_95\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n },\n \"sit_1_\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n },\n \"dolor33\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n },\n {\n \"dataTrafficStatsMap\": {\n \"fugiat_4\": {\n \"downloadByteSizeTotal\": \"\",\n \"downloadPacketSizeTotal\": \"\",\n \"uploadByteSizeTotal\": \"\",\n \"uploadPacketSizeTotal\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1f86f2d4-2e21-43a2-84af-277b23ef47d3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-aeebedb6-00b2-4f1b-b939-e42b265d6f87" } ], "id": "2e3a4daf-1d97-4db9-9a30-5bf1abb35e44", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2e3a4daf-1d97-4db9-9a30-5bf1abb35e44" } ], "id": "d5d6350c-8617-46c0-97ad-1cb7670d3369", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d5d6350c-8617-46c0-97ad-1cb7670d3369" } ], "id": "f9dd760f-27ca-4130-961e-4cf3b1282e20", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f9dd760f-27ca-4130-961e-4cf3b1282e20" }, { "name": "beam", "item": [ { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "export", "item": [ { "name": "Export Beam Usage Report of All Subscribers", "id": "501b004a-fead-4092-93ae-10a0b1f8ec34", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/beam/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "beam", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "a956621c-260b-4a52-8fa8-25aebb0848c3", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Retrieves a file containing the Soracom Beam usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, "response": [ { "id": "d2958a40-d43f-4416-b8c7-cfb35163284d", "name": "OK.", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/beam/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "beam", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d2958a40-d43f-4416-b8c7-cfb35163284d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-501b004a-fead-4092-93ae-10a0b1f8ec34" } ], "id": "802b51ee-77a6-405e-b1fc-a0b52d45bbf2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-802b51ee-77a6-405e-b1fc-a0b52d45bbf2" } ], "id": "d5a0c3d2-3db6-43a5-9e29-adb9610e93e1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d5a0c3d2-3db6-43a5-9e29-adb9610e93e1" } ], "id": "4fc65075-14e8-4dcf-a8ab-bc515914bf10", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4fc65075-14e8-4dcf-a8ab-bc515914bf10" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Get Beam Usage Report of Subscriber", "id": "d95bf99d-3ccd-4ae7-b406-e1bc189c127d", "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}}/stats/beam/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "beam", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "7493ef2a-447b-41d7-80fb-15e5ba507981", "key": "imsi", "value": "", "description": "(Required) imsi" } ] }, "description": "Retrieves the Soracom Beam usage report for the subscriber specified by the IMSI." }, "response": [ { "id": "1b301ca3-8943-451b-bdaf-8ed8bb897dda", "name": "OK.", "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}}/stats/beam/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "beam", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"beamStatsMap\": {\n \"laborum53\": {\n \"count\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n },\n {\n \"beamStatsMap\": {\n \"reprehenderitb91\": {\n \"count\": \"\"\n },\n \"dolor1e\": {\n \"count\": \"\"\n }\n },\n \"date\": \"\",\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1b301ca3-8943-451b-bdaf-8ed8bb897dda" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d95bf99d-3ccd-4ae7-b406-e1bc189c127d" } ], "id": "336b05a9-7cb7-453a-a1a0-6082aef629af", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-336b05a9-7cb7-453a-a1a0-6082aef629af" } ], "id": "d6dea4b5-ff5a-41ba-bbda-89464abc91d6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d6dea4b5-ff5a-41ba-bbda-89464abc91d6" } ], "id": "a2263cf8-fc00-413a-bf20-ac4ed78aa3ea", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2263cf8-fc00-413a-bf20-ac4ed78aa3ea" }, { "name": "funk", "item": [ { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "export", "item": [ { "name": "Export Funk Usage Report of All Subscribers", "id": "10ffc214-122f-4d30-8ccd-1880fa42e2d7", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/funk/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funk", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "81580a35-56ec-4572-b274-ae809adf5f47", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Retrieves a file containing the Soracom Funk usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, "response": [ { "id": "9420d629-61a5-43c9-a7f3-52b9887f68d8", "name": "OK.", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/funk/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funk", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9420d629-61a5-43c9-a7f3-52b9887f68d8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-10ffc214-122f-4d30-8ccd-1880fa42e2d7" } ], "id": "f5dbaf7f-b974-4055-be84-013520ceb09d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f5dbaf7f-b974-4055-be84-013520ceb09d" } ], "id": "3afc48cf-0ab5-44f0-83a2-233aa1db7022", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3afc48cf-0ab5-44f0-83a2-233aa1db7022" } ], "id": "6a21acee-e171-4b23-b7e9-c1a3fc8cc0ec", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6a21acee-e171-4b23-b7e9-c1a3fc8cc0ec" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Get Funk Usage Report of Subscriber", "id": "16021a5c-3a3e-4abd-b480-f2262983d4f2", "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}}/stats/funk/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funk", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "61b3fe51-13b5-4531-a68e-d8e5645b42cd", "key": "imsi", "value": "", "description": "(Required) imsi" } ] }, "description": "Retrieves the Soracom Funk usage report for the subscriber specified by the IMSI." }, "response": [ { "id": "63eb7952-d5c2-4490-8eac-d416c43d20a9", "name": "OK.", "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}}/stats/funk/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funk", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"funkStatsMap\": {\n \"dolore_7b3\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n },\n {\n \"funkStatsMap\": {\n \"pariatur_a3\": {\n \"count\": \"\"\n },\n \"aute__a\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-63eb7952-d5c2-4490-8eac-d416c43d20a9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-16021a5c-3a3e-4abd-b480-f2262983d4f2" } ], "id": "36b31fc5-75be-4a90-8438-6c7b19bb8306", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-36b31fc5-75be-4a90-8438-6c7b19bb8306" } ], "id": "397d24b8-72fc-4a30-9456-d9439f010d04", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-397d24b8-72fc-4a30-9456-d9439f010d04" } ], "id": "267e62de-51d5-4f74-b090-351b7a3c1af6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-267e62de-51d5-4f74-b090-351b7a3c1af6" }, { "name": "funnel", "item": [ { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "export", "item": [ { "name": "Export Funnel Usage Report of All Subscribers", "id": "e2187e61-4c35-40c0-a8e2-bb2db24d6283", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/funnel/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funnel", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "fb5cad22-7f30-43f0-97cd-f4d3113e2318", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Retrieves a file containing the Soracom Funnel usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, "response": [ { "id": "e91e3ca3-0a38-4dfe-a999-e3337ef9ae93", "name": "OK.", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/funnel/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funnel", "operators", ":operator_id", "export" ], "query": [ { "description": "export_mode (async, sync)", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e91e3ca3-0a38-4dfe-a999-e3337ef9ae93" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e2187e61-4c35-40c0-a8e2-bb2db24d6283" } ], "id": "96a0276d-0574-4bbe-bea5-2d075b07b431", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-96a0276d-0574-4bbe-bea5-2d075b07b431" } ], "id": "118bf5fc-29a0-4d66-9c79-98188b78c343", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-118bf5fc-29a0-4d66-9c79-98188b78c343" } ], "id": "178fd8cb-8c8d-42c7-a6a8-a17b888c62d6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-178fd8cb-8c8d-42c7-a6a8-a17b888c62d6" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Get Funnel Usage Report of Subscriber", "id": "4a7149e5-8d3e-4448-9836-bdede50009b7", "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}}/stats/funnel/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funnel", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "26f7c3dc-e3cc-4526-8966-576385c36018", "key": "imsi", "value": "", "description": "(Required) imsi" } ] }, "description": "Retrieves the Soracom Funnel usage report for the subscriber specified by the IMSI." }, "response": [ { "id": "a96af113-a7a3-452d-b5ab-69c0fd17dbef", "name": "OK.", "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}}/stats/funnel/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "funnel", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"funnelStatsMap\": {\n \"nisi_c7e\": {\n \"count\": \"\"\n },\n \"proident7\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n },\n {\n \"funnelStatsMap\": {\n \"enim5_5\": {\n \"count\": \"\"\n },\n \"incididunt_9\": {\n \"count\": \"\"\n },\n \"enim_1_\": {\n \"count\": \"\"\n },\n \"aliquip_b\": {\n \"count\": \"\"\n },\n \"voluptate3\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a96af113-a7a3-452d-b5ab-69c0fd17dbef" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4a7149e5-8d3e-4448-9836-bdede50009b7" } ], "id": "742e0862-479f-4ae6-9f39-fcb48810ab9c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-742e0862-479f-4ae6-9f39-fcb48810ab9c" } ], "id": "54139067-e56b-4a7d-99bf-3e7970e3759d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-54139067-e56b-4a7d-99bf-3e7970e3759d" } ], "id": "2750b5f2-d9d5-4d0b-819c-cec697d73c22", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2750b5f2-d9d5-4d0b-819c-cec697d73c22" }, { "name": "harvest", "item": [ { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "export", "item": [ { "name": "Export Harvest Data Write Counts Report of all IoT SIMs", "id": "ebb991de-3d51-4c03-8091-4a9c9456b5db", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/harvest/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "operators", ":operator_id", "export" ], "query": [ { "description": "Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL for downloading. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL for downloading to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "id": "b6f6fc73-7b2d-4bf2-9bfc-a8f7d642ffb3", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Download the Harvest Data Write Count Results Data CSV file that contains the usage report of all the IoT SIMs for the specified operator.\n\n**Info**: You can also check the Harvest Data write counts of the terminated IoT SIM.\n" }, "response": [ { "id": "dc596e9f-f145-4e86-ba10-22a54b2d9dd3", "name": "OK.", "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 \"from\": \"\",\n \"period\": \"day\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stats/harvest/operators/:operator_id/export?export_mode=sync", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "operators", ":operator_id", "export" ], "query": [ { "description": "Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL for downloading. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL for downloading to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "sync" } ], "variable": [ { "key": "operator_id" } ] } }, "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc596e9f-f145-4e86-ba10-22a54b2d9dd3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ebb991de-3d51-4c03-8091-4a9c9456b5db" } ], "id": "e78e21a0-c251-413e-a74f-db1fe87c77e2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e78e21a0-c251-413e-a74f-db1fe87c77e2" }, { "name": "Get 'Harvest usage report' for the specified operator.", "id": "fbaa62b7-76e9-43c2-a122-bc01bf2768f7", "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}}/stats/harvest/operators/:operator_id?year_month=", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "operators", ":operator_id" ], "query": [ { "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.", "key": "year_month", "value": "" } ], "variable": [ { "id": "94168f54-0e5a-4e1b-917e-4df47d60a124", "key": "operator_id", "value": "", "description": "(Required) Operator ID" } ] }, "description": "Retrieves the Soracom Harvest usage report for the operator." }, "response": [ { "id": "1002f7dd-4c01-42a7-8ecf-25a95008c7b5", "name": "OK.", "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}}/stats/harvest/operators/:operator_id?year_month=", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "operators", ":operator_id" ], "query": [ { "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.", "key": "year_month", "value": "" } ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedBytes\": \"\",\n \"yearMonth\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1002f7dd-4c01-42a7-8ecf-25a95008c7b5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fbaa62b7-76e9-43c2-a122-bc01bf2768f7" } ], "id": "a2ad1d51-12d6-408b-8fe3-6df2662fafa7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a2ad1d51-12d6-408b-8fe3-6df2662fafa7" } ], "id": "316c2e4e-fa89-4fed-bf87-3f20bc55b696", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-316c2e4e-fa89-4fed-bf87-3f20bc55b696" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "Get Harvest Usage Report of Subscriber", "id": "4d34a3e2-b78c-4e38-adf2-ed4a00601be4", "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}}/stats/harvest/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "id": "6bec731c-9146-4fb9-a52b-0d28cc64ffa7", "key": "imsi", "value": "", "description": "(Required) imsi" } ] }, "description": "Retrieves the Soracom Harvest usage report for the subscriber specified by the IMSI." }, "response": [ { "id": "2033f8b1-8976-44a0-82eb-b43fb9f1c1c5", "name": "OK.", "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}}/stats/harvest/subscribers/:imsi?from=&to=&period=day", "host": [ "{{baseUrl}}" ], "path": [ "stats", "harvest", "subscribers", ":imsi" ], "query": [ { "description": "(Required) Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "from", "value": "" }, { "description": "(Required) Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.", "key": "to", "value": "" }, { "description": "(Required) Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n", "key": "period", "value": "day" } ], "variable": [ { "key": "imsi" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"harvestStatsMap\": {\n \"ut2\": {\n \"count\": \"\"\n },\n \"pariatur3b\": {\n \"count\": \"\"\n },\n \"non_f3\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n },\n {\n \"harvestStatsMap\": {\n \"dolor_5\": {\n \"count\": \"\"\n }\n },\n \"unixtime\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2033f8b1-8976-44a0-82eb-b43fb9f1c1c5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4d34a3e2-b78c-4e38-adf2-ed4a00601be4" } ], "id": "51b8f831-7f3a-46fd-af16-9ac89cfd60be", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-51b8f831-7f3a-46fd-af16-9ac89cfd60be" } ], "id": "02555d24-ec22-4535-b32d-a734875eb8ba", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-02555d24-ec22-4535-b32d-a734875eb8ba" } ], "id": "16165511-4529-483d-9b5b-d8678aa28f3d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-16165511-4529-483d-9b5b-d8678aa28f3d" }, { "name": "napter", "item": [ { "name": "audit_logs", "item": [ { "name": "Get Napter audit logs' monthly exported data stats.", "id": "4e0dacd0-0a3f-4b30-be11-de2c51285402", "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}}/stats/napter/audit_logs?year_month=", "host": [ "{{baseUrl}}" ], "path": [ "stats", "napter", "audit_logs" ], "query": [ { "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.", "key": "year_month", "value": "" } ] }, "description": "Get Napter audit logs' monthly exported data stats." }, "response": [ { "id": "f1430b30-9419-4de4-89bb-87951b3ba801", "name": "OK.", "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}}/stats/napter/audit_logs?year_month=", "host": [ "{{baseUrl}}" ], "path": [ "stats", "napter", "audit_logs" ], "query": [ { "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.", "key": "year_month", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedBytes\": \"\",\n \"yearMonth\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f1430b30-9419-4de4-89bb-87951b3ba801" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4e0dacd0-0a3f-4b30-be11-de2c51285402" } ], "id": "19171ddb-9b51-4090-8ba8-e1698d0ead2e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-19171ddb-9b51-4090-8ba8-e1698d0ead2e" } ], "id": "a95ffe95-5d4e-46eb-90e2-6a6da5bf95be", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a95ffe95-5d4e-46eb-90e2-6a6da5bf95be" } ], "id": "a67541b1-1042-4acd-bc11-5133dd014363", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a67541b1-1042-4acd-bc11-5133dd014363" }, { "name": "subscribers", "item": [ { "name": "{imsi}", "item": [ { "name": "activate", "item": [ { "name": "Activate Subscriber.", "id": "d8bb498e-b58e-41ec-92e6-7e498ffec975", "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": "269172fb-1003-45d0-a783-8122b81d539c", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Activates status of specified subscriber." }, "response": [ { "id": "82fe9a9f-dfd3-4b6f-963d-bf530335126e", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-82fe9a9f-dfd3-4b6f-963d-bf530335126e" }, { "id": "2e9b731a-63d6-4826-ab72-cb60644467a4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2e9b731a-63d6-4826-ab72-cb60644467a4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d8bb498e-b58e-41ec-92e6-7e498ffec975" } ], "id": "9e3aa9c0-2efe-4501-a93e-dddc8d8531cf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9e3aa9c0-2efe-4501-a93e-dddc8d8531cf" }, { "name": "bundles", "item": [ { "name": "Set Bundles to Subscriber.", "id": "91409ff2-303a-4bf1-b8bb-5801178adc37", "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-10MB\",\n \"US-3MB\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/bundles", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "bundles" ], "variable": [ { "id": "76fa120a-706c-41f7-9357-84ca2c978c60", "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": "2a763925-0a25-4d89-9332-5586894fd689", "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-10MB\",\n \"US-3MB\"\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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a763925-0a25-4d89-9332-5586894fd689" }, { "id": "033bbbfc-4088-45f3-b1e8-93f8fbffe498", "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-10MB\",\n \"US-3MB\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-033bbbfc-4088-45f3-b1e8-93f8fbffe498" }, { "id": "d088e9ab-3ced-426f-b342-0cd09bec0204", "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-10MB\",\n \"US-3MB\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d088e9ab-3ced-426f-b342-0cd09bec0204" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-91409ff2-303a-4bf1-b8bb-5801178adc37" } ], "id": "b14e01c4-4d18-4ea7-95e8-3e8e3c56739f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b14e01c4-4d18-4ea7-95e8-3e8e3c56739f" }, { "name": "data", "item": [ { "name": "Get data sent from a subscriber to Harvest Data.", "id": "9d3eae05-1b64-4a15-917b-ac48de4aabb4", "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": "f64f37d0-6436-4cd5-8af8-52b0ba16037b", "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": "1c7e7062-e2a5-4cf0-875a-22aafef98470", "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\": \"SoraCam\",\n \"time\": \"\"\n },\n {\n \"category\": \"\",\n \"content\": \"\",\n \"contentType\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"SoraCam\",\n \"time\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c7e7062-e2a5-4cf0-875a-22aafef98470" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9d3eae05-1b64-4a15-917b-ac48de4aabb4" } ], "id": "1dbec988-a20f-4d5e-bb97-63461de8b559", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1dbec988-a20f-4d5e-bb97-63461de8b559" }, { "name": "deactivate", "item": [ { "name": "Deactivate Subscriber.", "id": "80e866f0-304b-44f6-b618-ae463d853e3f", "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": "8bf2e652-9699-4888-b224-8abba8c4ef09", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deactivates specified subscriber." }, "response": [ { "id": "fadd3cd8-2944-4385-b67b-863576b79a7d", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fadd3cd8-2944-4385-b67b-863576b79a7d" }, { "id": "0b75e1af-8305-42bc-8c7e-69f57a44aa72", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0b75e1af-8305-42bc-8c7e-69f57a44aa72" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-80e866f0-304b-44f6-b618-ae463d853e3f" } ], "id": "652334f0-4de3-441e-820f-a24ab594ca2b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-652334f0-4de3-441e-820f-a24ab594ca2b" }, { "name": "delete_session", "item": [ { "name": "Delete Session", "id": "a4f5e1cc-ee44-4260-bd05-e0c4259bd7ae", "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": "796e99b3-804e-452a-924a-bebc9cbc6ce7", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deletes session for the specified subscriber." }, "response": [ { "id": "6745abfc-3743-4737-8cb3-9e8d0cb72f56", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6745abfc-3743-4737-8cb3-9e8d0cb72f56" }, { "id": "e8cf8272-008d-4f07-8df9-d84a33bb66f0", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e8cf8272-008d-4f07-8df9-d84a33bb66f0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a4f5e1cc-ee44-4260-bd05-e0c4259bd7ae" } ], "id": "63fd9552-a65f-4183-96c3-cb8910139882", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-63fd9552-a65f-4183-96c3-cb8910139882" }, { "name": "disable_termination", "item": [ { "name": "Disable Termination of Subscriber.", "id": "c6a39e53-780d-488c-806a-72657f07a4af", "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": "148ab992-ac11-468e-911f-a9538954c670", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Disables termination of specified subscriber." }, "response": [ { "id": "c6289b26-17ea-4f10-b51d-57a669d3d923", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c6289b26-17ea-4f10-b51d-57a669d3d923" }, { "id": "3a8c4add-076a-4e99-bfee-3f9ff72443f4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3a8c4add-076a-4e99-bfee-3f9ff72443f4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c6a39e53-780d-488c-806a-72657f07a4af" } ], "id": "4d719c71-906f-427e-b0d7-167ab323ebc5", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4d719c71-906f-427e-b0d7-167ab323ebc5" }, { "name": "downlink", "item": [ { "name": "ping", "item": [ { "name": "Send ping requests to a subscriber.", "id": "85858df2-d3ff-422d-8be6-9afd65c6ffdf", "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": "961abb9a-850c-42e5-a498-105203734b4e", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Send ICMP ping requests to a subscriber." }, "response": [ { "id": "a6e0d122-15f4-4628-81b3-47d0a6078f8e", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a6e0d122-15f4-4628-81b3-47d0a6078f8e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-85858df2-d3ff-422d-8be6-9afd65c6ffdf" } ], "id": "9abf1446-528e-4ff0-884d-58da72ca8038", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9abf1446-528e-4ff0-884d-58da72ca8038" } ], "id": "29f5056e-ecd8-4b91-b31d-4d4c66e212da", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-29f5056e-ecd8-4b91-b31d-4d4c66e212da" }, { "name": "enable_termination", "item": [ { "name": "Enable Termination of Subscriber.", "id": "36339ed7-e7f2-4fa6-b249-841726212a8b", "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": "e084d098-f838-4a6c-a390-79e8f0a61eea", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Enables termination of specified subscriber." }, "response": [ { "id": "e1bf3780-7c0b-4fbc-9ccc-2f2e159a4a95", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e1bf3780-7c0b-4fbc-9ccc-2f2e159a4a95" }, { "id": "274a13e1-c345-48f5-8281-fb4ab727d658", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-274a13e1-c345-48f5-8281-fb4ab727d658" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-36339ed7-e7f2-4fa6-b249-841726212a8b" } ], "id": "4fd8908f-1238-40cd-aacc-f6197146966f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4fd8908f-1238-40cd-aacc-f6197146966f" }, { "name": "events", "item": [ { "name": "sessions", "item": [ { "name": "List Session Events.", "id": "e51642cd-34ce-47bf-92d9-a9a58c63ada0", "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": "eb18e44f-e757-4cd7-b83c-f98bcbee59b9", "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": "dc5a386e-470c-4c57-af85-b347807ee271", "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\": \"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 {\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dc5a386e-470c-4c57-af85-b347807ee271" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e51642cd-34ce-47bf-92d9-a9a58c63ada0" } ], "id": "6797cf12-ce8f-4d3b-b7bf-33279d943b3b", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6797cf12-ce8f-4d3b-b7bf-33279d943b3b" } ], "id": "5e1375e2-bd82-4b60-b3ee-5e72d4f42308", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5e1375e2-bd82-4b60-b3ee-5e72d4f42308" }, { "name": "register", "item": [ { "name": "Register Subscriber.", "id": "b986f5cf-573b-4cdc-afbf-14d9bf4df88f", "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 \"Excepteur_000\": \"\",\n \"pariatur0_6\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscribers/:imsi/register", "host": [ "{{baseUrl}}" ], "path": [ "subscribers", ":imsi", "register" ], "variable": [ { "id": "15846b30-3ca8-42b6-82c1-9135cca913de", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Registers a subscriber." }, "response": [ { "id": "772ce31a-8fe9-43ce-8870-602c26881963", "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 \"Excepteur_000\": \"\",\n \"pariatur0_6\": \"\"\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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-772ce31a-8fe9-43ce-8870-602c26881963" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b986f5cf-573b-4cdc-afbf-14d9bf4df88f" } ], "id": "e78b30ea-4f08-416a-9d24-5aefc97b80d3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e78b30ea-4f08-416a-9d24-5aefc97b80d3" }, { "name": "report_local_info", "item": [ { "name": "Triggers Subscriber to report SIM local info.", "id": "02a772b4-7fe8-4d06-888d-ac7b7ee9af73", "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": "f387005e-5acf-46f0-a649-4903dabcda31", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Triggers Subscriber to report SIM local info." }, "response": [ { "id": "4c39def8-17f9-4a02-8340-13fa18f19128", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4c39def8-17f9-4a02-8340-13fa18f19128" }, { "id": "2196ca0e-f03c-450d-b838-39f385d118e0", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2196ca0e-f03c-450d-b838-39f385d118e0" }, { "id": "b14fe2c9-8ef0-4753-826b-8663578f933f", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b14fe2c9-8ef0-4753-826b-8663578f933f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-02a772b4-7fe8-4d06-888d-ac7b7ee9af73" } ], "id": "ab69e6ea-1930-4408-9265-8bfe9e184f50", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ab69e6ea-1930-4408-9265-8bfe9e184f50" }, { "name": "send_sms", "item": [ { "name": "Send SMS to Subscriber", "id": "17efc921-2db4-4e54-af40-67a9f074e6eb", "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": "1f517613-7170-47d9-be0b-ee22122eb1c5", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Send SMS to the specified subscriber." }, "response": [ { "id": "05f01981-4f1f-4f58-a1a7-7ff2c632a46e", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05f01981-4f1f-4f58-a1a7-7ff2c632a46e" }, { "id": "def10652-64a4-4a58-9cb9-5baf654a1dc3", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-def10652-64a4-4a58-9cb9-5baf654a1dc3" }, { "id": "5e67ee29-8c60-4269-9e96-4b663b57f26b", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5e67ee29-8c60-4269-9e96-4b663b57f26b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-17efc921-2db4-4e54-af40-67a9f074e6eb" } ], "id": "598ee788-6c24-4e72-b6e8-ec272ca03322", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-598ee788-6c24-4e72-b6e8-ec272ca03322" }, { "name": "set_expiry_time", "item": [ { "name": "Update Expiry Time of Subscriber.", "id": "1c884581-4302-411f-9873-8a944d035e8a", "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\": \"deleteSession\"\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": "300a6391-b58d-478b-a733-81c35a7e0182", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Updates expiry time of specified subscriber." }, "response": [ { "id": "96f6e385-db96-4fa5-a743-4231ea7bbf13", "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\": \"deleteSession\"\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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-96f6e385-db96-4fa5-a743-4231ea7bbf13" }, { "id": "f4e16c95-a50e-4324-8ca3-e863c39a50ab", "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\": \"deleteSession\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f4e16c95-a50e-4324-8ca3-e863c39a50ab" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1c884581-4302-411f-9873-8a944d035e8a" } ], "id": "fa5f8156-cf7e-4bac-941e-f9d52f190d42", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-fa5f8156-cf7e-4bac-941e-f9d52f190d42" }, { "name": "set_group", "item": [ { "name": "Adds a SIM to a SIM group", "id": "3097be1b-000b-48ac-a22d-aa1f1d841590", "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": "2295ddc9-e45e-4394-97f1-cc16e8b90ebd", "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": "dbc86793-17e0-44b2-8187-6bd158857328", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dbc86793-17e0-44b2-8187-6bd158857328" }, { "id": "3a0cd02a-900e-43e8-a9f8-2083ff18cac0", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3a0cd02a-900e-43e8-a9f8-2083ff18cac0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3097be1b-000b-48ac-a22d-aa1f1d841590" } ], "id": "f8253e3e-e067-4b67-b52f-d9f2cbf84163", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f8253e3e-e067-4b67-b52f-d9f2cbf84163" }, { "name": "set_imei_lock", "item": [ { "name": "Set IMEI lock configuration for Subscriber.", "id": "53036e05-6032-48d7-b3c4-8724744acb0a", "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": "2da1e0b1-a168-49f7-91be-e60d35611c56", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Set IMEI that the subscriber should be locked to." }, "response": [ { "id": "06ee5c71-fcf1-44e2-84fd-a2171f3ce60b", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-06ee5c71-fcf1-44e2-84fd-a2171f3ce60b" }, { "id": "cc31e1f5-16a3-429a-90b7-73ba869305e2", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cc31e1f5-16a3-429a-90b7-73ba869305e2" }, { "id": "bd799143-d1a0-4673-a9aa-c2d306e578df", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bd799143-d1a0-4673-a9aa-c2d306e578df" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-53036e05-6032-48d7-b3c4-8724744acb0a" } ], "id": "f55855d2-7fd9-4c65-ac48-0b851639beb6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f55855d2-7fd9-4c65-ac48-0b851639beb6" }, { "name": "set_to_standby", "item": [ { "name": "Set Subscriber to standby mode.", "id": "2b0a67fe-002c-4bed-92b2-460365a7d542", "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": "128c063c-5e88-42a3-9123-2b90405e529e", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Set the specified subscriber to standby mode." }, "response": [ { "id": "539cfc0d-dabf-4bda-abce-740eb213efe1", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-539cfc0d-dabf-4bda-abce-740eb213efe1" }, { "id": "43438674-e362-473d-b8e1-d2a097f7a407", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-43438674-e362-473d-b8e1-d2a097f7a407" }, { "id": "7b8fea28-df05-4e12-bf88-5303c00b23c1", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b8fea28-df05-4e12-bf88-5303c00b23c1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2b0a67fe-002c-4bed-92b2-460365a7d542" } ], "id": "8f020d46-420b-4be5-8c0a-b2e764fb4116", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8f020d46-420b-4be5-8c0a-b2e764fb4116" }, { "name": "suspend", "item": [ { "name": "Suspend Subscriber.", "id": "ed8002a0-7691-4eb0-99db-4ed8383cd18b", "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": "66991973-b483-43f6-84c4-143b6ceb8d17", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Suspends the specified subscriber." }, "response": [ { "id": "5df123b9-9d51-4c5f-b689-f87d0385afcc", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5df123b9-9d51-4c5f-b689-f87d0385afcc" }, { "id": "e9a1eacf-d538-42bf-961d-9fe9d41f5402", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e9a1eacf-d538-42bf-961d-9fe9d41f5402" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ed8002a0-7691-4eb0-99db-4ed8383cd18b" } ], "id": "94295f98-bab0-4d60-8d6a-bebfe16f743d", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-94295f98-bab0-4d60-8d6a-bebfe16f743d" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete Subscriber Tag.", "id": "9e201ccf-dc37-4c91-a7c1-f9f2ae30f2c6", "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": "52b21271-ff42-4b77-bdbb-e4f643cd31fb", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." }, { "id": "d6d53d63-d306-44a8-98bf-091b52a0e818", "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": "cf056781-b9c2-4af4-b0bb-9db4d84c3e69", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cf056781-b9c2-4af4-b0bb-9db4d84c3e69" }, { "id": "119ccd38-ed15-4324-9561-7828879ebe8a", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-119ccd38-ed15-4324-9561-7828879ebe8a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9e201ccf-dc37-4c91-a7c1-f9f2ae30f2c6" } ], "id": "ccbd48c2-374b-4f69-b3f0-5f8ccab512ab", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ccbd48c2-374b-4f69-b3f0-5f8ccab512ab" }, { "name": "Bulk Insert or Update Subscriber Tags.", "id": "e3802e7d-7f31-4e8a-9431-ba7c26bc5d31", "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": "3a5809f7-e635-46be-8773-88be1fc617d4", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Inserts/updates tags for the specified subscriber." }, "response": [ { "id": "af4893ac-7430-4286-aaf5-488d36312ff3", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af4893ac-7430-4286-aaf5-488d36312ff3" }, { "id": "4990e57d-91d9-4b2e-a945-a951a6122595", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4990e57d-91d9-4b2e-a945-a951a6122595" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e3802e7d-7f31-4e8a-9431-ba7c26bc5d31" } ], "id": "f9ae445e-cb16-40aa-90a5-9e54e1ded4c7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f9ae445e-cb16-40aa-90a5-9e54e1ded4c7" }, { "name": "terminate", "item": [ { "name": "Terminate Subscriber.", "id": "2b9e631f-1927-4654-8295-c9213785e538", "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": "12586cae-10a7-4bfc-8741-4f1b656aa779", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Terminates the specified subscriber" }, "response": [ { "id": "36dc3d4b-dad2-4a73-bea5-9762b37a6747", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-36dc3d4b-dad2-4a73-bea5-9762b37a6747" }, { "id": "bf5cb0f1-ec31-4d28-8876-a7b1ba6df524", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bf5cb0f1-ec31-4d28-8876-a7b1ba6df524" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2b9e631f-1927-4654-8295-c9213785e538" } ], "id": "4e431ad6-c9b6-4b32-bc99-a64c9249dd6c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4e431ad6-c9b6-4b32-bc99-a64c9249dd6c" }, { "name": "unset_expiry_time", "item": [ { "name": "Delete Expiry Time of Subscriber.", "id": "84ee5aca-b996-431a-a26f-add4c0e822cf", "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": "c4fcbae0-13dc-4f90-9a94-3dd488b86068", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Deletes expiry time of specified subscriber and changes it to indefinite." }, "response": [ { "id": "9f679358-7ab1-4325-bde3-0bb53628410c", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9f679358-7ab1-4325-bde3-0bb53628410c" }, { "id": "bf8e8e08-4b40-4eea-a869-81107b3675a8", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bf8e8e08-4b40-4eea-a869-81107b3675a8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-84ee5aca-b996-431a-a26f-add4c0e822cf" } ], "id": "313cd2ca-658a-49a1-9da3-9add462da134", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-313cd2ca-658a-49a1-9da3-9add462da134" }, { "name": "unset_group", "item": [ { "name": "Removes a SIM from a SIM group", "id": "cc8faa48-6c56-4836-9804-9bb52f2444a6", "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": "30677957-508f-4d4b-b80d-3829b4803a6e", "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": "5b012850-0094-4cf6-a0be-72b48945f20c", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5b012850-0094-4cf6-a0be-72b48945f20c" }, { "id": "01391410-c30e-4c66-abdb-83c08d7c1248", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-01391410-c30e-4c66-abdb-83c08d7c1248" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cc8faa48-6c56-4836-9804-9bb52f2444a6" } ], "id": "88edb0f7-906f-413e-a187-032890608aed", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-88edb0f7-906f-413e-a187-032890608aed" }, { "name": "unset_imei_lock", "item": [ { "name": "Unset IMEI lock configuration for Subscriber.", "id": "ef47b2ee-962b-4d3c-9127-a2eaa538e88c", "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": "1b16aa1c-b776-4f9b-b3e3-1acde529397f", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Remove any existing IMEI lock configuration for the subscriber." }, "response": [ { "id": "1f9786c7-cce2-41be-946c-806fcb92f4db", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1f9786c7-cce2-41be-946c-806fcb92f4db" }, { "id": "4c1137a5-8266-46a0-89fa-d45dc85f6bd8", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4c1137a5-8266-46a0-89fa-d45dc85f6bd8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ef47b2ee-962b-4d3c-9127-a2eaa538e88c" } ], "id": "1c5b9254-7b28-4dae-9e71-45fee83036e4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1c5b9254-7b28-4dae-9e71-45fee83036e4" }, { "name": "update_speed_class", "item": [ { "name": "Update Subscriber speed class.", "id": "25963216-b61e-4cf2-994a-8f5898455872", "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.4xfast\"\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": "5daf9755-4f1b-4601-884c-2d91c40e2936", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Changes the speed class of the specified subscriber." }, "response": [ { "id": "6c6c61ba-bee1-449e-a048-3821764b11b7", "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.4xfast\"\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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6c6c61ba-bee1-449e-a048-3821764b11b7" }, { "id": "fb17312b-faf2-453b-bfae-0a27489d49a2", "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.4xfast\"\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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fb17312b-faf2-453b-bfae-0a27489d49a2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-25963216-b61e-4cf2-994a-8f5898455872" } ], "id": "1174677a-fb4a-42be-a9c7-a29fef88a95c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1174677a-fb4a-42be-a9c7-a29fef88a95c" }, { "name": "Get Subscriber.", "id": "9b76e684-d0dc-43a8-bc8f-7f5e4956a5f9", "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": "85a707bc-70de-4bbf-bc7c-27495e44e3a1", "key": "imsi", "value": "", "description": "(Required) IMSI of the target subscriber." } ] }, "description": "Returns information about the specified subscriber." }, "response": [ { "id": "9b8db3b6-43fc-4d50-b321-c67333c5b975", "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\": \"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\": \"embedded\",\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\": \"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 \"in86_\": \"\",\n \"cupidatat_d54\": \"\",\n \"voluptate_8_\": \"\",\n \"fugiat5\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9b8db3b6-43fc-4d50-b321-c67333c5b975" }, { "id": "f7217b53-fdf1-4284-b3d7-19c75e823830", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f7217b53-fdf1-4284-b3d7-19c75e823830" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9b76e684-d0dc-43a8-bc8f-7f5e4956a5f9" } ], "id": "0035f328-a608-4493-964e-27765b1c9f80", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0035f328-a608-4493-964e-27765b1c9f80" }, { "name": "export", "item": [ { "name": "Export all subscribers.", "id": "f954595c-0f1e-4eb9-825b-6e431aad0a60", "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": "70766737-071a-4fcb-954e-dc0b9660d1c4", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-70766737-071a-4fcb-954e-dc0b9660d1c4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f954595c-0f1e-4eb9-825b-6e431aad0a60" } ], "id": "dc342d3b-84dc-46b6-967b-f3cf7f5e93fd", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dc342d3b-84dc-46b6-967b-f3cf7f5e93fd" }, { "name": "msisdn", "item": [ { "name": "{msisdn}", "item": [ { "name": "send_sms", "item": [ { "name": "Send SMS to Subscriber by MSISDN", "id": "6671635e-f697-4da0-b104-bf7eb13b7cf2", "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": "092b6afd-4e88-49e1-88e4-86716d6f80e5", "key": "msisdn", "value": "", "description": "(Required) MSISDN of the target subscriber." } ] }, "description": "Send SMS to a subscriber specified with MSISDN." }, "response": [ { "id": "2168d704-3972-4672-9f72-4e8716f60037", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2168d704-3972-4672-9f72-4e8716f60037" }, { "id": "128e1d9c-28d8-49c1-9833-980ce7a30349", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-128e1d9c-28d8-49c1-9833-980ce7a30349" }, { "id": "45c19ab8-bcbe-4fb8-bc7f-82fb7322bcd2", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-45c19ab8-bcbe-4fb8-bc7f-82fb7322bcd2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6671635e-f697-4da0-b104-bf7eb13b7cf2" } ], "id": "b9d18a17-3dc8-472d-8ec7-201403022ce9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b9d18a17-3dc8-472d-8ec7-201403022ce9" } ], "id": "0efae1a4-f72e-47a5-af7b-051753b33e70", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0efae1a4-f72e-47a5-af7b-051753b33e70" } ], "id": "16ee6f4d-d904-432c-a1fa-1e228abd1e36", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-16ee6f4d-d904-432c-a1fa-1e228abd1e36" }, { "name": "transfer_token", "item": [ { "name": "{token}", "item": [ { "name": "Cancel the transfer of Ready status SIMs (Invalidate the transfer token)", "id": "0047ecee-fe4e-4055-8ec1-4fb38ca3a103", "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": "edc1c97f-f0b3-400b-836a-05b153ae6b5c", "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": "7f69e6d8-52fb-4395-8c7a-45984785196b", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7f69e6d8-52fb-4395-8c7a-45984785196b" }, { "id": "ca98f7af-a9c4-4288-9eb6-1486095728e7", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ca98f7af-a9c4-4288-9eb6-1486095728e7" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0047ecee-fe4e-4055-8ec1-4fb38ca3a103" } ], "id": "235e931a-ca86-4ccb-9479-e183d450039f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-235e931a-ca86-4ccb-9479-e183d450039f" }, { "name": "issue", "item": [ { "name": "Initiate the transfer of Ready status SIMs (Issue a transfer token)", "id": "72f38d4d-5c16-4d62-9fed-5a0011c940ad", "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": "913d2135-ed2f-4135-b913-cf0dfa605778", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-913d2135-ed2f-4135-b913-cf0dfa605778" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-72f38d4d-5c16-4d62-9fed-5a0011c940ad" } ], "id": "5d80da7e-ce7d-45dd-b981-51c187ea2ddb", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5d80da7e-ce7d-45dd-b981-51c187ea2ddb" }, { "name": "verify", "item": [ { "name": "Accept the transfer of Ready status SIMs (Verify the transfer token)", "id": "5af24662-f62d-450e-b8d4-e4152eb2a7f2", "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": "9a3ef382-8b4e-4743-a7db-617790e4d4a6", "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:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9a3ef382-8b4e-4743-a7db-617790e4d4a6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5af24662-f62d-450e-b8d4-e4152eb2a7f2" } ], "id": "30a69646-4052-4b96-9093-2acae7a19371", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-30a69646-4052-4b96-9093-2acae7a19371" } ], "id": "8166755d-447f-4c61-af90-0caf0a1d5f4f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8166755d-447f-4c61-af90-0caf0a1d5f4f" }, { "name": "List Subscribers.", "id": "bd6af539-d227-42cb-8e70-9db6ae4f89f9", "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": "00d45d39-0e5f-45e4-b9d4-8ff0ed39fe15", "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\": \"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\": \"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\": \"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\": \"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\": \"us-west-2\"\n },\n \"sessionId\": \"\",\n \"subscription\": \"\",\n \"ueIpAddress\": \"\",\n \"vpgId\": \"\"\n },\n \"simId\": \"\",\n \"speedClass\": \"\",\n \"status\": \"standby\",\n \"subscription\": \"\",\n \"tags\": {\n \"ex_109\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n },\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\": \"profilePackage\",\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\": \"LTE\",\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\": \"standby\",\n \"subscription\": \"\",\n \"tags\": {\n \"consectetur_de\": \"\",\n \"ind6\": \"\"\n },\n \"terminationEnabled\": \"\",\n \"type\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-00d45d39-0e5f-45e4-b9d4-8ff0ed39fe15" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bd6af539-d227-42cb-8e70-9db6ae4f89f9" } ], "id": "5589dd73-f5b1-4702-94f0-9e2d44c8376a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5589dd73-f5b1-4702-94f0-9e2d44c8376a" }, { "name": "virtual_private_gateways", "item": [ { "name": "{vpg_id}", "item": [ { "name": "customer_routes", "item": [ { "name": "{route_id}", "item": [ { "name": "Delete routing table entry", "id": "863c5b77-1283-4245-b59d-201a3db2dc44", "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}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "id": "abd66cee-de16-4527-8c58-4f6f790cf991", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "cc013872-a72f-4168-a290-b0adf92c180b", "key": "route_id", "value": "", "description": "(Required) Target route ID" } ] }, "description": "Deletes a routing table entry from the specified VPG." }, "response": [ { "id": "8da9259b-e5f9-45a7-abfc-20fdae0c6a0f", "name": "Deleted routing table entry", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "key": "vpg_id" }, { "key": "route_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8da9259b-e5f9-45a7-abfc-20fdae0c6a0f" }, { "id": "ba558623-f694-4823-a72b-6205aa696525", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "key": "vpg_id" }, { "key": "route_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ba558623-f694-4823-a72b-6205aa696525" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-863c5b77-1283-4245-b59d-201a3db2dc44" }, { "name": "Update routing table entry", "id": "e85d4387-1253-4c45-b73b-178dad82142d", "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 \"target\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "id": "9a04eb82-62ee-4ade-a23c-037f877f78f2", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "e68a6b83-503c-4f56-a714-c5e857fbea36", "key": "route_id", "value": "", "description": "(Required) Target route ID" } ] }, "description": "Updates a routing table entry for the specified VPG." }, "response": [ { "id": "a9f3da7e-265e-453a-b87c-c997cc7f7b3a", "name": "Updated routing table entry", "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 \"target\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "key": "vpg_id" }, { "key": "route_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a9f3da7e-265e-453a-b87c-c997cc7f7b3a" }, { "id": "81b11f53-2f1b-425e-a38e-92e875e9abc7", "name": "Invalid request", "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 \"target\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "key": "vpg_id" }, { "key": "route_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-81b11f53-2f1b-425e-a38e-92e875e9abc7" }, { "id": "92eb5f80-5cd1-4f8f-896e-ce58f2dbf596", "name": "The specified VPG 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 \"target\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes", ":route_id" ], "variable": [ { "key": "vpg_id" }, { "key": "route_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-92eb5f80-5cd1-4f8f-896e-ce58f2dbf596" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e85d4387-1253-4c45-b73b-178dad82142d" } ], "id": "1c89d820-38b9-4a47-8fdd-c5b41016e9d7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1c89d820-38b9-4a47-8fdd-c5b41016e9d7" }, { "name": "Create routing table entry", "id": "38a103e5-d476-4dbc-8e21-770698e0545d", "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 \"destinationCidr\": \"\",\n \"target\": \"\",\n \"ignoreDeviceSubnetCidrRangeOverlap\": \"\",\n \"ignoreDeviceSubnetcidrRangeOverlap\": {\n \"description\": \"A boolean flag to ignore device subnet CIDR range overlap with the destination CIDR range\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes" ], "variable": [ { "id": "b74bf26d-4a95-4df1-ac31-05579104df6a", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Creates a routing table entry for the specified VPG." }, "response": [ { "id": "36837f42-b157-4529-9ed9-21ba709077bf", "name": "Created routing table entry", "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 \"destinationCidr\": \"\",\n \"target\": \"\",\n \"ignoreDeviceSubnetCidrRangeOverlap\": \"\",\n \"ignoreDeviceSubnetcidrRangeOverlap\": {\n \"description\": \"A boolean flag to ignore device subnet CIDR range overlap with the destination CIDR range\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-36837f42-b157-4529-9ed9-21ba709077bf" }, { "id": "2a6379d3-0e3f-4819-b85a-48f4a74945db", "name": "Invalid request", "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 \"destinationCidr\": \"\",\n \"target\": \"\",\n \"ignoreDeviceSubnetCidrRangeOverlap\": \"\",\n \"ignoreDeviceSubnetcidrRangeOverlap\": {\n \"description\": \"A boolean flag to ignore device subnet CIDR range overlap with the destination CIDR range\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2a6379d3-0e3f-4819-b85a-48f4a74945db" }, { "id": "ad3f5974-7eda-4d33-9e9a-8e0ebd68aa02", "name": "The specified VPG 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 \"destinationCidr\": \"\",\n \"target\": \"\",\n \"ignoreDeviceSubnetCidrRangeOverlap\": \"\",\n \"ignoreDeviceSubnetcidrRangeOverlap\": {\n \"description\": \"A boolean flag to ignore device subnet CIDR range overlap with the destination CIDR range\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/customer_routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "customer_routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ad3f5974-7eda-4d33-9e9a-8e0ebd68aa02" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-38a103e5-d476-4dbc-8e21-770698e0545d" } ], "id": "d44839ab-358d-48f0-ab49-3d7693be31b3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d44839ab-358d-48f0-ab49-3d7693be31b3" }, { "name": "fixed_public_ip_addresses", "item": [ { "name": "Disable the fixed global IP address option for the VPG", "id": "004b2bb8-30e6-40e0-aa10-9cfd42ce52c7", "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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "id": "570a89f1-44cf-4699-9971-a1d4abf54186", "key": "vpg_id", "value": "", "description": "(Required) " } ] }, "description": "Disables the fixed global IP address option for the VPG." }, "response": [ { "id": "6e7cee63-9ebd-43ad-9d41-e25c8ce42b60", "name": "The fixed global IP address option for the VPG was successfully disabled.", "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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6e7cee63-9ebd-43ad-9d41-e25c8ce42b60" }, { "id": "bac15d1e-c857-414e-a2da-1b193307dcc8", "name": "The fixed global IP address option for the VPG is already disabled.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-bac15d1e-c857-414e-a2da-1b193307dcc8" }, { "id": "7b618b10-92ed-407d-a83b-9bcfcd63b71c", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b618b10-92ed-407d-a83b-9bcfcd63b71c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-004b2bb8-30e6-40e0-aa10-9cfd42ce52c7" }, { "name": "Enable the fixed global IP address option for the VPG", "id": "3838aa56-5944-47bc-9752-54b91c0f3d4e", "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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "id": "dc41a1d0-9b94-4564-a5a8-cb573cf628ba", "key": "vpg_id", "value": "", "description": "(Required) " } ] }, "description": "Enables the fixed global IP address option for the VPG." }, "response": [ { "id": "0c03e63c-b72e-4c24-b4da-907fba751afd", "name": "The fixed global IP address option for the VPG was successfully enabled.", "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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0c03e63c-b72e-4c24-b4da-907fba751afd" }, { "id": "7da11027-c572-44f6-bf02-6d97986f6df0", "name": "The fixed global IP address option for the VPG is already enabled.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7da11027-c572-44f6-bf02-6d97986f6df0" }, { "id": "9c3c5ef0-af06-4e87-a108-221a6d5f2fba", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "fixed_public_ip_addresses" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9c3c5ef0-af06-4e87-a108-221a6d5f2fba" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3838aa56-5944-47bc-9752-54b91c0f3d4e" } ], "id": "05ff43aa-aa3e-4910-b301-134e98157fcc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-05ff43aa-aa3e-4910-b301-134e98157fcc" }, { "name": "gate", "item": [ { "name": "close", "item": [ { "name": "Close SORACOM Gate.", "id": "676db90a-5aef-4ef7-ad95-b35fb5e2605a", "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}}/virtual_private_gateways/:vpg_id/gate/close", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "close" ], "variable": [ { "id": "dcbd6cc3-cf4b-4d30-b13e-dc9981afa44f", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Close Soracom Gate on the specified VPG." }, "response": [ { "id": "85ee63c0-5901-4af2-ba7a-11526efc517a", "name": "Soracom Gate is successfully closed on the VPG.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/close", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "close" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-85ee63c0-5901-4af2-ba7a-11526efc517a" }, { "id": "dfe3f8ba-bcfa-42de-85a8-e0a88b1408e3", "name": "Client side error in the request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/close", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "close" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dfe3f8ba-bcfa-42de-85a8-e0a88b1408e3" }, { "id": "53033599-59c8-48fb-866f-f8b7d9cb7a64", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/close", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "close" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-53033599-59c8-48fb-866f-f8b7d9cb7a64" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-676db90a-5aef-4ef7-ad95-b35fb5e2605a" } ], "id": "eeb64596-4573-4637-8840-8e072330d10e", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eeb64596-4573-4637-8840-8e072330d10e" }, { "name": "disable_privacy_separator", "item": [ { "name": "Disables Soracom Gate's privacy separator feature on the specified VPG", "id": "d7f13e64-4ae8-47ec-b11b-21061ea75ed7", "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}}/virtual_private_gateways/:vpg_id/gate/disable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "disable_privacy_separator" ], "variable": [ { "id": "70487769-e41e-42b9-80ab-b9bc869594e2", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Disables Soracom Gate's privacy separator feature on the specified VPG and enables the Gate D2D feature." }, "response": [ { "id": "e2d69bf3-9e1a-432f-88f9-2539c6c0b49b", "name": "Disabled the privacy separator successfully", "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}}/virtual_private_gateways/:vpg_id/gate/disable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "disable_privacy_separator" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e2d69bf3-9e1a-432f-88f9-2539c6c0b49b" }, { "id": "918937dd-e458-4e5e-8726-74055a9c911d", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/disable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "disable_privacy_separator" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-918937dd-e458-4e5e-8726-74055a9c911d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d7f13e64-4ae8-47ec-b11b-21061ea75ed7" } ], "id": "06ebd9f5-7a8d-4899-a371-71caec32a4c9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-06ebd9f5-7a8d-4899-a371-71caec32a4c9" }, { "name": "enable_privacy_separator", "item": [ { "name": "Enables Soracom Gate privacy separator feature on the specified VPG", "id": "ade1b7de-1a63-4122-9ef9-8e7978a34677", "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}}/virtual_private_gateways/:vpg_id/gate/enable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "enable_privacy_separator" ], "variable": [ { "id": "111972de-28a1-47e1-aed6-ff0595d93a33", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Enables Soracom Gate's privacy separator feature on the specified VPG and disables the Gate D2D feature." }, "response": [ { "id": "1d859827-e1c0-46e6-8cd8-6a7d6b6a4550", "name": "Enabled the privacy separator successfully", "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}}/virtual_private_gateways/:vpg_id/gate/enable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "enable_privacy_separator" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1d859827-e1c0-46e6-8cd8-6a7d6b6a4550" }, { "id": "98d19fe9-2797-4617-bb61-4f804b68ce7c", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/enable_privacy_separator", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "enable_privacy_separator" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-98d19fe9-2797-4617-bb61-4f804b68ce7c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ade1b7de-1a63-4122-9ef9-8e7978a34677" } ], "id": "329c41d6-2107-40bd-9129-75b3638fa0da", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-329c41d6-2107-40bd-9129-75b3638fa0da" }, { "name": "open", "item": [ { "name": "Open Soracom Gate", "id": "ee8e310a-4bc1-4d20-b9d9-ea49cdd858a4", "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" } ], "body": { "mode": "raw", "raw": "{\n \"privacySeparatorEnabled\": false,\n \"vxlanId\": 10\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/open", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "open" ], "variable": [ { "id": "12aad713-e322-4c19-b9d8-5cb4768454a7", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Open Soracom Gate on the specified VPG." }, "response": [ { "id": "4a0479aa-edd7-4c9b-9086-aa332cf4836c", "name": "SORACOM Gate is successfully opened on the VPG.", "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 \"privacySeparatorEnabled\": false,\n \"vxlanId\": 10\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/open", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "open" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4a0479aa-edd7-4c9b-9086-aa332cf4836c" }, { "id": "41387398-2a23-42c9-a2ef-a490bd7bbfa3", "name": "Client side error in the request.", "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 \"privacySeparatorEnabled\": false,\n \"vxlanId\": 10\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/open", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "open" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-41387398-2a23-42c9-a2ef-a490bd7bbfa3" }, { "id": "ab65d855-a5bb-4d29-98c5-6cddd23742b5", "name": "The specified VPG 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 \"privacySeparatorEnabled\": false,\n \"vxlanId\": 10\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/open", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "open" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ab65d855-a5bb-4d29-98c5-6cddd23742b5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ee8e310a-4bc1-4d20-b9d9-ea49cdd858a4" } ], "id": "1f8c3814-ba4d-494b-9cce-becf0e8870a7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1f8c3814-ba4d-494b-9cce-becf0e8870a7" }, { "name": "peers", "item": [ { "name": "{outer_ip_address}", "item": [ { "name": "Unregister VPG Gate Peer", "id": "4151e051-2a48-4966-a8f5-d06fba319ff5", "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}}/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers", ":outer_ip_address" ], "variable": [ { "id": "4e560127-43a9-4537-a39b-ea88bd0c3bb2", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "74716172-733d-49e3-8728-98c37a0ad74f", "key": "outer_ip_address", "value": "", "description": "(Required) ID of the target node." } ] }, "description": "Unregister a Gate Peer from the Virtual Private Gateway." }, "response": [ { "id": "e5bbfa50-0a56-4616-bcfd-e0b1976afdff", "name": "Successfully deregistered the Gate Peer.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers", ":outer_ip_address" ], "variable": [ { "key": "vpg_id" }, { "key": "outer_ip_address" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e5bbfa50-0a56-4616-bcfd-e0b1976afdff" }, { "id": "b6c5e759-edfb-47bf-8d4c-67503187e3e0", "name": "Client side error in the request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers", ":outer_ip_address" ], "variable": [ { "key": "vpg_id" }, { "key": "outer_ip_address" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-b6c5e759-edfb-47bf-8d4c-67503187e3e0" }, { "id": "a4bfd770-4b0f-49bb-89b4-af6862d1cb61", "name": "The specified VPG or Peer 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}}/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers", ":outer_ip_address" ], "variable": [ { "key": "vpg_id" }, { "key": "outer_ip_address" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a4bfd770-4b0f-49bb-89b4-af6862d1cb61" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4151e051-2a48-4966-a8f5-d06fba319ff5" } ], "id": "e00d8281-220f-4204-b0bd-c59dd44d5272", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e00d8281-220f-4204-b0bd-c59dd44d5272" }, { "name": "List VPG Gate Peers", "id": "47042e52-bc11-481f-be01-7b3c6e1a5f4e", "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}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "id": "6a3ccc59-4b03-4371-b2f9-02ffee9d1fee", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "List Gate Peers registered in the Virtual Private Gateway." }, "response": [ { "id": "05324621-4418-4290-913d-aa3c2d196246", "name": "List of Gate Peers registered in the VPG.", "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}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"innerIpAddress\": \"\",\n \"netmask\": \"\",\n \"outerIpAddress\": \"\",\n \"ownedByCustomer\": \"\"\n },\n {\n \"innerIpAddress\": \"\",\n \"netmask\": \"\",\n \"outerIpAddress\": \"\",\n \"ownedByCustomer\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-05324621-4418-4290-913d-aa3c2d196246" }, { "id": "c8d21b81-b604-4f12-aac2-a10abcdea7b4", "name": "Client side error in the request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c8d21b81-b604-4f12-aac2-a10abcdea7b4" }, { "id": "6d1bcc61-9909-45d0-ae87-b1901d0f9de2", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6d1bcc61-9909-45d0-ae87-b1901d0f9de2" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-47042e52-bc11-481f-be01-7b3c6e1a5f4e" }, { "name": "Register VPG Gate Peer", "id": "7e690252-4a96-44e9-b732-1d966abb6f3f", "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 \"outerIpAddress\": \"\",\n \"innerIpAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "id": "02381754-1b59-49c2-95f8-c8a196222603", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Register a host as a Gate Peer in the Virtual Private Gateway." }, "response": [ { "id": "e271f694-07d9-432e-a835-c82bebfb4015", "name": "Gate Peer is successfully registered.", "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 \"outerIpAddress\": \"\",\n \"innerIpAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"innerIpAddress\": \"\",\n \"netmask\": \"\",\n \"outerIpAddress\": \"\",\n \"ownedByCustomer\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e271f694-07d9-432e-a835-c82bebfb4015" }, { "id": "ae2bba31-023f-4957-868b-1e6ecace4093", "name": "Client side error in the request.", "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 \"outerIpAddress\": \"\",\n \"innerIpAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ae2bba31-023f-4957-868b-1e6ecace4093" }, { "id": "dd25278e-fde8-487b-a075-e8761c89cf26", "name": "The specified VPG 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 \"outerIpAddress\": \"\",\n \"innerIpAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dd25278e-fde8-487b-a075-e8761c89cf26" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7e690252-4a96-44e9-b732-1d966abb6f3f" } ], "id": "e0a8e3ff-f26f-4d41-846a-bc1aad3dc0dc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e0a8e3ff-f26f-4d41-846a-bc1aad3dc0dc" }, { "name": "routing", "item": [ { "name": "static", "item": [ { "name": "sims", "item": [ { "name": "disable", "item": [ { "name": "Disable SIM-Based Routing", "id": "0a0fedb1-6e90-4e06-8cd8-7ae02900adf2", "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}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/disable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "disable" ], "variable": [ { "id": "491b8ef1-21ec-4b36-8cce-afa29b7463ff", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Disables SIM-Based Routing." }, "response": [ { "id": "cb5075c2-c1db-4daa-a2e8-ddd3c628d495", "name": "SIM-Based Routing has been disabled.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/disable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "disable" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-cb5075c2-c1db-4daa-a2e8-ddd3c628d495" }, { "id": "6dedf693-d4d0-416c-880e-7dc5ec2b6953", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/disable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "disable" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6dedf693-d4d0-416c-880e-7dc5ec2b6953" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-0a0fedb1-6e90-4e06-8cd8-7ae02900adf2" } ], "id": "ae88bc3f-c7d1-494e-b128-55654882bec9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ae88bc3f-c7d1-494e-b128-55654882bec9" }, { "name": "enable", "item": [ { "name": "Enable SIM-Based Routing", "id": "94befb97-81cb-4495-b548-c98412889a59", "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}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "enable" ], "variable": [ { "id": "a006e97b-ba3c-4a6a-949a-c945a4351057", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Enables SIM-Based Routing." }, "response": [ { "id": "0585f8ba-c5c8-4921-bf48-4f72d0293b2c", "name": "SIM-Based Routing has been enabled.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "enable" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0585f8ba-c5c8-4921-bf48-4f72d0293b2c" }, { "id": "5cf197fb-0532-4b8f-8b42-af2195515c3b", "name": "SORACOM Gate is not enabled.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "enable" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5cf197fb-0532-4b8f-8b42-af2195515c3b" }, { "id": "e564ebe0-fccf-43df-a02f-1664e08ff296", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "enable" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e564ebe0-fccf-43df-a02f-1664e08ff296" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-94befb97-81cb-4495-b548-c98412889a59" } ], "id": "53716ffd-445e-4177-8a1e-816326d5d4ec", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-53716ffd-445e-4177-8a1e-816326d5d4ec" }, { "name": "routes", "item": [ { "name": "Associate a router's LAN IP address range with its SIM ID", "id": "e1dbcb5e-d547-4ad0-802b-629a0e32c7dd", "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" } ], "body": { "mode": "raw", "raw": "{\n \"Ut1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "routes" ], "variable": [ { "id": "7f9b2a13-c52a-43b7-a974-ffe27729a312", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Associates a router's LAN IP address range with its SIM ID." }, "response": [ { "id": "fae1dd90-bd6e-486f-b638-7c37198ff65f", "name": "OK", "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 \"Ut1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fae1dd90-bd6e-486f-b638-7c37198ff65f" }, { "id": "f75934e1-a3bc-4c98-b11b-05b66c9d34fb", "name": "Client side error in the request.", "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 \"Ut1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f75934e1-a3bc-4c98-b11b-05b66c9d34fb" }, { "id": "3b8c1548-6996-4c0c-b9fd-a902ab6d92b6", "name": "The specified VPG 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 \"Ut1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "routing", "static", "sims", "routes" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3b8c1548-6996-4c0c-b9fd-a902ab6d92b6" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e1dbcb5e-d547-4ad0-802b-629a0e32c7dd" } ], "id": "4503e831-0857-40da-8177-366286d92336", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4503e831-0857-40da-8177-366286d92336" } ], "id": "6fb1a4a3-d92f-4526-a198-fa09e1962a54", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6fb1a4a3-d92f-4526-a198-fa09e1962a54" } ], "id": "10671c6c-ebd3-4c79-947f-e14f0edc71ee", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-10671c6c-ebd3-4c79-947f-e14f0edc71ee" } ], "id": "7b8e50c8-2f03-4472-b004-4b3e0cf2bd21", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-7b8e50c8-2f03-4472-b004-4b3e0cf2bd21" }, { "name": "set_vxlan_id", "item": [ { "name": "Set VXLAN ID for Gate", "id": "4edcf6b8-e443-481c-a8b3-b525ee936aa4", "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" } ], "body": { "mode": "raw", "raw": "{\n \"vxlanId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/set_vxlan_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "set_vxlan_id" ], "variable": [ { "id": "c81183b2-5ea6-4f8f-87c4-1af27516a49c", "key": "vpg_id", "value": "", "description": "(Required) " } ] }, "description": "Set VXLAN ID for Gate." }, "response": [ { "id": "ddeb02b5-4baa-4fa7-bd17-771d19207f3b", "name": "OK", "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 \"vxlanId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/set_vxlan_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "set_vxlan_id" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ddeb02b5-4baa-4fa7-bd17-771d19207f3b" }, { "id": "97cadb65-8499-4376-acbd-72db8214197a", "name": "The specified VPG 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 \"vxlanId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/gate/set_vxlan_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "gate", "set_vxlan_id" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-97cadb65-8499-4376-acbd-72db8214197a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-4edcf6b8-e443-481c-a8b3-b525ee936aa4" } ], "id": "2415b744-24ca-4178-b97e-d49ef1c789e4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2415b744-24ca-4178-b97e-d49ef1c789e4" } ], "id": "e1a10a0b-3057-46b5-b9fb-fdf9a919ab81", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e1a10a0b-3057-46b5-b9fb-fdf9a919ab81" }, { "name": "ip_address_map", "item": [ { "name": "{key}", "item": [ { "name": "Delete VPG IP address map entry", "id": "53ec7aca-911f-420c-b762-70f9b35e68d1", "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}}/virtual_private_gateways/:vpg_id/ip_address_map/:key", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map", ":key" ], "variable": [ { "id": "45f7eb92-ca55-49b0-a775-29cb4d1594b9", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "f8445dc9-a99b-4778-995d-0e08c5c0c2fb", "key": "key", "value": "", "description": "(Required) Identifier of the IP address map entry to delete (IMSI of the IoT SIM)." } ] }, "description": "Deletes an entry from the IP address map of the specified VPG.\n\n**Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries) response includes automatically assigned entries for Gate Peers and the VPG. These entries cannot be deleted using the VirtualPrivateGateway:deleteVirtualPrivateGatewayIpAddressMapEntry API.\n" }, "response": [ { "id": "3e235113-d75a-4c65-9530-02f2c0509953", "name": "Successfully deleted the IP address map entry.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map/:key", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map", ":key" ], "variable": [ { "key": "vpg_id" }, { "key": "key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3e235113-d75a-4c65-9530-02f2c0509953" }, { "id": "4fefcb58-b28e-4679-84ed-a1a88362f730", "name": "Client side error in the request.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map/:key", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map", ":key" ], "variable": [ { "key": "vpg_id" }, { "key": "key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4fefcb58-b28e-4679-84ed-a1a88362f730" }, { "id": "34171737-6a62-4edb-8b4f-533a36f70878", "name": "The specified VPG or key 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}}/virtual_private_gateways/:vpg_id/ip_address_map/:key", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map", ":key" ], "variable": [ { "key": "vpg_id" }, { "key": "key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-34171737-6a62-4edb-8b4f-533a36f70878" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-53ec7aca-911f-420c-b762-70f9b35e68d1" } ], "id": "d7f31bf4-71fa-42d6-bc62-b1603733c7f2", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d7f31bf4-71fa-42d6-bc62-b1603733c7f2" }, { "name": "List VPG IP address map entries", "id": "bae82d30-37ed-4f67-8a93-388f03919054", "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}}/virtual_private_gateways/:vpg_id/ip_address_map?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "query": [ { "description": "The maximum number of IP address map entries to retrieve. The response may contain fewer entries than the specified value.", "key": "limit", "value": "" }, { "description": "The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP address map entries.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "id": "9b101a43-ccbe-447b-a80d-e717737edc4c", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Retrieves the list of IP address map entries for the specified VPG.\n" }, "response": [ { "id": "480da889-9b0f-43cf-8a27-37700a055168", "name": "List of IP address map entries associated with the specified VPG.\n\n**Warning**: The response includes not only entries added via [VirtualPrivateGateway:putVirtualPrivateGatewayIpAddressMapEntry API](#/VirtualPrivateGateway/putVirtualPrivateGatewayIpAddres", "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}}/virtual_private_gateways/:vpg_id/ip_address_map?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "query": [ { "description": "The maximum number of IP address map entries to retrieve. The response may contain fewer entries than the specified value.", "key": "limit", "value": "" }, { "description": "The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP address map entries.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"ipAddress\": \"\",\n \"hostId\": \"\",\n \"key\": \"\",\n \"type\": \"gatePeer\",\n \"lastUpdatedAt\": \"\"\n },\n {\n \"ipAddress\": \"\",\n \"hostId\": \"\",\n \"key\": \"\",\n \"type\": \"customerGatePeer\",\n \"lastUpdatedAt\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-480da889-9b0f-43cf-8a27-37700a055168" }, { "id": "fd75944b-8585-413e-9971-59abe990d0ab", "name": "Client side error in the request.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "query": [ { "description": "The maximum number of IP address map entries to retrieve. The response may contain fewer entries than the specified value.", "key": "limit", "value": "" }, { "description": "The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP address map entries.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fd75944b-8585-413e-9971-59abe990d0ab" }, { "id": "1b94887e-63cb-4068-bb01-36d649a77ce8", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/ip_address_map?limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "query": [ { "description": "The maximum number of IP address map entries to retrieve. The response may contain fewer entries than the specified value.", "key": "limit", "value": "" }, { "description": "The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP address map entries.", "key": "last_evaluated_key", "value": "" } ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1b94887e-63cb-4068-bb01-36d649a77ce8" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bae82d30-37ed-4f67-8a93-388f03919054" }, { "name": "Adds or updates an entry in VPG IP address map", "id": "534bac62-fcab-445a-9351-8b23696ac1ee", "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 \"key\": \"\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "variable": [ { "id": "e91a1e8b-c5ab-4235-a9e4-6905d72c0fc6", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Adds or updates an IP address map entry for the specified VPG.\n\n**Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries) response includes entries that are automatically assigned to Gate Peers and the VPG, but these cannot be added or updated using the VirtualPrivateGateway:putVirtualPrivateGatewayIpAddressMapEntry API.\n" }, "response": [ { "id": "af9e8cd7-81b3-4d90-b1f5-40eeae0514ae", "name": "Successfully added or updated the IP address map entry.", "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 \"key\": \"\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ipAddress\": \"\",\n \"hostId\": \"\",\n \"key\": \"\",\n \"type\": \"gatePeer\",\n \"lastUpdatedAt\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-af9e8cd7-81b3-4d90-b1f5-40eeae0514ae" }, { "id": "f1995c8c-4c5f-48e2-942f-8c1b807532fc", "name": "Client side error in the request.", "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 \"key\": \"\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f1995c8c-4c5f-48e2-942f-8c1b807532fc" }, { "id": "e3274e56-5ffc-4584-ad8c-c87ca576e200", "name": "The specified VPG 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 \"key\": \"\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/ip_address_map", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "ip_address_map" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e3274e56-5ffc-4584-ad8c-c87ca576e200" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-534bac62-fcab-445a-9351-8b23696ac1ee" } ], "id": "83f6d54b-817a-43f9-a736-e2e05b042db8", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-83f6d54b-817a-43f9-a736-e2e05b042db8" }, { "name": "junction", "item": [ { "name": "mirroring", "item": [ { "name": "peers", "item": [ { "name": "{ipaddr}", "item": [ { "name": "Remove peer from the list of Junction mirroring peers", "id": "df1df41b-bb57-4166-b1f6-1db060409008", "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}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "id": "44231a17-196a-4602-8ada-6c5b7dad0b17", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" }, { "id": "9b43dd41-0886-427a-adbb-4006a1e17134", "key": "ipaddr", "value": "", "description": "(Required) IP address of mirroring peer" } ] }, "description": "Remove peer from the list of Junction mirroring peers." }, "response": [ { "id": "7db4143c-6a07-4c03-ac35-57afbb5ebb33", "name": "Mirroring peer removed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "key": "vpg_id" }, { "key": "ipaddr" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7db4143c-6a07-4c03-ac35-57afbb5ebb33" }, { "id": "7ff2f5bb-ebc7-44c0-afa2-2f4379d146d5", "name": "No such VPG found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "key": "vpg_id" }, { "key": "ipaddr" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7ff2f5bb-ebc7-44c0-afa2-2f4379d146d5" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-df1df41b-bb57-4166-b1f6-1db060409008" }, { "name": "Updates a Junction mirroring peer", "id": "91981886-bff9-43d6-8390-312563c8e0ba", "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" } ], "body": { "mode": "raw", "raw": "[\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "id": "03dbf5f1-9ad0-4dec-83c5-239a8ab366aa", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" }, { "id": "b21ab916-10e4-4c7c-9842-70246ecc51e4", "key": "ipaddr", "value": "", "description": "(Required) Mirroring peer IP address" } ] }, "description": "Updates a Junction mirroring peer." }, "response": [ { "id": "72947b94-34f1-4716-98e1-28b40a732bf6", "name": "Mirroring peer updated", "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 \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "key": "vpg_id" }, { "key": "ipaddr" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-72947b94-34f1-4716-98e1-28b40a732bf6" }, { "id": "3e4f44f9-a74d-4ebe-811c-71c523547a3c", "name": "No such VPG 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 \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers", ":ipaddr" ], "variable": [ { "key": "vpg_id" }, { "key": "ipaddr" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3e4f44f9-a74d-4ebe-811c-71c523547a3c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-91981886-bff9-43d6-8390-312563c8e0ba" } ], "id": "1fd706bb-9222-498f-bcfd-0d1669d5186f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1fd706bb-9222-498f-bcfd-0d1669d5186f" }, { "name": "Adds node in the list of Junction mirroring peers", "id": "6c69f0f0-2e23-4f23-807c-088b9d7b771a", "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" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers" ], "variable": [ { "id": "b64a0b88-d36e-437d-8b62-0e9dade74087", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Adds node in the list of Junction mirroring peers." }, "response": [ { "id": "8d6da2d7-09da-4528-ab6d-40e0af91f6f6", "name": "Mirroring peer added/updated", "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 \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8d6da2d7-09da-4528-ab6d-40e0af91f6f6" }, { "id": "389c308c-8606-411a-b157-dfc0e518bf33", "name": "No such VPG 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 \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/mirroring/peers", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "mirroring", "peers" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-389c308c-8606-411a-b157-dfc0e518bf33" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6c69f0f0-2e23-4f23-807c-088b9d7b771a" } ], "id": "9c546997-78d9-4b3e-a09f-d4c2b6e827ab", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9c546997-78d9-4b3e-a09f-d4c2b6e827ab" } ], "id": "c36150f4-d5a3-439a-9186-1aa72efba271", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-c36150f4-d5a3-439a-9186-1aa72efba271" }, { "name": "set_inspection", "item": [ { "name": "Sets configuration for Junction inspection feature", "id": "deea0afd-e9ff-4ead-b76d-8917d92df706", "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" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"text\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_inspection" ], "variable": [ { "id": "d866c7b1-542b-446a-a125-6b6a1b783c4f", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Sets configuration for Junction inspection feature." }, "response": [ { "id": "fed12a8e-02dd-47fc-8fe8-b8c127819264", "name": "Configuration added/updated", "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 \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"text\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_inspection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fed12a8e-02dd-47fc-8fe8-b8c127819264" }, { "id": "74c69da6-edc4-4d8f-9c3d-bd52ddaf658c", "name": "No such VPG 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 \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"text\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_inspection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-74c69da6-edc4-4d8f-9c3d-bd52ddaf658c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-deea0afd-e9ff-4ead-b76d-8917d92df706" } ], "id": "e07f2c73-be9b-4ee9-b54e-61c1d2c4abc0", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e07f2c73-be9b-4ee9-b54e-61c1d2c4abc0" }, { "name": "set_redirection", "item": [ { "name": "Sets configuration for Junction redirection feature", "id": "00e1da40-415b-42ec-9804-807cd5dad6a8", "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" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_redirection" ], "variable": [ { "id": "cd5b6817-60a4-480e-8b14-47ce3c651284", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Sets configuration for Junction redirection feature." }, "response": [ { "id": "2b0c16a8-a9d9-4f91-83ca-30fdababe353", "name": "Configuration added/updated", "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 \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_redirection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2b0c16a8-a9d9-4f91-83ca-30fdababe353" }, { "id": "7b0c79e1-15ff-40ce-87d1-b0e362a2dd70", "name": "No such VPG 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 \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/set_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "set_redirection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7b0c79e1-15ff-40ce-87d1-b0e362a2dd70" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-00e1da40-415b-42ec-9804-807cd5dad6a8" } ], "id": "d54d24ce-bde9-4acd-b596-59395de35da4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d54d24ce-bde9-4acd-b596-59395de35da4" }, { "name": "unset_inspection", "item": [ { "name": "Unset configuration for Junction inspection feature", "id": "dd02faa2-0e2c-448d-8f1a-be0384e89e0f", "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}}/virtual_private_gateways/:vpg_id/junction/unset_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_inspection" ], "variable": [ { "id": "4f4a38fa-688e-40a5-b543-e556dafaad74", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Unset configuration for Junction inspection feature." }, "response": [ { "id": "a1b270e7-bf02-4d62-b4dd-fd59105575b1", "name": "Configuration unset", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/unset_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_inspection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a1b270e7-bf02-4d62-b4dd-fd59105575b1" }, { "id": "db08c383-9bfc-4b06-a9a1-0b2a65adec3a", "name": "No such VPG found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/unset_inspection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_inspection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-db08c383-9bfc-4b06-a9a1-0b2a65adec3a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-dd02faa2-0e2c-448d-8f1a-be0384e89e0f" } ], "id": "3017b160-a3e0-4088-9a8e-6c355ec7e5e1", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3017b160-a3e0-4088-9a8e-6c355ec7e5e1" }, { "name": "unset_redirection", "item": [ { "name": "Unset configuration for Junction redirection feature", "id": "f2cc5fdc-2aae-4c36-954e-9a8a9af3a565", "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}}/virtual_private_gateways/:vpg_id/junction/unset_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_redirection" ], "variable": [ { "id": "e7a1c3be-2956-4a52-a18b-e217caa7a115", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Unset configuration for Junction redirection feature." }, "response": [ { "id": "ea57eb4d-1fe6-43d7-8de3-ed44e52c21ab", "name": "Configuration unset", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/unset_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_redirection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ea57eb4d-1fe6-43d7-8de3-ed44e52c21ab" }, { "id": "419ecefd-9a0c-45a1-8ca3-9e155219b06e", "name": "No such VPG found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/junction/unset_redirection", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "junction", "unset_redirection" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-419ecefd-9a0c-45a1-8ca3-9e155219b06e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f2cc5fdc-2aae-4c36-954e-9a8a9af3a565" } ], "id": "b7e0ad67-bfe6-4646-93fa-189f3e87e31a", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b7e0ad67-bfe6-4646-93fa-189f3e87e31a" } ], "id": "11d42e11-b5a9-460d-9096-6a95f35182c3", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-11d42e11-b5a9-460d-9096-6a95f35182c3" }, { "name": "packet_capture_sessions", "item": [ { "name": "{session_id}", "item": [ { "name": "stop", "item": [ { "name": "Stop a packet capture session associated with the VPG", "id": "811947f1-b419-4dee-904b-bb42292fd282", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "id": "117a61c6-dcc0-4a4c-a48d-6de10edc7477", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" }, { "id": "f1f0ab8f-ee3e-4be8-8ea1-28f83c5f79ea", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Stop a packet capture session associated with the VPG." }, "response": [ { "id": "aec2c3cb-ce3e-4bce-bcc5-d1fe2d4dcd55", "name": "The stopped packet capture session associated with the VPG", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "vpg_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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aec2c3cb-ce3e-4bce-bcc5-d1fe2d4dcd55" }, { "id": "f52ab82f-ddf3-4433-917e-caad88efec98", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-f52ab82f-ddf3-4433-917e-caad88efec98" }, { "id": "9ed1b389-ccb8-4dc4-a83f-92a707445dbd", "name": "The packet capture session associated with the VPG 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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9ed1b389-ccb8-4dc4-a83f-92a707445dbd" }, { "id": "6cb257ea-cbcd-4c4c-831f-6ccd7a087c38", "name": "The packet capture session associated with the VPG 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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id", "stop" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-6cb257ea-cbcd-4c4c-831f-6ccd7a087c38" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-811947f1-b419-4dee-904b-bb42292fd282" } ], "id": "03dcb0e5-b192-45d3-9def-c137a0ef5bdf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-03dcb0e5-b192-45d3-9def-c137a0ef5bdf" }, { "name": "Delete a packet capture session associated with the VPG", "id": "f04f3df9-b6c9-4cfe-9a9a-69e9c5d9c409", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "id": "d672a517-19c0-4fe5-9f1e-24957f7fcc33", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" }, { "id": "273fdb78-e55d-4643-879d-f6e9a07f7d24", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Delete a packet capture session associated with the VPG." }, "response": [ { "id": "472b93b0-3cc1-4943-aa27-b6ac1475eff1", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "vpg_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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-472b93b0-3cc1-4943-aa27-b6ac1475eff1" }, { "id": "c25fb82f-a51f-4a81-a5db-9e349d2fae3c", "name": "Failed to delete the packet capture session associated with the VPG", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c25fb82f-a51f-4a81-a5db-9e349d2fae3c" }, { "id": "88d2087f-faa5-41ba-864f-cc2257ca8eb3", "name": "The packet capture session associated with the VPG 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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-88d2087f-faa5-41ba-864f-cc2257ca8eb3" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f04f3df9-b6c9-4cfe-9a9a-69e9c5d9c409" }, { "name": "Get a packet capture session associated with the VPG", "id": "ef82938a-fd9b-43be-8355-21d271465b35", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "id": "f1527e03-a648-4181-99ea-d8e51ac9d629", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" }, { "id": "b2b721f8-6b55-4e50-b7b4-8b4d93629fa3", "key": "session_id", "value": "", "description": "(Required) Packet capture session ID" } ] }, "description": "Get a packet capture session associated with the VPG." }, "response": [ { "id": "d7560297-7220-49ea-8890-51a88235ac91", "name": "The packet capture sessions associated with the VPG", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "vpg_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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-d7560297-7220-49ea-8890-51a88235ac91" }, { "id": "3fbcac26-6f6b-4e02-ac6f-82da993055ef", "name": "The packet capture session associated with the VPG 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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions", ":session_id" ], "variable": [ { "key": "vpg_id" }, { "key": "session_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-3fbcac26-6f6b-4e02-ac6f-82da993055ef" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ef82938a-fd9b-43be-8355-21d271465b35" } ], "id": "235e7d01-1953-4433-a29a-2f488caa21b6", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-235e7d01-1953-4433-a29a-2f488caa21b6" }, { "name": "List Packet Capture Sessions associated with the VPG", "id": "cbd6bc98-4ffe-473d-8087-21774fa65ebe", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions?last_evaluated_key=null&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "query": [ { "description": "ID of the last packet capture session in the previous page. By specifying this parameter, you can continue to retrieve the list from the next packet capture session onward.", "key": "last_evaluated_key", "value": "null" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "id": "ef087a10-fe19-41aa-bce9-d2bac57148e1", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "List packet capture sessions associated with the VPG." }, "response": [ { "id": "14b3837c-2eb5-4141-9a67-31003c5dd18b", "name": "List of packet capture sessions associated with the VPG", "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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions?last_evaluated_key=null&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "query": [ { "description": "ID of the last packet capture session in the previous page. By specifying this parameter, you can continue to retrieve the list from the next packet capture session onward.", "key": "last_evaluated_key", "value": "null" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "key": "vpg_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\": \"DONE\",\n \"url\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"duration\": \"\",\n \"endedTime\": \"\",\n \"failedReason\": \"\",\n \"prefix\": \"\",\n \"sessionId\": \"\",\n \"startedTime\": \"\",\n \"status\": \"FAILED\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-14b3837c-2eb5-4141-9a67-31003c5dd18b" }, { "id": "1c706095-e336-43c6-8f02-6ef9fe221488", "name": "Failed to list packet capture sessions associated with the VPG", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions?last_evaluated_key=null&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "query": [ { "description": "ID of the last packet capture session in the previous page. By specifying this parameter, you can continue to retrieve the list from the next packet capture session onward.", "key": "last_evaluated_key", "value": "null" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-1c706095-e336-43c6-8f02-6ef9fe221488" }, { "id": "c8f2e0d9-f300-45ee-a847-0d250a855da9", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/packet_capture_sessions?last_evaluated_key=null&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "query": [ { "description": "ID of the last packet capture session in the previous page. By specifying this parameter, you can continue to retrieve the list from the next packet capture session onward.", "key": "last_evaluated_key", "value": "null" }, { "description": "Max number of results in a response.", "key": "limit", "value": "10" } ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c8f2e0d9-f300-45ee-a847-0d250a855da9" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-cbd6bc98-4ffe-473d-8087-21774fa65ebe" }, { "name": "Create a packet capture session associated with the VPG", "id": "95f6b3f3-9d39-44fb-8645-8ffc3c1e0cd5", "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\": \"p68NP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "variable": [ { "id": "72e2c739-7358-4351-ae82-25ff908fcbb0", "key": "vpg_id", "value": "", "description": "(Required) VPG ID" } ] }, "description": "Create a packet capture session associated with the VPG." }, "response": [ { "id": "4ffbc1e9-8e59-4561-b946-63c7754653f3", "name": "The packet capture sessions associated with the VPG", "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\": \"p68NP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "variable": [ { "key": "vpg_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\": \"STOPPED\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4ffbc1e9-8e59-4561-b946-63c7754653f3" }, { "id": "5393f598-ebb1-447c-b914-898502baef94", "name": "Failed to create a packet capture session associated with the VPG", "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\": \"p68NP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5393f598-ebb1-447c-b914-898502baef94" }, { "id": "aae4ef00-4ac4-4b79-856d-cae5312eea9c", "name": "The specified VPG 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 \"duration\": \"\",\n \"prefix\": \"p68NP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/packet_capture_sessions", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "packet_capture_sessions" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aae4ef00-4ac4-4b79-856d-cae5312eea9c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-95f6b3f3-9d39-44fb-8645-8ffc3c1e0cd5" } ], "id": "036d2c98-33f2-4b71-af96-d8958b60e69c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-036d2c98-33f2-4b71-af96-d8958b60e69c" }, { "name": "set_routing_filter", "item": [ { "name": "Sets Virtual Private Gateway outbound routing filter", "id": "8180f314-6fc7-4980-8e7d-bce9338d9000", "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" } ], "body": { "mode": "raw", "raw": "[\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/set_routing_filter", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "set_routing_filter" ], "variable": [ { "id": "125f7fde-c8ab-4e54-ad1c-a6d94263b366", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Sets Virtual Private Gateway outbound routing filter." }, "response": [ { "id": "5ee2a12d-4e3e-405d-b0f8-3a4c26c8e51b", "name": "The routing filter is successfully configured.", "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 {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/set_routing_filter", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "set_routing_filter" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5ee2a12d-4e3e-405d-b0f8-3a4c26c8e51b" }, { "id": "06dcae9b-a9f1-4aac-8823-e4edd0a2a824", "name": "Invalid argument is given", "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 {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/set_routing_filter", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "set_routing_filter" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-06dcae9b-a9f1-4aac-8823-e4edd0a2a824" }, { "id": "20a57add-4a8e-4242-a66d-d0f3ce2dda5a", "name": "The specified VPG 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 {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/set_routing_filter", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "set_routing_filter" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-20a57add-4a8e-4242-a66d-d0f3ce2dda5a" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8180f314-6fc7-4980-8e7d-bce9338d9000" } ], "id": "d5108b65-0124-4325-b595-01f06888fd41", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d5108b65-0124-4325-b595-01f06888fd41" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Delete a VPG Tag", "id": "3b8d5925-74c5-4961-9c1b-0625a72a8843", "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}}/virtual_private_gateways/:vpg_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags", ":tag_name" ], "variable": [ { "id": "b0dbc80a-dd63-4900-b133-b34e7975fc02", "key": "vpg_id", "value": "", "description": "(Required) " }, { "id": "d11cd3e6-b586-43d1-8f31-1b1fc0ee3556", "key": "tag_name", "value": "", "description": "(Required) " } ] }, "description": "Deletes a tag from the specified VPG." }, "response": [ { "id": "aa41f2fb-81b3-4b54-8f37-503e189d8645", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags", ":tag_name" ], "variable": [ { "key": "vpg_id" }, { "key": "tag_name" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aa41f2fb-81b3-4b54-8f37-503e189d8645" }, { "id": "569f9a66-2e06-49a3-b96d-a5b9b6baed42", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/tags/:tag_name", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags", ":tag_name" ], "variable": [ { "key": "vpg_id" }, { "key": "tag_name" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-569f9a66-2e06-49a3-b96d-a5b9b6baed42" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3b8d5925-74c5-4961-9c1b-0625a72a8843" } ], "id": "2967548a-5878-4458-a445-4c1f5eff55a9", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-2967548a-5878-4458-a445-4c1f5eff55a9" }, { "name": "Update VPG tags", "id": "9c7141be-5527-4c2e-8ce9-37ed37f77c85", "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" } ], "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}}/virtual_private_gateways/:vpg_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags" ], "variable": [ { "id": "44fdb8d1-15c0-4b20-829e-f8e859b2982d", "key": "vpg_id", "value": "", "description": "(Required) " } ] }, "description": "Adds/updates tags of the specified VPG." }, "response": [ { "id": "9cb78638-9f40-4e36-bbc6-1f565b502d09", "name": "OK", "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}}/virtual_private_gateways/:vpg_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-9cb78638-9f40-4e36-bbc6-1f565b502d09" }, { "id": "80e5e390-a977-4e6c-ac55-206a0f8dc962", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/tags", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "tags" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-80e5e390-a977-4e6c-ac55-206a0f8dc962" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-9c7141be-5527-4c2e-8ce9-37ed37f77c85" } ], "id": "52780fdc-80df-4654-9d5d-ae2618ea7a8c", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-52780fdc-80df-4654-9d5d-ae2618ea7a8c" }, { "name": "terminate", "item": [ { "name": "Terminate Virtual Private Gateway", "id": "77a1613f-b1c4-4ce3-8228-c13dde295cbb", "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}}/virtual_private_gateways/:vpg_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "terminate" ], "variable": [ { "id": "c40351ed-0cfa-4d3e-93d4-3a7ad32972a3", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Terminates the specified VPG." }, "response": [ { "id": "c54c0073-b87a-4dc0-a5f9-b0732cc2d960", "name": "Termination of specified VPG started.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "terminate" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c54c0073-b87a-4dc0-a5f9-b0732cc2d960" }, { "id": "30b98ca9-1764-475e-a79c-b665f100e741", "name": "There is a reason why the specified VPG cannot be terminated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "terminate" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-30b98ca9-1764-475e-a79c-b665f100e741" }, { "id": "8fe32748-dc07-490d-957f-6b0ebbd27a5c", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id/terminate", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "terminate" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-8fe32748-dc07-490d-957f-6b0ebbd27a5c" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-77a1613f-b1c4-4ce3-8228-c13dde295cbb" } ], "id": "d9dc901f-ec0b-4c25-af4a-e9fb3da54946", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d9dc901f-ec0b-4c25-af4a-e9fb3da54946" }, { "name": "transit_gateway_peering_connections", "item": [ { "name": "{soracom_tgw_peering_attachment_id}", "item": [ { "name": "Delete transit gateway peering connection", "id": "3a36b0a4-f98b-4c07-af09-1b6feeaf3460", "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}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections/:soracom_tgw_peering_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections", ":soracom_tgw_peering_attachment_id" ], "variable": [ { "id": "920a0fac-14f0-472a-9d8e-ff83fb7c914e", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "1a097813-4250-4434-8107-bf45d324869a", "key": "soracom_tgw_peering_attachment_id", "value": "", "description": "(Required) Transit gateway peering connection ID" } ] }, "description": "Deletes a transit gateway peering connection from the specified VPG." }, "response": [ { "id": "0c0e695c-e243-4b81-b7c7-8aef42abf3e9", "name": "Transit gateway peering connection deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections/:soracom_tgw_peering_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections", ":soracom_tgw_peering_attachment_id" ], "variable": [ { "key": "vpg_id" }, { "key": "soracom_tgw_peering_attachment_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0c0e695c-e243-4b81-b7c7-8aef42abf3e9" }, { "id": "7f4df9e1-7f3e-41dc-939b-a67aa8c4263e", "name": "The specified VPG or transit gateway peering connection 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}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections/:soracom_tgw_peering_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections", ":soracom_tgw_peering_attachment_id" ], "variable": [ { "key": "vpg_id" }, { "key": "soracom_tgw_peering_attachment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7f4df9e1-7f3e-41dc-939b-a67aa8c4263e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3a36b0a4-f98b-4c07-af09-1b6feeaf3460" } ], "id": "125631b4-36a9-4fcd-9635-ee27d157d0dc", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-125631b4-36a9-4fcd-9635-ee27d157d0dc" }, { "name": "Create transit gateway peering connection", "id": "97c6040b-cd17-4e23-80f7-9269cc4b6ace", "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 \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections" ], "variable": [ { "id": "ad9ec9c9-2550-4c4e-a536-801671167f06", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Creates a transit gateway peering connection for the specified VPG." }, "response": [ { "id": "dd402020-fde2-4a49-be7b-2b5ea51b5f88", "name": "Transit gateway peering connection 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 \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-dd402020-fde2-4a49-be7b-2b5ea51b5f88" }, { "id": "7c8318f4-f3ef-4679-8341-17af559b0b28", "name": "Invalid request", "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 \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-7c8318f4-f3ef-4679-8341-17af559b0b28" }, { "id": "e12da1a9-fd80-4c57-abfd-3568465d2c8d", "name": "The specified VPG 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 \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_peering_connections" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e12da1a9-fd80-4c57-abfd-3568465d2c8d" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-97c6040b-cd17-4e23-80f7-9269cc4b6ace" } ], "id": "e7f13343-3f89-45d8-9c39-21fffe1a32bf", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e7f13343-3f89-45d8-9c39-21fffe1a32bf" }, { "name": "transit_gateway_vpc_attachments", "item": [ { "name": "{customer_tgw_vpc_attachment_id}", "item": [ { "name": "accept", "item": [ { "name": "Accept transit gateway VPC attachment connection request", "id": "bd4103da-334f-4242-8857-9cd3b0ee2ebf", "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}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id", "accept" ], "variable": [ { "id": "d747bc01-150a-4513-8b94-cedb60c9f32d", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "60f06a90-7ff0-43c6-9041-b72373978cc8", "key": "customer_tgw_vpc_attachment_id", "value": "", "description": "(Required) Transit gateway VPC attachment ID" } ] }, "description": "Accepts the specified transit gateway VPC attachment connection request." }, "response": [ { "id": "5d489586-549e-49ff-92bd-e24297f430f3", "name": "Transit gateway VPC attachment connection accepted", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id", "accept" ], "variable": [ { "key": "vpg_id" }, { "key": "customer_tgw_vpc_attachment_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5d489586-549e-49ff-92bd-e24297f430f3" }, { "id": "aae1f5b0-292a-4ddb-b247-2888d9b99d5d", "name": "Invalid request", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id", "accept" ], "variable": [ { "key": "vpg_id" }, { "key": "customer_tgw_vpc_attachment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-aae1f5b0-292a-4ddb-b247-2888d9b99d5d" }, { "id": "17533785-a895-4aea-aa5a-efc85b422ee1", "name": "The specified VPG or transit gateway VPC attachment 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}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id", "accept" ], "variable": [ { "key": "vpg_id" }, { "key": "customer_tgw_vpc_attachment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-17533785-a895-4aea-aa5a-efc85b422ee1" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-bd4103da-334f-4242-8857-9cd3b0ee2ebf" } ], "id": "71e1c6a8-37bd-4840-b5e4-e77adb717ec7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-71e1c6a8-37bd-4840-b5e4-e77adb717ec7" }, { "name": "Delete transit gateway VPC attachment", "id": "40813ecc-f69e-438d-8594-d541e79d39bc", "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}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id" ], "variable": [ { "id": "640ea7d2-247b-4f62-9e20-b30c876fb23e", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "babda420-2fa5-4b3e-bc8c-0ffbba56d2dc", "key": "customer_tgw_vpc_attachment_id", "value": "", "description": "(Required) Transit gateway VPC attachment ID" } ] }, "description": "Deletes a transit gateway VPC attachment from the specified VPG." }, "response": [ { "id": "e9233d0c-503f-4682-be79-2b9c70675baf", "name": "Transit gateway VPC attachment deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id" ], "variable": [ { "key": "vpg_id" }, { "key": "customer_tgw_vpc_attachment_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-e9233d0c-503f-4682-be79-2b9c70675baf" }, { "id": "42f1f3a0-49dc-4fea-92d2-45cd69a87d8e", "name": "The specified VPG or transit gateway VPC attachment 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}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments", ":customer_tgw_vpc_attachment_id" ], "variable": [ { "key": "vpg_id" }, { "key": "customer_tgw_vpc_attachment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-42f1f3a0-49dc-4fea-92d2-45cd69a87d8e" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-40813ecc-f69e-438d-8594-d541e79d39bc" } ], "id": "f911c80d-45dc-4fb8-bd6f-4024abc3dc85", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f911c80d-45dc-4fb8-bd6f-4024abc3dc85" }, { "name": "Create transit gateway VPC attachment", "id": "e4ea8684-2807-4885-a611-561f2379c074", "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 \"customerAwsAccountId\": \"\",\n \"customerVpcId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments" ], "variable": [ { "id": "5841925f-ddd6-42c1-91ba-df1d30f6954e", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Creates a transit gateway VPC attachment for the specified VPG." }, "response": [ { "id": "0788e2a9-5cf3-4bcb-ab91-2332eaddb1cb", "name": "Transit gateway VPC attachment 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 \"customerAwsAccountId\": \"\",\n \"customerVpcId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0788e2a9-5cf3-4bcb-ab91-2332eaddb1cb" }, { "id": "a2edd001-4061-4a62-a489-d48481fb8464", "name": "Invalid request", "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 \"customerAwsAccountId\": \"\",\n \"customerVpcId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a2edd001-4061-4a62-a489-d48481fb8464" }, { "id": "2dc9f8c0-5308-4274-be0a-e388039d8979", "name": "The specified VPG 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 \"customerAwsAccountId\": \"\",\n \"customerVpcId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "transit_gateway_vpc_attachments" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2dc9f8c0-5308-4274-be0a-e388039d8979" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e4ea8684-2807-4885-a611-561f2379c074" } ], "id": "11117234-c647-4807-9dda-166fe232ddd7", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-11117234-c647-4807-9dda-166fe232ddd7" }, { "name": "vpc_peering_connections", "item": [ { "name": "{pcx_id}", "item": [ { "name": "Delete VPC Peering Connection", "id": "22489bf0-d391-4dac-a871-087af0caa509", "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}}/virtual_private_gateways/:vpg_id/vpc_peering_connections/:pcx_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections", ":pcx_id" ], "variable": [ { "id": "6c3db270-03e9-4954-bf87-f83032c15b8b", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." }, { "id": "f818847c-71b9-4a98-a104-227b2ea54d06", "key": "pcx_id", "value": "", "description": "(Required) VPC peering connection ID to be deleted." } ] }, "description": "Deletes the specified VPC peering connection." }, "response": [ { "id": "2690269e-18c3-4066-a1c8-3db837641e36", "name": "Deletion of specified VPC peering connection complete.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/vpc_peering_connections/:pcx_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections", ":pcx_id" ], "variable": [ { "key": "vpg_id" }, { "key": "pcx_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-2690269e-18c3-4066-a1c8-3db837641e36" }, { "id": "354b2182-63de-498e-bd54-fc2bb1934931", "name": "The specified VPC peering connection 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}}/virtual_private_gateways/:vpg_id/vpc_peering_connections/:pcx_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections", ":pcx_id" ], "variable": [ { "key": "vpg_id" }, { "key": "pcx_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-354b2182-63de-498e-bd54-fc2bb1934931" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-22489bf0-d391-4dac-a871-087af0caa509" } ], "id": "8da6a3c0-094a-44f1-80fa-20161eb05d97", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8da6a3c0-094a-44f1-80fa-20161eb05d97" }, { "name": "Create VPC Peering Connection", "id": "031f9bfa-a950-4c08-acb4-a807f05025d8", "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 \"destinationCidrBlock\": \"\",\n \"peerOwnerId\": \"\",\n \"peerRegion\": \"\",\n \"peerVpcId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/vpc_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections" ], "variable": [ { "id": "21f9882a-6d1d-4ce5-81e5-e032904f2510", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Creates a VPC peering connection for the specified VPG." }, "response": [ { "id": "c359cdba-0b4f-46ea-bd6c-26e3729c2dbe", "name": "The created VPC peering connection.", "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 \"destinationCidrBlock\": \"\",\n \"peerOwnerId\": \"\",\n \"peerRegion\": \"\",\n \"peerVpcId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/vpc_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinationCidrBlock\": \"\",\n \"peerOwnerId\": \"\",\n \"peerRegion\": \"\",\n \"peerVpcId\": \"\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-c359cdba-0b4f-46ea-bd6c-26e3729c2dbe" }, { "id": "455ed061-30c6-4c2d-a487-1d1e59703364", "name": "The specified VPC peering connection 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 \"destinationCidrBlock\": \"\",\n \"peerOwnerId\": \"\",\n \"peerRegion\": \"\",\n \"peerVpcId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways/:vpg_id/vpc_peering_connections", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id", "vpc_peering_connections" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-455ed061-30c6-4c2d-a487-1d1e59703364" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-031f9bfa-a950-4c08-acb4-a807f05025d8" } ], "id": "e2a7147f-45a6-4695-a770-82fe34c1fbee", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-e2a7147f-45a6-4695-a770-82fe34c1fbee" }, { "name": "Get Virtual Private Gateway", "id": "d6ddf9cc-6ace-4651-bcfe-4143797498b5", "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}}/virtual_private_gateways/:vpg_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id" ], "variable": [ { "id": "0a01fa11-042b-4307-a65e-17c33b60b43f", "key": "vpg_id", "value": "", "description": "(Required) Target VPG ID." } ] }, "description": "Retrieves information about the specified VPG." }, "response": [ { "id": "a7d4980c-5bdb-4758-9447-3389a44e469e", "name": "The specified VPG.", "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}}/virtual_private_gateways/:vpg_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-a7d4980c-5bdb-4758-9447-3389a44e469e" }, { "id": "fe2310e1-75dc-48a1-9a13-c2418e107c3b", "name": "The specified VPG 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}}/virtual_private_gateways/:vpg_id", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways", ":vpg_id" ], "variable": [ { "key": "vpg_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-fe2310e1-75dc-48a1-9a13-c2418e107c3b" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-d6ddf9cc-6ace-4651-bcfe-4143797498b5" } ], "id": "8fc8fdd7-979b-40d6-9810-22a744ac3260", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8fc8fdd7-979b-40d6-9810-22a744ac3260" }, { "name": "List Virtual Private Gateways", "id": "6bd235c4-1567-4831-bcf9-bf3a49c4df20", "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}}/virtual_private_gateways?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways" ], "query": [ { "description": "Tag name of the VPG. Filters through all VPGs that exactly match the tag name. When tag_name is specified, tag_value is required.", "key": "tag_name", "value": "" }, { "description": "Tag value of the VPG.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last VPG ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next VPG onward.", "key": "last_evaluated_key", "value": "" } ] }, "description": "Returns a list of VPGs." }, "response": [ { "id": "4f7c565a-5d19-41ea-8973-b10f60aeceed", "name": "List of VPGs.", "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}}/virtual_private_gateways?tag_name=&tag_value=&tag_value_match_mode=exact&limit=&last_evaluated_key=", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways" ], "query": [ { "description": "Tag name of the VPG. Filters through all VPGs that exactly match the tag name. When tag_name is specified, tag_value is required.", "key": "tag_name", "value": "" }, { "description": "Tag value of the VPG.", "key": "tag_value", "value": "" }, { "description": "Tag match mode.", "key": "tag_value_match_mode", "value": "exact" }, { "description": "Maximum number of results per response page.", "key": "limit", "value": "" }, { "description": "The last VPG ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next VPG 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 \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"proidentfc\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n },\n \"sed_77\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n },\n \"dolore__\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"nulla5\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n },\n \"fugiat_9\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"exercitation0d\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"eu-central-1\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"ullamco_1\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"mollitd4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"aliqua8b1\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"ullamco0a\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"anim8d\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"anim_7\": \"\",\n \"Duis6\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"enim_9\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"anim_a4\": \"\",\n \"ine94\": \"\",\n \"ex95d\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"voluptate1\": \"\",\n \"deseruntce\": \"\",\n \"in14\": \"\",\n \"sint_3d8\": \"\",\n \"commodo036\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"proidente79\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"culpab80\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n },\n {\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"Duisc4\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"json\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"ut_95d\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"eu-central-1\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"consectetur_f30\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"adipisicing033\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"occaecat1c\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"voluptatef2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"pending\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"minim_cf\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"failed\"\n },\n \"quis_54b\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"failed\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"aute7\": \"\",\n \"culpae\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"dolorb\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 14,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cillum__d\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"irureed\": \"\",\n \"sedee3\": \"\",\n \"pariatur_a\": \"\",\n \"in_d\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"ut44\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-4f7c565a-5d19-41ea-8973-b10f60aeceed" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-6bd235c4-1567-4831-bcf9-bf3a49c4df20" }, { "name": "Create Virtual Private Gateway", "id": "5c5d62fd-3659-4717-a57e-da4ca209e679", "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\": 14,\n \"deviceSubnetCidrRange\": \"10.128.0.0/9\",\n \"placement\": {\n \"region\": \"ap-southeast-2\"\n },\n \"soracomTransitGateway\": {\n \"asn\": \"\"\n },\n \"tags\": {\n \"dolor_98\": \"\",\n \"deseruntcf\": \"\",\n \"veniam661\": \"\"\n },\n \"useInternetGateway\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways" ] }, "description": "Create a new VPG." }, "response": [ { "id": "01262295-dccc-4289-9f97-ad71cd682c7f", "name": "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\": 14,\n \"deviceSubnetCidrRange\": \"10.128.0.0/9\",\n \"placement\": {\n \"region\": \"ap-southeast-2\"\n },\n \"soracomTransitGateway\": {\n \"asn\": \"\"\n },\n \"tags\": {\n \"dolor_98\": \"\",\n \"deseruntcf\": \"\",\n \"veniam661\": \"\"\n },\n \"useInternetGateway\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/virtual_private_gateways", "host": [ "{{baseUrl}}" ], "path": [ "virtual_private_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedOperators\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"customerRoutes\": {\n \"in_21f\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"dynamic\"\n },\n \"consectetur_b\": {\n \"destinationCidr\": \"\",\n \"id\": \"\",\n \"target\": \"\",\n \"type\": \"static\"\n }\n },\n \"deviceSubnetCidrRange\": \"\",\n \"enableSimBasedRouting\": \"\",\n \"fixedIpAddressesEnabled\": \"\",\n \"fixedPublicIpAddresses\": [\n \"\",\n \"\"\n ],\n \"gateOpened\": \"\",\n \"gatePrivacySeparatorEnabled\": \"\",\n \"gateVxlanId\": \"\",\n \"implicitTerminationProtected\": \"\",\n \"inspection\": {\n \"enabled\": false,\n \"report\": {\n \"addSimId\": false,\n \"contentType\": \"unspecified\",\n \"credentialsId\": \"\",\n \"destination\": {\n \"provider\": \"\",\n \"resourceUrl\": \"\",\n \"service\": \"\"\n },\n \"enabled\": false\n }\n },\n \"junctionEnabled\": \"\",\n \"lastModifiedTime\": \"\",\n \"mirroring\": {\n \"peers\": {\n \"enim__\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n },\n \"esse_b3\": {\n \"description\": \"\",\n \"enabled\": false,\n \"ipAddress\": \"\",\n \"protocol\": \"gre\"\n }\n }\n },\n \"offsetId\": \"\",\n \"operatorId\": \"\",\n \"placement\": {\n \"infrastructureProvider\": \"aws\",\n \"region\": \"us-west-2\"\n },\n \"primaryServiceName\": \"\",\n \"redirection\": {\n \"description\": \"\",\n \"enabled\": \"\",\n \"gateway\": \"\"\n },\n \"routingFilterEntries\": [\n {\n \"action\": \"allow\",\n \"ipRange\": \"\"\n },\n {\n \"action\": \"deny\",\n \"ipRange\": \"\"\n }\n ],\n \"sessionStats\": {\n \"lastUpdatedAt\": \"\",\n \"online\": \"\"\n },\n \"simBasedRoutingConfig\": {\n \"mollit62\": \"\"\n },\n \"size\": \"\",\n \"soracomTransitGateway\": {\n \"arn\": \"\",\n \"asn\": \"\",\n \"awsAccountId\": \"\",\n \"id\": \"\",\n \"region\": \"\",\n \"resourceSharedStatus\": {\n \"fugiat71\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n },\n \"euc\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"lastModifiedTime\": \"\",\n \"resourceShareArn\": \"\",\n \"status\": \"\"\n }\n }\n },\n \"soracomTransitGatewayPeeringConnections\": {\n \"in_5\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"Lorembe4\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"quid2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"in_0\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n },\n \"exercitation_b2\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerRegion\": \"\",\n \"customerTransitGatewayId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"soracomTransitGatewayPeeringAttachmentId\": \"\",\n \"status\": \"active\"\n }\n },\n \"soracomTransitGatewayVpcAttachments\": {\n \"qui_3e\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"vpcAttachmentPending\"\n },\n \"cupidatat_b0_\": {\n \"createdTime\": \"\",\n \"customerAwsAccountId\": \"\",\n \"customerTransitGatewayVpcAttachmentId\": \"\",\n \"customerVpcId\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n },\n \"status\": \"running\",\n \"tags\": {\n \"adipisicingc50\": \"\",\n \"qui_3\": \"\"\n },\n \"transitGatewayAttachments\": {\n \"reprehenderit_7\": {\n \"destinationCidrBlocks\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"tgwId\": \"\"\n }\n },\n \"type\": 242,\n \"ueSubnetCidrRange\": \"\",\n \"useInternetGateway\": \"\",\n \"virtualInterfaces\": {\n \"cupidatat0\": \"\"\n },\n \"vpcPeeringConnections\": {\n \"proident_23\": \"\",\n \"magna7a\": \"\"\n },\n \"vpgId\": \"\",\n \"vpgSubnetCidrRange\": \"\",\n \"vpnConnections\": {\n \"voluptate77f\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n },\n \"sedf19\": {\n \"bgpAsn\": \"\",\n \"id\": \"\",\n \"useDynamicRouting\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-01262295-dccc-4289-9f97-ad71cd682c7f" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-5c5d62fd-3659-4717-a57e-da4ca209e679" } ], "id": "a1f00b29-0133-46ef-8895-e185860ef0ff", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-a1f00b29-0133-46ef-8895-e185860ef0ff" }, { "name": "volume_discounts", "item": [ { "name": "{contract_id}", "item": [ { "name": "Get long term discount", "id": "890fabc4-93bd-49f7-b881-9eec66a48b8a", "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}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "id": "38edde4c-c16c-45ed-b49f-ee4b8c0f45c6", "key": "contract_id", "value": "", "description": "(Required) Contract ID." } ] }, "description": "Returns contracted long term discount.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "02215d1a-9e0c-42fa-98c1-ecd3ff58a109", "name": "OK.", "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}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "key": "contract_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"expired\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-02215d1a-9e0c-42fa-98c1-ecd3ff58a109" }, { "id": "ff8a596b-f920-4901-824b-20ff15892a79", "name": "Long term discount not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "key": "contract_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ff8a596b-f920-4901-824b-20ff15892a79" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-890fabc4-93bd-49f7-b881-9eec66a48b8a" } ], "id": "b10abba2-f3ea-4576-981c-a8da59655324", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-b10abba2-f3ea-4576-981c-a8da59655324" }, { "name": "{order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm long-term discount order", "id": "3dcbb744-6b30-4490-afc0-a83e1618925f", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":order_id", "confirm" ], "variable": [ { "id": "a2c9a013-22a2-4871-9b1c-76cf45ca2591", "key": "order_id", "value": "", "description": "(Required) Order ID. The order ID can be obtained from the [Order:createVolumeDiscountQuotation API](#/Order/createVolumeDiscountQuotation)." } ] }, "description": "Performs a credit check and confirms the order if there are no issues." }, "response": [ { "id": "5f601119-a32d-4474-9518-1b9ecf6dedf0", "name": "The confirmed long-term discount order.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"expired\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-5f601119-a32d-4474-9518-1b9ecf6dedf0" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-3dcbb744-6b30-4490-afc0-a83e1618925f" } ], "id": "f67ffc25-cbb1-4abc-8996-3d971a751e0f", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-f67ffc25-cbb1-4abc-8996-3d971a751e0f" } ], "id": "ff5a72bf-dbf6-4835-89eb-3d67fb5cf0d4", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ff5a72bf-dbf6-4835-89eb-3d67fb5cf0d4" }, { "name": "available_discounts", "item": [ { "name": "List available long term discounts", "id": "86932aa8-35c1-471e-894e-7a60a68e9cb0", "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}}/volume_discounts/available_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", "available_discounts" ] }, "description": "Returns a list of available long term discounts." }, "response": [ { "id": "0d8a94cd-1307-4b16-9c18-989ca56f6796", "name": "A list of available long term discounts.", "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}}/volume_discounts/available_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", "available_discounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"availableLongTermDiscounts\": [\n {\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n },\n {\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-0d8a94cd-1307-4b16-9c18-989ca56f6796" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-86932aa8-35c1-471e-894e-7a60a68e9cb0" } ], "id": "eefa6180-5dc3-4d5f-9c74-648579ea7d83", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-eefa6180-5dc3-4d5f-9c74-648579ea7d83" }, { "name": "List long term discounts", "id": "1b6ccafb-bc9f-428c-acbd-0e073aefdf36", "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}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] }, "description": "Returns a list of contracted long term discounts.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "ddcd8d94-449d-4ab1-8897-7bdf1b9329d4", "name": "OK.", "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}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"volumeDiscountList\": [\n {\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"EUR\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"active\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n },\n {\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"EUR\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"active\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"MONTHLY\",\n \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\"\n }\n ]\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-ddcd8d94-449d-4ab1-8897-7bdf1b9329d4" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-1b6ccafb-bc9f-428c-acbd-0e073aefdf36" }, { "name": "Create long term discount quotation", "id": "8f31b938-2322-4995-9de0-cd2f88479c91", "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 \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"contractTermMonth\": 12,\n \"quantity\": \"\",\n \"startDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] }, "description": "Creates a new long term discount quotation. If the orderId is put in /volume_discounts/{order_id}/confirm, the order is complete (Currently, long term discount is only applied to plan-D (without bundle), plan-K)." }, "response": [ { "id": "842970b2-465c-4b7d-942e-d81c33c96cce", "name": "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 \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"contractTermMonth\": 12,\n \"quantity\": \"\",\n \"startDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"currency\": \"EUR\",\n \"orderId\": \"\",\n \"taxAmount\": \"\",\n \"totalAmount\": \"\",\n \"volumeDiscount\": {\n \"contractTermMonth\": 12,\n \"currency\": \"EUR\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"taxIncludedInitialCost\": \"\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"MONTHLY\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n }\n}", "createdAt": "2026-06-05T15:19:03.000Z", "updatedAt": "2026-06-05T15:19:03.000Z", "uid": "35240-842970b2-465c-4b7d-942e-d81c33c96cce" } ], "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-8f31b938-2322-4995-9de0-cd2f88479c91" } ], "id": "ff2d8eab-f0e9-4a99-b455-24f400097789", "createdAt": "2026-06-05T15:19:02.000Z", "updatedAt": "2026-06-05T15:19:02.000Z", "uid": "35240-ff2d8eab-f0e9-4a99-b455-24f400097789" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }