{ "info": { "_postman_id": "114f7975-86f9-48f2-9f5c-939d6f070581", "name": "Soracom Cloud Camera Services API", "description": "Manage Soracom Cloud Camera Services (SoraCam) devices, recordings, images, and events.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "lastUpdatedBy": "35240", "uid": "35240-114f7975-86f9-48f2-9f5c-939d6f070581" }, "item": [ { "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": "50b764d2-7124-467d-b332-d65d800dce84", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "f37c04a0-c0df-4840-8e15-524428597457", "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": "e57a3d0e-a32a-4615-a47f-760af16624ff", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e57a3d0e-a32a-4615-a47f-760af16624ff" }, { "id": "5ad02028-605c-41f1-8638-609a07c78d0b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5ad02028-605c-41f1-8638-609a07c78d0b" }, { "id": "12dd2c79-e0fe-4777-a45b-7219be8fd730", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-12dd2c79-e0fe-4777-a45b-7219be8fd730" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-50b764d2-7124-467d-b332-d65d800dce84" }, { "name": "Update a firmware for a SoraCam compatible camera device", "id": "e0551220-e711-4a51-a661-9e4c081bae21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "4fafbe12-af9d-44f5-8dd7-15bc612cb59b", "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": "7b0e6dcb-f253-4a14-a4a4-8674dccee72a", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7b0e6dcb-f253-4a14-a4a4-8674dccee72a" }, { "id": "4add2eb8-3f05-4a7c-98d0-374607d4b5c8", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4add2eb8-3f05-4a7c-98d0-374607d4b5c8" }, { "id": "e815ed75-b19e-4741-8584-6743319cc033", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e815ed75-b19e-4741-8584-6743319cc033" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e0551220-e711-4a51-a661-9e4c081bae21" } ], "id": "f8489205-4837-4ecd-8aff-430b912497d1", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-f8489205-4837-4ecd-8aff-430b912497d1" } ], "id": "c2fb0a62-7792-4285-9d90-5f0d23f1012e", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-c2fb0a62-7792-4285-9d90-5f0d23f1012e" }, { "name": "license", "item": [ { "name": "Unassign the license from a SoraCam compatible camera device", "id": "12edcff4-e833-4c0f-8dd6-df097ffef27b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "3ccdba9d-3de6-405f-a455-717fdf4b790b", "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": "60adafb5-bf58-4503-aa94-0b4c682f646e", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-60adafb5-bf58-4503-aa94-0b4c682f646e" }, { "id": "8e10eb2a-e5c2-43fa-af07-21acd419e777", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-8e10eb2a-e5c2-43fa-af07-21acd419e777" }, { "id": "97a0106a-a9f8-4d16-993e-0db3ebfb35f9", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-97a0106a-a9f8-4d16-993e-0db3ebfb35f9" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-12edcff4-e833-4c0f-8dd6-df097ffef27b" }, { "name": "Update the assigned license for a SoraCam compatible camera device", "id": "4ea5c10e-54f3-4a51-9462-0367a279f23e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"CR7-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": "ed613b0a-7ee9-4eb0-b0cb-6ffa0834c2db", "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": "be4b292e-8e03-409f-ab62-f1ebafb8e37b", "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\": \"CR7-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\": \"CR7-SC\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-be4b292e-8e03-409f-ab62-f1ebafb8e37b" }, { "id": "9fbb730f-0933-4a08-a4c6-1a7bbdc97b9c", "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\": \"CR7-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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9fbb730f-0933-4a08-a4c6-1a7bbdc97b9c" }, { "id": "5b73ca63-c051-4840-9fdb-82ffcf2b92dd", "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\": \"CR7-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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5b73ca63-c051-4840-9fdb-82ffcf2b92dd" }, { "id": "851d3660-1828-4e97-9daf-29dbee1f7969", "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\": \"CR7-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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-851d3660-1828-4e97-9daf-29dbee1f7969" }, { "id": "d121fae1-3b25-453f-a923-06973b42bab8", "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\": \"CR7-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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-d121fae1-3b25-453f-a923-06973b42bab8" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4ea5c10e-54f3-4a51-9462-0367a279f23e" } ], "id": "fe808f50-5431-47b8-af28-f899bd1a3284", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-fe808f50-5431-47b8-af28-f899bd1a3284" }, { "name": "live_image", "item": [ { "name": "Get a live image from a SoraCam compatible camera device", "id": "3e9a3c61-d730-4345-a2ec-72aeba7d596c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "a6c9399a-228e-4d64-8330-407712f80b16", "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": "7f9c4932-a442-4ada-ac7c-0400f3c0a09b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7f9c4932-a442-4ada-ac7c-0400f3c0a09b" }, { "id": "04797bfa-2ea0-46e4-9ecb-88ea5728e8d7", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-04797bfa-2ea0-46e4-9ecb-88ea5728e8d7" }, { "id": "0a1b2763-1e3c-4b83-afd0-c455d630c611", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0a1b2763-1e3c-4b83-afd0-c455d630c611" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3e9a3c61-d730-4345-a2ec-72aeba7d596c" } ], "id": "a728f9c0-a81f-484e-b053-726f23d01f5d", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-a728f9c0-a81f-484e-b053-726f23d01f5d" }, { "name": "options", "item": [ { "name": "real_time_access", "item": [ { "name": "Enable or disable real-time access for a SoraCam-compatible camera", "id": "37c6bd6a-e1c9-4ae3-9d74-99250cbbbbd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "ac861b5e-587a-43c0-968e-c0aa3415c01a", "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": "6603c0ed-5014-4a37-aed1-3d5f9305f753", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6603c0ed-5014-4a37-aed1-3d5f9305f753" }, { "id": "80308a3a-4571-4868-9d96-c088f36ffe28", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-80308a3a-4571-4868-9d96-c088f36ffe28" }, { "id": "42d6a160-45ee-4d2a-afe4-dbf447e8aca7", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-42d6a160-45ee-4d2a-afe4-dbf447e8aca7" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-37c6bd6a-e1c9-4ae3-9d74-99250cbbbbd6" } ], "id": "0972b4ce-f263-4ecc-bfb5-940b462c068a", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-0972b4ce-f263-4ecc-bfb5-940b462c068a" }, { "name": "Retrieve enabled options for a SoraCam-compatible camera", "id": "41d345f3-3cdf-45e1-bf1b-352b003921c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "d9251bb2-bee3-4d21-9204-66a903681398", "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": "1da45343-3103-4372-9b96-64124ca59a8b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1da45343-3103-4372-9b96-64124ca59a8b" }, { "id": "0907206f-cb97-44e8-8ed8-7d944fbb564c", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0907206f-cb97-44e8-8ed8-7d944fbb564c" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-41d345f3-3cdf-45e1-bf1b-352b003921c8" } ], "id": "5bff71b1-bf40-4e0c-97ce-f96f1a12379f", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-5bff71b1-bf40-4e0c-97ce-f96f1a12379f" }, { "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": "b6927c68-e99b-44d8-99dc-b838f16c2d8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "3ebb0b40-ac5c-408b-9466-b6a90b10fbbb", "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": "c4301a12-85dd-461a-a108-8858c3baf799", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-c4301a12-85dd-461a-a108-8858c3baf799" }, { "id": "1d599bd3-7093-4e3c-80c7-d91c858ce748", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1d599bd3-7093-4e3c-80c7-d91c858ce748" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b6927c68-e99b-44d8-99dc-b838f16c2d8c" }, { "name": "Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image", "id": "0958f379-e0bd-4abe-9841-c79528d2a0c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "0127fc50-98f4-4b21-a1b4-e9cfc424142a", "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": "49ea12e9-be70-4ad5-9643-a41a97f48b46", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-49ea12e9-be70-4ad5-9643-a41a97f48b46" }, { "id": "57b4a9f5-384c-48be-a0dc-0412d3f6b3fa", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-57b4a9f5-384c-48be-a0dc-0412d3f6b3fa" }, { "id": "4a7755f0-f969-412f-b3c4-242a52b85f33", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4a7755f0-f969-412f-b3c4-242a52b85f33" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0958f379-e0bd-4abe-9841-c79528d2a0c2" } ], "id": "99b88517-22bd-452e-bed2-5e5bdec3c529", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-99b88517-22bd-452e-bed2-5e5bdec3c529" }, { "name": "motion", "item": [ { "name": "Retrieve the settings for motion detection", "id": "61a2b34b-d62f-4ed6-9a6c-315b00807a2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "a444fc34-7474-4c82-8e19-18c881a0b724", "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": "358aa18e-13b2-46ed-bf85-e89750630e5d", "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\": \"off\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-358aa18e-13b2-46ed-bf85-e89750630e5d" }, { "id": "1277a539-bf02-4b6b-bcc9-8710d289302d", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1277a539-bf02-4b6b-bcc9-8710d289302d" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-61a2b34b-d62f-4ed6-9a6c-315b00807a2b" }, { "name": "Change the settings for motion", "id": "80fbba3a-475b-4431-87cb-0ed7113c378a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"off\"\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": "b945f5d1-da8f-433f-84dc-77cd47b441f9", "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": "ff27e722-2e4d-4cfc-b20f-44320b193f0f", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-ff27e722-2e4d-4cfc-b20f-44320b193f0f" }, { "id": "8db950fa-40c8-4b16-8832-14425195054f", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-8db950fa-40c8-4b16-8832-14425195054f" }, { "id": "f67b1d69-9448-4002-961a-d82b16fc6df5", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f67b1d69-9448-4002-961a-d82b16fc6df5" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-80fbba3a-475b-4431-87cb-0ed7113c378a" } ], "id": "67a4f745-76fb-4dbb-9d65-8ab9fc1dadb2", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-67a4f745-76fb-4dbb-9d65-8ab9fc1dadb2" }, { "name": "motion_sensitivity", "item": [ { "name": "Retrieve the settings for motion sensitivity", "id": "0a0852a8-3039-4c8e-8d5f-429f3e37f541", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "960280f4-4743-4fe3-bbda-7e46555bb9a7", "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": "21126380-3ffd-4186-aa64-c16cdbf11283", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-21126380-3ffd-4186-aa64-c16cdbf11283" }, { "id": "da1b9174-df2b-4f6a-9e08-8635847029a2", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-da1b9174-df2b-4f6a-9e08-8635847029a2" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0a0852a8-3039-4c8e-8d5f-429f3e37f541" }, { "name": "Change the settings for motion sensitivity", "id": "e5ce96c6-622d-44f8-b675-d5ce946846a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "b54b8c8f-7959-4851-ac1a-d3333ca3e4f1", "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": "13905954-5e8f-4970-87b7-2eaff0d000f9", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-13905954-5e8f-4970-87b7-2eaff0d000f9" }, { "id": "dc61c51d-0d66-4076-b99c-cb74b757f6bc", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-dc61c51d-0d66-4076-b99c-cb74b757f6bc" }, { "id": "d88752ac-286e-4244-ad7a-7bc416e5c9bd", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-d88752ac-286e-4244-ad7a-7bc416e5c9bd" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e5ce96c6-622d-44f8-b675-d5ce946846a2" } ], "id": "42094976-56f5-45ea-92b5-a5e0bd7e9551", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-42094976-56f5-45ea-92b5-a5e0bd7e9551" }, { "name": "motion_tagging", "item": [ { "name": "Retrieve the display settings for motion tagging", "id": "f72a1fcc-4e81-48fb-8a9b-55a303d41e47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "d6776533-1874-489c-b466-0d3c86931df6", "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": "7c0738e7-a75c-4fdb-bd74-017075c5ff52", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7c0738e7-a75c-4fdb-bd74-017075c5ff52" }, { "id": "d2393c00-9d9a-45f3-91ec-3ac2b4e23441", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-d2393c00-9d9a-45f3-91ec-3ac2b4e23441" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f72a1fcc-4e81-48fb-8a9b-55a303d41e47" }, { "name": "Change the display settings for motion tagging", "id": "027734ae-7f23-4f26-b5ec-dade7c1d19cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "e7ddd727-3ecf-4579-9800-d8f22b653fcc", "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": "4e876446-4619-40df-918d-5481a143656b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4e876446-4619-40df-918d-5481a143656b" }, { "id": "9cea7fb2-01a6-41fa-a432-08e34212c7ad", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9cea7fb2-01a6-41fa-a432-08e34212c7ad" }, { "id": "ea8ad0fb-7ba6-4de2-b623-cc007e6b2447", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-ea8ad0fb-7ba6-4de2-b623-cc007e6b2447" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-027734ae-7f23-4f26-b5ec-dade7c1d19cf" } ], "id": "dbb93ff0-7df1-478b-8fc9-cd90269881b0", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-dbb93ff0-7df1-478b-8fc9-cd90269881b0" }, { "name": "night_vision", "item": [ { "name": "Retrieve the settings for night vision mode", "id": "cf4fbb80-3da1-4189-aef7-74808889eab4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "b19b4ed3-d76b-46b0-bcb5-28142e069ffa", "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": "0e76a73d-14b1-4e3e-b5eb-6fa9d910e105", "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\": \"off\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0e76a73d-14b1-4e3e-b5eb-6fa9d910e105" }, { "id": "e23e9a66-9af1-4272-b053-9ad30cb9c00f", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e23e9a66-9af1-4272-b053-9ad30cb9c00f" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-cf4fbb80-3da1-4189-aef7-74808889eab4" }, { "name": "Change the settings for night vision mode", "id": "708ae264-5819-4408-ad75-af06f8c38a40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"off\"\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": "8c5ab829-0b47-48fe-857d-d2edc643c963", "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": "7909136a-373a-404a-abf9-4f9ce0d22113", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7909136a-373a-404a-abf9-4f9ce0d22113" }, { "id": "83af38d5-232d-4be2-8f2e-b82bee25cc47", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-83af38d5-232d-4be2-8f2e-b82bee25cc47" }, { "id": "1001d14a-e70a-4448-85f7-d84ff0e522c9", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1001d14a-e70a-4448-85f7-d84ff0e522c9" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-708ae264-5819-4408-ad75-af06f8c38a40" } ], "id": "7012baa7-f43e-47fb-926e-aa99ab6954f2", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-7012baa7-f43e-47fb-926e-aa99ab6954f2" }, { "name": "quality", "item": [ { "name": "Retrieve the quality settings", "id": "40cb7a52-52df-485b-ab8d-cba7ebc50041", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "77f2b6a4-cd0f-4711-bccc-a40c500f1471", "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": "b6eb090d-b1b2-4aa8-bc2a-2a7c4160020d", "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\": \"high\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b6eb090d-b1b2-4aa8-bc2a-2a7c4160020d" }, { "id": "104d8917-8f45-4431-ae12-628b875fd753", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-104d8917-8f45-4431-ae12-628b875fd753" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-40cb7a52-52df-485b-ab8d-cba7ebc50041" }, { "name": "Change the quality settings", "id": "88835f4d-236e-480f-af90-0f1ec9603a7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"high\"\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": "9a0f9432-2d4c-4c92-89ba-c460b0183690", "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": "8cb9cb55-7f40-4d04-b464-a556832c4d95", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-8cb9cb55-7f40-4d04-b464-a556832c4d95" }, { "id": "4e45211d-331c-4389-9bab-cc4d32e7f938", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4e45211d-331c-4389-9bab-cc4d32e7f938" }, { "id": "9c9b304a-f8db-4fab-b73c-98d642251f38", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9c9b304a-f8db-4fab-b73c-98d642251f38" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-88835f4d-236e-480f-af90-0f1ec9603a7c" } ], "id": "1aa41ee5-b84c-4630-8f2f-f86c853e5df6", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-1aa41ee5-b84c-4630-8f2f-f86c853e5df6" }, { "name": "rotation", "item": [ { "name": "Retrieve the settings for rotating the image by 180 degrees", "id": "1c22bec0-08b0-4cad-bbce-2130ce979873", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "efb05f40-a778-4358-b1af-d4c94a270110", "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": "dbf0fb7f-eedb-4a8d-bd84-6ef79f857b8b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-dbf0fb7f-eedb-4a8d-bd84-6ef79f857b8b" }, { "id": "3e2341ec-8ca4-408f-be65-0f125a5f289f", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3e2341ec-8ca4-408f-be65-0f125a5f289f" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1c22bec0-08b0-4cad-bbce-2130ce979873" }, { "name": "Change the settings for rotating the image by 180 degrees", "id": "5efa461c-253d-472a-bc83-7691e466ec77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "b2b0d39f-9fe5-4b0f-9c62-0cc1efd57bca", "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": "cf59dcc5-00e2-4748-9165-737e6d6eeb97", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-cf59dcc5-00e2-4748-9165-737e6d6eeb97" }, { "id": "18507598-b4fd-4b51-86e2-6ff9c445e31d", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-18507598-b4fd-4b51-86e2-6ff9c445e31d" }, { "id": "846d0445-0ae1-43f7-b523-a37cd37ab266", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-846d0445-0ae1-43f7-b523-a37cd37ab266" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5efa461c-253d-472a-bc83-7691e466ec77" } ], "id": "69b95eba-e9fc-45b5-b95f-43c1f05e5662", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-69b95eba-e9fc-45b5-b95f-43c1f05e5662" }, { "name": "sound", "item": [ { "name": "Retrieve the settings for sound detection", "id": "201838f4-1566-4fe7-8ed4-56c476c85c0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "5a1a3265-38b9-4f9e-bf92-9e21154d48f1", "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": "543a0a00-3df0-4e5e-8050-786acf7d9812", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-543a0a00-3df0-4e5e-8050-786acf7d9812" }, { "id": "fb7fd5b7-f6a6-4e6e-a2aa-938a8037a395", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-fb7fd5b7-f6a6-4e6e-a2aa-938a8037a395" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-201838f4-1566-4fe7-8ed4-56c476c85c0a" }, { "name": "Change the settings for sound detection", "id": "27bc6e07-66ad-4ab3-b021-44efda6f4d24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "0c265c91-0b3a-4f29-96bc-eb6010a6bbf3", "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": "eb1f5330-9bd4-4aeb-a023-e365efbf278e", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-eb1f5330-9bd4-4aeb-a023-e365efbf278e" }, { "id": "5e6e8b4c-9195-4445-8668-c18a18b5d753", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5e6e8b4c-9195-4445-8668-c18a18b5d753" }, { "id": "14d54f31-dce0-406b-8ea1-609761878785", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-14d54f31-dce0-406b-8ea1-609761878785" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-27bc6e07-66ad-4ab3-b021-44efda6f4d24" } ], "id": "0fe3beee-7754-43d8-83c9-f283f6a79ef7", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-0fe3beee-7754-43d8-83c9-f283f6a79ef7" }, { "name": "sound_sensitivity", "item": [ { "name": "Retrieve the settings for sound sensitivity", "id": "7dad5609-6d64-4229-85fd-addd50168a7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "f0f15d41-997f-4fec-8277-c64b8e37dccb", "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": "616fbe6d-b0e9-475a-ac99-6b73400b3f75", "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\": \"high\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-616fbe6d-b0e9-475a-ac99-6b73400b3f75" }, { "id": "4b9f0b1d-9a43-4a80-9e2e-d2f3a8e7f5e1", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4b9f0b1d-9a43-4a80-9e2e-d2f3a8e7f5e1" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7dad5609-6d64-4229-85fd-addd50168a7a" }, { "name": "Change the settings for sound sensitivity", "id": "73ebe1d6-d461-4eaa-8b1a-566d499a8e55", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"high\"\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": "a3a8a5c0-bbec-41c8-a66a-f4f92eb2cfdd", "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": "aca8ac8f-a94b-469f-9147-e605a0496868", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-aca8ac8f-a94b-469f-9147-e605a0496868" }, { "id": "82d5e1f1-480f-44b7-8741-217375acc234", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-82d5e1f1-480f-44b7-8741-217375acc234" }, { "id": "20ec1863-13a6-4e93-b384-640d2da11ad9", "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\": \"high\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-20ec1863-13a6-4e93-b384-640d2da11ad9" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-73ebe1d6-d461-4eaa-8b1a-566d499a8e55" } ], "id": "cd31ffd4-654f-4094-910b-05881c5e0012", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-cd31ffd4-654f-4094-910b-05881c5e0012" }, { "name": "status_light", "item": [ { "name": "Retrieve the settings for the status light (indicator light that shows the status of the camera)", "id": "7effcade-f734-4b4e-8dfe-8c291c34fb79", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "32827291-2810-4207-8c71-b1517e556a11", "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": "4248e7ed-801d-4b57-98f2-2c567838e013", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4248e7ed-801d-4b57-98f2-2c567838e013" }, { "id": "55ca7d56-029e-4f72-b972-062111140e83", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-55ca7d56-029e-4f72-b972-062111140e83" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7effcade-f734-4b4e-8dfe-8c291c34fb79" }, { "name": "Change the settings for the status light (indicator light that shows the status of the camera)", "id": "7ee58d65-b0eb-4e63-8fd0-63364a2ba2ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "ba5b0995-ec49-4c9b-b580-faf436b08e1f", "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": "93f93e12-570f-446b-a536-ef5de75546ea", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-93f93e12-570f-446b-a536-ef5de75546ea" }, { "id": "e26dccdf-44d5-4c73-b0d7-9fa6ba045810", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e26dccdf-44d5-4c73-b0d7-9fa6ba045810" }, { "id": "7842ac09-b787-43e0-aa03-5b71abd0f617", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7842ac09-b787-43e0-aa03-5b71abd0f617" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7ee58d65-b0eb-4e63-8fd0-63364a2ba2ce" } ], "id": "52294316-5916-4a10-aa8a-4456358634dd", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-52294316-5916-4a10-aa8a-4456358634dd" }, { "name": "timestamp", "item": [ { "name": "Retrieve the display settings for the timestamp shown on the bottom right of the captured image", "id": "dd21c974-4aea-4aac-916b-12577c036538", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "dacc0dec-9f7a-44d0-8ca9-3723079e1f82", "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": "44194612-74c5-4fa6-86c7-d5e7cb23d27a", "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\": \"off\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-44194612-74c5-4fa6-86c7-d5e7cb23d27a" }, { "id": "feb429a0-33f8-4dfd-9445-e6f962d689a6", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-feb429a0-33f8-4dfd-9445-e6f962d689a6" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-dd21c974-4aea-4aac-916b-12577c036538" }, { "name": "Change the display settings for the timestamp shown on the bottom right of the captured image", "id": "4c4b0aac-da96-44e5-91bc-099101041fd4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"off\"\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": "eaa1b1f6-d77d-4ffd-aa94-ba3394b8b359", "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": "742b24c1-cb68-4f55-9192-a4366468b276", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-742b24c1-cb68-4f55-9192-a4366468b276" }, { "id": "a67cb025-bdaf-41f3-9d83-835bdae94ea9", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a67cb025-bdaf-41f3-9d83-835bdae94ea9" }, { "id": "3e7c2706-4174-4671-b967-9bab6cf32262", "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\": \"off\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3e7c2706-4174-4671-b967-9bab6cf32262" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4c4b0aac-da96-44e5-91bc-099101041fd4" } ], "id": "e6198a0d-0a42-4451-bb9f-363359cf7509", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-e6198a0d-0a42-4451-bb9f-363359cf7509" }, { "name": "Retrieve the camera's various settings", "id": "1829564c-56a6-4e2a-a4c9-d064289b95ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "f4f2258b-6ffe-4df8-a2dc-b4bc2a9961c9", "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": "01cbfb27-f834-42f9-9d8f-30bb9cbfe161", "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\": \"low\",\n \"statusLight\": \"on\",\n \"timestamp\": \"on\",\n \"logo\": \"on\",\n \"motion\": \"on\",\n \"motionSensitivity\": \"high\",\n \"motionTagging\": \"off\",\n \"sound\": \"off\",\n \"soundSensitivity\": \"low\",\n \"nightVision\": \"off\",\n \"rotation\": 0\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-01cbfb27-f834-42f9-9d8f-30bb9cbfe161" }, { "id": "6781ea21-0b6a-4332-b05a-3489b9b8b67b", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6781ea21-0b6a-4332-b05a-3489b9b8b67b" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1829564c-56a6-4e2a-a4c9-d064289b95ce" } ], "id": "cdcf586a-d0df-4a2e-aab9-cb09b530d012", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-cdcf586a-d0df-4a2e-aab9-cb09b530d012" } ], "id": "e8ee5e02-4fdd-4990-a08a-a663db5ce5cb", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-e8ee5e02-4fdd-4990-a08a-a663db5ce5cb" }, { "name": "data", "item": [ { "name": "{time}", "item": [ { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device and timestamp", "id": "da590517-cf63-4995-b8ea-daf7138e9685", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "bfb09151-2e94-465b-b934-c5709dcc849c", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "6197041e-862d-4b16-873c-8bf4e53fcbd5", "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": "8a41425d-f664-4af9-8b18-3c5700053f65", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-8a41425d-f664-4af9-8b18-3c5700053f65" }, { "id": "1e0a50f7-937e-429a-a5a1-e76ba3021615", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1e0a50f7-937e-429a-a5a1-e76ba3021615" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-da590517-cf63-4995-b8ea-daf7138e9685" } ], "id": "c0ae5312-0cd9-4db0-8521-3d20002b5fc0", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-c0ae5312-0cd9-4db0-8521-3d20002b5fc0" }, { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device", "id": "a2d019a6-eded-40f2-bd53-8835e241512b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "d0f9061e-6b09-4f2a-8aed-a6c6402f17d3", "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": "9b66a0e4-3e71-4497-b531-901a85777071", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9b66a0e4-3e71-4497-b531-901a85777071" }, { "id": "e8dd7929-36e2-40b2-bd4d-69b08864abc0", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e8dd7929-36e2-40b2-bd4d-69b08864abc0" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a2d019a6-eded-40f2-bd53-8835e241512b" } ], "id": "a63c5812-63a3-4260-b69d-df2aa31ad718", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-a63c5812-63a3-4260-b69d-df2aa31ad718" }, { "name": "events", "item": [ { "name": "List SoraCam events for the specified device.", "id": "1a4430ea-b20c-4ec6-9953-b3532e1bad04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "1fa3c983-3b43-4873-8486-3d696ed3c6b3", "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": "7c2f2c4f-2c82-463a-a022-846a6d4365aa", "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\": \"failed\",\n \"startTime\": \"\",\n \"type\": \"motion\"\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\": \"failed\",\n \"startTime\": \"\",\n \"type\": \"other\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7c2f2c4f-2c82-463a-a022-846a6d4365aa" }, { "id": "af1b85ef-bb92-466d-84cc-3c5c1ae86f73", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-af1b85ef-bb92-466d-84cc-3c5c1ae86f73" }, { "id": "ce2af901-b4a8-43c5-a3a2-e9292235c933", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-ce2af901-b4a8-43c5-a3a2-e9292235c933" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1a4430ea-b20c-4ec6-9953-b3532e1bad04" } ], "id": "0582660a-8074-42e7-b2c1-a33159f468a5", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-0582660a-8074-42e7-b2c1-a33159f468a5" }, { "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": "04648bcf-d788-4246-8a34-badaedb0865d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "2149ef7a-ef93-4d86-bad3-f796106ba885", "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": "401301b5-56e6-41d7-8b47-c4f7faabe280", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-401301b5-56e6-41d7-8b47-c4f7faabe280" }, { "id": "f2a850ff-71bb-4615-b162-9e36f6ed6826", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f2a850ff-71bb-4615-b162-9e36f6ed6826" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-04648bcf-d788-4246-8a34-badaedb0865d" }, { "name": "Set the monthly limit on the recorded video time available for export for SoraCam compatible camera device.", "id": "0034375e-4122-48d5-8f77-f30e8917ac58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "d269d3e8-9afe-407d-a184-c2e325be7306", "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": "b8481bb2-76d1-4f52-912e-0c03cd89d939", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b8481bb2-76d1-4f52-912e-0c03cd89d939" }, { "id": "d90ce951-4a0a-40ee-9b9f-b677520c425f", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-d90ce951-4a0a-40ee-9b9f-b677520c425f" }, { "id": "4d1d576b-714c-4318-a9f7-2261f74742f5", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4d1d576b-714c-4318-a9f7-2261f74742f5" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0034375e-4122-48d5-8f77-f30e8917ac58" } ], "id": "b4e34a24-18a8-4e7a-af34-802a2e789c1e", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-b4e34a24-18a8-4e7a-af34-802a2e789c1e" }, { "name": "Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.", "id": "b64f6f53-969e-450f-aa77-bd319b7c676f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "fd5caea5-f527-4c88-a44c-6429167841f4", "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": "4647ffc9-c68b-4f5e-85dd-1328a96b1408", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4647ffc9-c68b-4f5e-85dd-1328a96b1408" }, { "id": "6fd99b61-8a69-42be-a1b1-cdb4c6624bdf", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6fd99b61-8a69-42be-a1b1-cdb4c6624bdf" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b64f6f53-969e-450f-aa77-bd319b7c676f" } ], "id": "3ee67b93-8a0b-458f-8936-76536d663846", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-3ee67b93-8a0b-458f-8936-76536d663846" } ], "id": "efe71bef-e301-4c5a-b899-40268a72cccf", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-efe71bef-e301-4c5a-b899-40268a72cccf" }, { "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": "cdd3e94a-882c-4706-9a18-ca50b7750747", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "8d31459e-eb01-4936-9f4d-f74fba3bc672", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "b75038f6-52e9-4927-b289-f97da27aaa53", "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": "3f72af8b-88de-403a-91b3-8800c0d85319", "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\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3f72af8b-88de-403a-91b3-8800c0d85319" }, { "id": "bfbb1675-eb5f-44ea-8f82-5171a5578c32", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-bfbb1675-eb5f-44ea-8f82-5171a5578c32" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-cdd3e94a-882c-4706-9a18-ca50b7750747" } ], "id": "44581a5f-356d-49c0-b6bf-cc1d22697d9b", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-44581a5f-356d-49c0-b6bf-cc1d22697d9b" }, { "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": "bb7ee062-fbab-48be-84b1-a60e6dcccc51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "df12ff46-49b3-4e3a-8d52-f96dc5f06f5d", "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": "10b73406-2336-4f05-9777-7678e6d2a543", "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\": \"processing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-10b73406-2336-4f05-9777-7678e6d2a543" }, { "id": "95f5906c-aa44-4dbb-ae58-c03b1164a9d3", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-95f5906c-aa44-4dbb-ae58-c03b1164a9d3" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-bb7ee062-fbab-48be-84b1-a60e6dcccc51" }, { "name": "Start the process of exporting still images from recorded video saved on the cloud", "id": "ba946523-dfd7-4d78-b8e4-1a971e62a13d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "7d4ca9f3-6a33-4ee4-917f-f63a2958e57e", "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": "0723fdf6-507a-4f48-8375-b2ef8943d099", "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\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0723fdf6-507a-4f48-8375-b2ef8943d099" }, { "id": "6ad36733-c6f6-475e-aeea-7e3624274529", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6ad36733-c6f6-475e-aeea-7e3624274529" }, { "id": "3c0e14b0-7f2e-4f8c-aab7-0801eb951307", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3c0e14b0-7f2e-4f8c-aab7-0801eb951307" }, { "id": "c45f1809-3aa7-4a31-8e4b-671433144f04", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-c45f1809-3aa7-4a31-8e4b-671433144f04" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-ba946523-dfd7-4d78-b8e4-1a971e62a13d" } ], "id": "2a74c662-dd78-4a66-8637-f22925a67b6c", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-2a74c662-dd78-4a66-8637-f22925a67b6c" } ], "id": "62be444d-f649-4aa3-a09d-f86b642060fb", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-62be444d-f649-4aa3-a09d-f86b642060fb" }, { "name": "name", "item": [ { "name": "Get the current name of the SoraCam compatible camera device.", "id": "0d222ec4-d33b-4126-b82b-4a1edba2dc33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "98d4b2a7-d2ff-4f3f-9971-b727df701ed7", "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": "f36ba3ca-3f9b-4aa7-9e7b-6dc158b4298a", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f36ba3ca-3f9b-4aa7-9e7b-6dc158b4298a" }, { "id": "5c2d9e08-cb1a-483e-b2aa-ef827507703f", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5c2d9e08-cb1a-483e-b2aa-ef827507703f" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-0d222ec4-d33b-4126-b82b-4a1edba2dc33" }, { "name": "Changes the name of the SoraCam compatible camera device.", "id": "bc4aac89-aecb-40c4-9240-41811059fc1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "cdd661a3-8c55-4541-ac27-3f5c49d3d164", "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": "df97f410-2020-47bf-82dc-177f5e15f3a5", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-df97f410-2020-47bf-82dc-177f5e15f3a5" }, { "id": "22c20b84-30e4-436b-be04-314f0f3e18ed", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-22c20b84-30e4-436b-be04-314f0f3e18ed" }, { "id": "819286d2-21d4-4083-9d82-12553ff876d3", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-819286d2-21d4-4083-9d82-12553ff876d3" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-bc4aac89-aecb-40c4-9240-41811059fc1e" } ], "id": "863a9fd1-5730-4439-96e0-dcea28685e3b", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-863a9fd1-5730-4439-96e0-dcea28685e3b" }, { "name": "power_state", "item": [ { "name": "Get the current power state of the SoraCam compatible camera device.", "id": "2749b807-b7ad-4278-a85a-154d31e763d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "2312968e-5a7a-4a3f-a137-5ad263f20bfd", "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": "878157af-9b7a-4ebb-ac91-a6d158507746", "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\": \"on\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-878157af-9b7a-4ebb-ac91-a6d158507746" }, { "id": "2fa160ad-3f26-4e63-98f2-b8011bc49215", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-2fa160ad-3f26-4e63-98f2-b8011bc49215" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-2749b807-b7ad-4278-a85a-154d31e763d0" }, { "name": "Changes the power state of the SoraCam compatible camera device.", "id": "3147f32b-af4d-4b48-83a2-ea0035a965e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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\": \"on\"\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": "0f60806c-c642-4d76-83e2-b31f66e15f49", "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": "15c8347f-d3d0-4824-93c1-2240afa5ca4e", "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\": \"on\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-15c8347f-d3d0-4824-93c1-2240afa5ca4e" }, { "id": "32306d17-ca25-4d14-9426-b1a31eec6bb5", "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\": \"on\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-32306d17-ca25-4d14-9426-b1a31eec6bb5" }, { "id": "e13a6ee2-ecac-402b-9169-febb6e931842", "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\": \"on\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e13a6ee2-ecac-402b-9169-febb6e931842" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3147f32b-af4d-4b48-83a2-ea0035a965e3" } ], "id": "5b48d197-9354-42f8-8e33-bca27d2a28c6", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-5b48d197-9354-42f8-8e33-bca27d2a28c6" }, { "name": "reboot", "item": [ { "name": "Reboot the SoraCam compatible camera device.", "id": "86932bd9-d8d5-4579-b3e0-e068934a86a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "fe1ad342-85ed-4318-85c7-fc7c112058b0", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." } ] }, "description": "Reboot the SoraCam compatible camera device." }, "response": [ { "id": "34e55772-51e2-4a87-8882-9e6eee1dc791", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-34e55772-51e2-4a87-8882-9e6eee1dc791" }, { "id": "9da8058a-eaf1-4c02-a0a8-1bac04d9b61e", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9da8058a-eaf1-4c02-a0a8-1bac04d9b61e" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-86932bd9-d8d5-4579-b3e0-e068934a86a1" } ], "id": "4a6c788d-6fae-4b74-992e-7c40eeced86a", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-4a6c788d-6fae-4b74-992e-7c40eeced86a" }, { "name": "recordings_and_events", "item": [ { "name": "Retrieve a list of recording periods and events for a SoraCam compatible camera device", "id": "94e17a30-7acb-45bc-8aad-7dbaed324490", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "909776b8-beef-496c-b42e-d1ad92a4d90d", "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": "5d750b0d-9bad-4f9b-821c-1ceaa5bd58bb", "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\": \"other\",\n \"endTime\": \"\"\n },\n {\n \"startTime\": \"\",\n \"type\": \"motion\",\n \"endTime\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5d750b0d-9bad-4f9b-821c-1ceaa5bd58bb" }, { "id": "e7506800-ac5f-43eb-91a4-6dbd8c549e4d", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e7506800-ac5f-43eb-91a4-6dbd8c549e4d" }, { "id": "512fc9db-e10c-41d7-8f70-c34026164142", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-512fc9db-e10c-41d7-8f70-c34026164142" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-94e17a30-7acb-45bc-8aad-7dbaed324490" } ], "id": "d570c4cd-c488-44f7-a9ca-22e4d7417089", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-d570c4cd-c488-44f7-a9ca-22e4d7417089" }, { "name": "stream", "item": [ { "name": "Get information for streaming recorded video from the cloud.", "id": "b5d2f586-14eb-4982-a362-7f498dc0fb10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "60dfbd25-0e9a-402f-adaf-2d56322217a3", "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": "57d98b7f-7b4c-438d-b100-b73eb67bd182", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-57d98b7f-7b4c-438d-b100-b73eb67bd182" }, { "id": "32af46ad-901c-41d0-a20c-23e3eb738c06", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-32af46ad-901c-41d0-a20c-23e3eb738c06" }, { "id": "1d1f9206-9aaf-4544-9210-307194f905db", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-1d1f9206-9aaf-4544-9210-307194f905db" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b5d2f586-14eb-4982-a362-7f498dc0fb10" } ], "id": "d29f60f4-57fa-4c26-9f84-1e62c9dc282f", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-d29f60f4-57fa-4c26-9f84-1e62c9dc282f" }, { "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": "cb5affe0-c77b-428e-bbaa-09f3e8b94cab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "96dc1a98-daab-465f-a622-4aa728e3a041", "key": "device_id", "value": "", "description": "(Required) Device ID of the target SoraCam compatible camera device." }, { "id": "ce28f067-0e59-4abd-bab4-c24a9ca51879", "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": "72834569-f6bb-47e4-94b5-4f73ebadb7d7", "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\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-72834569-f6bb-47e4-94b5-4f73ebadb7d7" }, { "id": "3a8065bd-cb74-48fd-b1eb-f53f9915b801", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-3a8065bd-cb74-48fd-b1eb-f53f9915b801" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-cb5affe0-c77b-428e-bbaa-09f3e8b94cab" } ], "id": "5b0f4662-45f6-4c8f-8a4f-df20c7a65142", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-5b0f4662-45f6-4c8f-8a4f-df20c7a65142" }, { "name": "Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.", "id": "f5fcc6eb-9e36-437d-9b46-ef9e6685cc21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "bb98cb36-8f8f-4a7e-bddd-d6c71e341133", "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": "d920238a-3839-47cc-b084-dd30f8a9ca21", "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\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-d920238a-3839-47cc-b084-dd30f8a9ca21" }, { "id": "49ac24dc-122a-4e3f-9b1f-817d34d53900", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-49ac24dc-122a-4e3f-9b1f-817d34d53900" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f5fcc6eb-9e36-437d-9b46-ef9e6685cc21" }, { "name": "Start the process of exporting recorded video saved on the cloud", "id": "5a286195-e626-486e-b4b5-8dd01c82ce52", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "4c502947-7e31-407e-986f-d8ebed99aae5", "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": "24e2c4e6-a753-4cf6-8eed-c7e00750755f", "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\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-24e2c4e6-a753-4cf6-8eed-c7e00750755f" }, { "id": "2c4b26aa-d340-4bcc-9ac2-4e72634609ce", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-2c4b26aa-d340-4bcc-9ac2-4e72634609ce" }, { "id": "fa2d1134-20a2-4e91-b16b-0d0d3585cc73", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-fa2d1134-20a2-4e91-b16b-0d0d3585cc73" }, { "id": "bd6098f8-173c-48c7-a44d-e43b1f7cd3e8", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-bd6098f8-173c-48c7-a44d-e43b1f7cd3e8" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5a286195-e626-486e-b4b5-8dd01c82ce52" } ], "id": "d28af6c1-5512-4e24-92e9-004b4752a3c8", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-d28af6c1-5512-4e24-92e9-004b4752a3c8" } ], "id": "4f47e4ee-69ee-4f02-a6e0-aa82996da595", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-4f47e4ee-69ee-4f02-a6e0-aa82996da595" }, { "name": "Delete the SoraCam compatible camera device identified by device_id.", "id": "97dc2002-d5f5-4967-a139-a7e1dedcf676", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "0fd018fe-1551-49d0-9b94-65a181765513", "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": "7facf094-6409-4378-afcf-b1156ecd5383", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7facf094-6409-4378-afcf-b1156ecd5383" }, { "id": "f23581a5-99a5-4272-a3e1-47507207aafb", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f23581a5-99a5-4272-a3e1-47507207aafb" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-97dc2002-d5f5-4967-a139-a7e1dedcf676" }, { "name": "Get the SoraCam compatible camera device information identified by device_id.", "id": "a0016de1-a851-47c2-8887-51161a27d636", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "6a9dba4f-503b-4034-809c-10ab06a49f2a", "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": "18d03689-f4ec-4b06-8b44-263f8f9abf8f", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-18d03689-f4ec-4b06-8b44-263f8f9abf8f" }, { "id": "2917c1c8-9d3f-4150-acc3-e3444a588bea", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-2917c1c8-9d3f-4150-acc3-e3444a588bea" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a0016de1-a851-47c2-8887-51161a27d636" } ], "id": "4cb5f622-9587-4d93-8127-a731936e6910", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-4cb5f622-9587-4d93-8127-a731936e6910" }, { "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": "4c04fbef-77e7-4559-9b66-48f89bb55a4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "b301119a-a114-4c5c-b08f-9bc8047ddb50", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b301119a-a114-4c5c-b08f-9bc8047ddb50" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4c04fbef-77e7-4559-9b66-48f89bb55a4f" } ], "id": "41fef635-25ae-448b-a1b2-afe7ea327471", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-41fef635-25ae-448b-a1b2-afe7ea327471" } ], "id": "bb53b58f-406f-4b3b-ad5c-40153f3868d6", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-bb53b58f-406f-4b3b-ad5c-40153f3868d6" } ], "id": "53d803f1-31d4-4ae8-a80a-8f3ef0141127", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-53d803f1-31d4-4ae8-a80a-8f3ef0141127" }, { "name": "events", "item": [ { "name": "List SoraCam events.", "id": "9f8ab5c3-736a-4eb9-b90c-c7462bef0b99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "4da7cf00-3b0d-44d4-af01-d2f8daffd61e", "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\": \"failed\",\n \"startTime\": \"\",\n \"type\": \"motion\"\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\": \"failed\",\n \"startTime\": \"\",\n \"type\": \"other\"\n }\n }\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-4da7cf00-3b0d-44d4-af01-d2f8daffd61e" }, { "id": "159919c8-ac22-4777-be8a-0bc03fbc8f75", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-159919c8-ac22-4777-be8a-0bc03fbc8f75" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9f8ab5c3-736a-4eb9-b90c-c7462bef0b99" } ], "id": "64341907-19e6-4317-a2eb-2176076e59e8", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-64341907-19e6-4317-a2eb-2176076e59e8" }, { "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": "e9e0bd32-951a-4af4-a7b6-e034ac52162d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "6b578aef-af21-4a1e-a581-2e62f58b1659", "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\": \"processing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6b578aef-af21-4a1e-a581-2e62f58b1659" }, { "id": "5de9dac0-ed3f-4c30-af73-82d29d2dd13a", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5de9dac0-ed3f-4c30-af73-82d29d2dd13a" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e9e0bd32-951a-4af4-a7b6-e034ac52162d" } ], "id": "c60982d0-dd51-44f0-8d0c-a36791d46619", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-c60982d0-dd51-44f0-8d0c-a36791d46619" } ], "id": "a2354751-c86d-4400-aade-d7ea703c1540", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-a2354751-c86d-4400-aade-d7ea703c1540" }, { "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": "b5f5f13a-2f49-4b07-acc2-3ad0f7c616d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "41211f72-e12d-463f-827b-24e96cf2076b", "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\": \"initializing\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n },\n {\n \"exportId\": \"\",\n \"requestedTime\": \"\",\n \"operatorId\": \"\",\n \"deviceId\": \"\",\n \"status\": \"expired\",\n \"expiryTime\": \"\",\n \"url\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-41211f72-e12d-463f-827b-24e96cf2076b" }, { "id": "e3d7db0e-81e9-40d9-900a-4d7974ff280c", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e3d7db0e-81e9-40d9-900a-4d7974ff280c" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b5f5f13a-2f49-4b07-acc2-3ad0f7c616d4" } ], "id": "a3af6d51-3202-4f90-8469-8c957dc57ec1", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-a3af6d51-3202-4f90-8469-8c957dc57ec1" } ], "id": "d7cf09be-81a5-45c9-aa87-54fcbdeb005d", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-d7cf09be-81a5-45c9-aa87-54fcbdeb005d" }, { "name": "List SoraCam compatible camera devices.", "id": "5c8652cc-4bd4-4632-8490-72c1ae04a071", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "a4abac02-a5ca-4354-9786-0774d48f77ac", "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\": \"on\",\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a4abac02-a5ca-4354-9786-0774d48f77ac" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-5c8652cc-4bd4-4632-8490-72c1ae04a071" } ], "id": "3e859c17-4ced-4ac5-b54e-1f3389aa60be", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-3e859c17-4ced-4ac5-b54e-1f3389aa60be" }, { "name": "license_packs", "item": [ { "name": "{license_pack_id}", "item": [ { "name": "quantity", "item": [ { "name": "Update the license quantity of Soracom Cloud Camera Services", "id": "7099f7c9-8e92-4c0e-9312-bc738752cd3a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "5bf2c6c3-6bfe-4091-9aa2-ce82cd542c74", "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": "a4750aae-fdd6-4cf2-9cdb-ff77f227e78e", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a4750aae-fdd6-4cf2-9cdb-ff77f227e78e" }, { "id": "37935878-235b-450b-830a-b8af8129ca8e", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-37935878-235b-450b-830a-b8af8129ca8e" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-7099f7c9-8e92-4c0e-9312-bc738752cd3a" } ], "id": "c16de53c-7e7a-4834-973b-bca612c1e8a4", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-c16de53c-7e7a-4834-973b-bca612c1e8a4" } ], "id": "37aba86d-1fd8-4ef7-85c1-73049348b26a", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-37aba86d-1fd8-4ef7-85c1-73049348b26a" }, { "name": "List license packs of Soracom Cloud Camera Services", "id": "be34588c-d9a0-45d5-885e-b5e09f24b1c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "9eba659e-d865-4f88-91f2-6c47aff651d8", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9eba659e-d865-4f88-91f2-6c47aff651d8" }, { "id": "21de8c4c-7b31-4f1b-b59f-fa818f7cab9d", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-21de8c4c-7b31-4f1b-b59f-fa818f7cab9d" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-be34588c-d9a0-45d5-885e-b5e09f24b1c6" } ], "id": "59b6a6b9-b50d-432b-a451-ec7358c9e0e1", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-59b6a6b9-b50d-432b-a451-ec7358c9e0e1" } ], "id": "bf97f585-1a65-42f1-a88d-7dff6c2f6399", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-bf97f585-1a65-42f1-a88d-7dff6c2f6399" }, { "name": "gadgets", "item": [ { "name": "{product_id}", "item": [ { "name": "{serial_number}", "item": [ { "name": "disable_termination", "item": [ { "name": "Disables Termination of Gadget API compatible device", "id": "f026576a-19e3-40ea-abee-89887453ca97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "f5b9f4f9-be5d-4213-92d4-a9dd19672b25", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "97458627-9126-482d-ae6a-5e8ac05080a2", "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": "74b77278-c34f-4b7d-b25b-8877d46b1e77", "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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-74b77278-c34f-4b7d-b25b-8877d46b1e77" }, { "id": "e1a34570-c678-4369-941e-8cbc6ac266fb", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e1a34570-c678-4369-941e-8cbc6ac266fb" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f026576a-19e3-40ea-abee-89887453ca97" } ], "id": "e56063a8-a837-4266-8867-e182f01f65c2", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-e56063a8-a837-4266-8867-e182f01f65c2" }, { "name": "enable_termination", "item": [ { "name": "Enables Termination of Gadget API compatible device", "id": "e302af97-e745-419a-a924-fb669649688e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "493b061d-2977-4a39-8ba9-b8aec727b370", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "a993afdd-1e74-4c07-9fb0-1f20d4498379", "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": "f5527ae3-fa13-4d8e-ab86-e681829d0865", "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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-f5527ae3-fa13-4d8e-ab86-e681829d0865" }, { "id": "9c25f116-a462-4710-9cfd-6a223a50d2f3", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-9c25f116-a462-4710-9cfd-6a223a50d2f3" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e302af97-e745-419a-a924-fb669649688e" } ], "id": "69169eb8-70e1-42a0-ace9-0ffa34825133", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-69169eb8-70e1-42a0-ace9-0ffa34825133" }, { "name": "register", "item": [ { "name": "Registers a Gadget API compatible device", "id": "e735a73f-baa7-433e-b14a-4a54debd77ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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 \"ullamco_e\": \"\",\n \"ut5c\": \"\"\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": "b8cb1c91-be14-4954-b3dd-20fc5022ed2e", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "ab074fe7-b110-4de8-a5fe-2cae44c29745", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." } ] }, "description": "Registers a Gadget API compatible device." }, "response": [ { "id": "40bb96f4-0645-4501-85ae-8aebb5f012d9", "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 \"ullamco_e\": \"\",\n \"ut5c\": \"\"\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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-40bb96f4-0645-4501-85ae-8aebb5f012d9" }, { "id": "425c5c74-fa82-4b5c-be8f-7d390a4cba42", "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 \"ullamco_e\": \"\",\n \"ut5c\": \"\"\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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-425c5c74-fa82-4b5c-be8f-7d390a4cba42" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e735a73f-baa7-433e-b14a-4a54debd77ea" } ], "id": "8db342c0-f36b-4060-b185-83ae043b1355", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-8db342c0-f36b-4060-b185-83ae043b1355" }, { "name": "tags", "item": [ { "name": "{tag_name}", "item": [ { "name": "Deletes tags from Gadget API compatible device", "id": "cd7a5112-de20-4fff-8f79-b9eccddeee4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "e3624719-01d4-4a9d-8225-3e65f62bea4a", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "3903e9b5-6980-44db-9093-fece0e673aab", "key": "serial_number", "value": "", "description": "(Required) Serial Number of the target Gadget API compatible device." }, { "id": "ac6895f2-fb65-45f7-b63a-79f9b0b2e907", "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": "a53dc582-ed80-46a4-bf9f-3acb9888c924", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a53dc582-ed80-46a4-bf9f-3acb9888c924" }, { "id": "be24ba19-dc16-4c3d-9e1f-32c20461b38a", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-be24ba19-dc16-4c3d-9e1f-32c20461b38a" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-cd7a5112-de20-4fff-8f79-b9eccddeee4f" } ], "id": "92a1fc07-eb60-4f3f-91ed-b178844a54a4", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-92a1fc07-eb60-4f3f-91ed-b178844a54a4" }, { "name": "Bulk Insert or Update Gadget API compatible device tags", "id": "28c1d08e-8008-4466-8b0c-2869b37e247f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "e0d4fbaf-9eb0-4e30-b17f-fc414daf5f16", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "f0d52860-d4f1-4cdb-be65-bbe2cac446fb", "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": "42e7f949-17ad-4a29-ae1f-015f79243def", "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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-42e7f949-17ad-4a29-ae1f-015f79243def" }, { "id": "e195a884-8b71-4536-88ae-aadfb9806146", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-e195a884-8b71-4536-88ae-aadfb9806146" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-28c1d08e-8008-4466-8b0c-2869b37e247f" } ], "id": "9e376676-4109-4241-b101-214cf04f39c1", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-9e376676-4109-4241-b101-214cf04f39c1" }, { "name": "terminate", "item": [ { "name": "Terminates the specified Gadget API compatible device", "id": "12975ea7-2967-4be4-9a30-7901e63f736b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "3173d92d-d860-4d28-8a9c-32df5a57aefd", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "a226c409-26e7-408c-8f30-72851c2daefb", "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": "aced2b0e-56c4-4b1e-94c0-134616f1ea0f", "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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-aced2b0e-56c4-4b1e-94c0-134616f1ea0f" }, { "id": "a8283586-b385-445c-a32a-413883325642", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-a8283586-b385-445c-a32a-413883325642" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-12975ea7-2967-4be4-9a30-7901e63f736b" } ], "id": "12875dcd-1c41-40fb-9337-98bdc8287f5d", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-12875dcd-1c41-40fb-9337-98bdc8287f5d" }, { "name": "Get Gadget API compatible device", "id": "b34d3782-7fe1-43a4-a76f-a1180ee8209d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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": "de7be0e1-ef0c-423d-b1d3-e0d183e59934", "key": "product_id", "value": "wimax", "description": "(Required) Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "id": "bf5cdfc6-16e5-4994-9c13-abd356a5fe8f", "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": "2dd31489-7c8f-42f3-982d-817f85a52e9a", "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 \"incididunte\": \"\",\n \"ea_a\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n}", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-2dd31489-7c8f-42f3-982d-817f85a52e9a" }, { "id": "72986851-b9e1-4c45-949f-6776cb7ba3a6", "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:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-72986851-b9e1-4c45-949f-6776cb7ba3a6" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-b34d3782-7fe1-43a4-a76f-a1180ee8209d" } ], "id": "766a0b6d-c036-4e6e-983e-99c36f0dc6f9", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-766a0b6d-c036-4e6e-983e-99c36f0dc6f9" } ], "id": "f8bbec25-21e5-4225-b900-ffeb4b0b0098", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-f8bbec25-21e5-4225-b900-ffeb4b0b0098" }, { "name": "List gadgets", "id": "6380f5ca-7236-40f0-9cb7-c125e0ef8c8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "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=wimax&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": "wimax" }, { "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": "c859b727-f8f1-4770-adfb-98dd95d52aef", "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=wimax&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": "wimax" }, { "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\": \"wimax\",\n \"serialNumber\": \"\",\n \"status\": \"terminated\",\n \"tags\": {\n \"aliquip685\": \"\"\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\": \"active\",\n \"tags\": {\n \"quis_657\": \"\"\n },\n \"terminatedTime\": \"\",\n \"terminationEnabled\": false\n }\n]", "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-c859b727-f8f1-4770-adfb-98dd95d52aef" } ], "createdAt": "2026-06-05T15:18:54.000Z", "updatedAt": "2026-06-05T15:18:54.000Z", "uid": "35240-6380f5ca-7236-40f0-9cb7-c125e0ef8c8e" } ], "id": "10b63834-0d33-4682-bef0-d2fe91babb46", "createdAt": "2026-06-05T15:18:53.000Z", "updatedAt": "2026-06-05T15:18:53.000Z", "uid": "35240-10b63834-0d33-4682-bef0-d2fe91babb46" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }