{"info":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","description":"

This document is a quick preview of the current state of the CloudRail open API for IoT.

CloudRail IoT API exposes part of our internal structure to the end-user that desire to implement their interfaces and workflows. Using CloudRail IoT API, You can have the main features that CloudRail provides through the management cloud while using your programming language of choice. The API is a RESTful API based on HTTP requests and JSON responses.

This version of the API, version 0.1 is a beta preview. Changes will be made upon user feedback and bug fixes. Feel free to contact us.

The easiest way to start using the CloudRail IoT API is by clicking the Run in Postman button above. Postman is a free tool that helps developers run and debug API requests and is the source of truth for this documentation. Every endpoint you see documented here is readily available by running our Postman collection.

Need help? Feedback?

Our mastermind engineers are always around. The quickest way to get help is by contacting us through support.

Responses & Errors

Each response is wrapped in a data tag, which means if you have a response (not empty or null), it will always be within the data field. We also include a status code and success flag in the response. Responses are always in JSON format.

In contrast with the success responses, the error responses will always be wrapped in a
[comment]: For more information and examples go to the data models page.

More Request/Response Examples

To access more examples of request and response bodies for a given endpoint, just use the dropdown that is trickly positioned in the corner of the code component as seen in the below images:

1 - Click on the dropdown

\n\n

2 - Select another example

\n\n

Authentication

To authenticate you just need to generate an Api Key. Once you have an Api Key you're ready to start making API requests to the associated account. If you do not have one yet, just go to the advanced settings in your account config and generate an API Key for your account.

All that's required for this is to set the header in your requests:

x-api-key: YOUR_API_KEY

WARNING: Currently the API token has no expiration date, so discretion is advised to avoid security breaches. DO NOT SHARE THE API TOKEN

Generate an API Key

To generate the API key that will be used to authenticate the requests sent to the API, follow the steps on the main page after logging in at https://devices.cloudrail.com/.

Click on \"Account\" on the sidebar

\n $\"\"$ \n\n

Select \"Advanced\" on the account page

\n $\"\"$ \n\n

3 ) Click on \"Generate Key\"

\n $\"\"$ \n\n

Copy the key (THE KEY VALUE WILL ONLY BE DISPLAYED ONCE PER GENERATION)

\n $\"\"$ \n\n

Device Creation Workflow

To create a device (e.g. Temperature sensor) that actually sends data to the desired service, a following steps should be done.

Create service credentials: This step should be done once for each service you wish to send data from the IoT device (or send data to the IoT device). You must create a valid credential for the desired service using the POST method in the /credentials endpoint. This step can be skipped if the credentials for the desired service has been already created.
\n
Trigger box device discovery: To detect new devices (e.g. temperature sensors) and \"sources\" (e.g. IFM AL1303), a devices refresh/discovery has to be triggered through a GET request in the /boxes/:box-id/refresh endpoint. That will request the CloudRail Box(if Online) to update our database with the latest information regarding every source and sensor attached. Be aware since this is not a synchronous operation, thous, no value is returned from this request. This step can be skipped if no changes has been made to the box setup (no new devices were attached or removed).
\n
Get last discovered devices: Get the latest sources information that was sent to our database by the given CloudRail Box using the GET method in the /boxes/:box-id/sources. This will return (among other data) the latest information regarding each input of each \"source\" attached to the Box. There will be a timestamp representing the last time that information was updated.
\n
Create device: This should be done after successfully retrieving devices through the step 3, all the information regarding the identification of an input and a device will be provided. Additionally, you will have to provide information regarding the selected service, and device configuration, all those will be detailed in the given endpoints description. See \"Devices\" section.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Responses & Errors","slug":"responses-errors"},{"content":"More Request/Response Examples","slug":"more-requestresponse-examples"},{"content":"Authentication","slug":"authentication"},{"content":"Generate an API Key","slug":"generate-an-api-key"},{"content":"Device Creation Workflow","slug":"device-creation-workflow"}],"owner":"26704221","collectionId":"9f5c2693-25f9-4979-9744-dc2c85c5701b","publishedId":"2s9YsGgshH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-11T12:36:57.000Z"},"item":[{"name":"Service Credentials","item":[{"name":"Create Credential","id":"74c57238-dd5e-4caa-8dba-2cfb6030842b","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service\": \"AWS\",\n \"credentials\": {\n \"accessKey\": \"AWS_ACCESS_KEY\",\n \"secretAccessKey\": \"AWS_SECRET_KEY\",\n \"ca\": \"AWS_CA_CERTIFICATE_HERE\",\n \"endpoint\": \"AWS_MQTT_ENDPOINT\"\n },\n \"credentialLabel\": \"test\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/credentials","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`service`	required	AWS Azure Google Alibaba IBM MQTT Greengrass Wonderware AzureIoTCentral AWSIoTSitewise AWSIoTConnectedFactory Webhook
`credentials`	required	See each service credential structure in the Data Objects or in the method example requests
`credentialLabel`	required	The name to be used by the credential in the management cloud

Returns a list of all Credentials associated with the current account.

\n","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["credentials"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"5be798f1-6d92-4313-99d9-c3737cc3abb3","name":"Listed","originalRequest":{"method":"GET","header":[],"url":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/credentials"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2598"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 00:12:25 GMT"},{"key":"x-amzn-RequestId","value":"0a682394-36a5-4dfd-a5b7-6ee3d148b5e4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AX5sFHEAoAMFTMg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b96fe6-1a666079311931806d1b109e;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 877a7509af39a63279b2520fa0b455fa.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUS51-C1"},{"key":"X-Amz-Cf-Id","value":"tKcvlauDTv0lEVORWMbftQoVC-Gw_gY6ryK2mMiVCXedeFxuCHJQTw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"label\": \"AWS-1597419087907\",\n \"credentials\": \"{\\\"accessKey\\\":\\\"AKIAI ... ot.us-east-1.amazonaws.com\\\"}\",\n \"service\": \"AWS\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"P2uRLk1W1qxLh32aUZeLbsUfSe8mWCRM\",\n \"label\": \"IBM-1594310635441\",\n \"credentials\": \"{\\\"orgId\\\":\\\"c72dmr\\\",\\\"apiKey\\\":\\\"a-c72*********\\\",\\\"token\\\":\\\"-fnQ2*********\\\"}\",\n \"service\": \"IBM\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"UQYQCC5EVkJoqnETLVyL7jsWzasZgt82\",\n \"label\": \"luke-iot-edge\",\n \"credentials\": \"{\\\"policyKey\\\":\\\"t9f/I*********\\\",\\\"hostname\\\":\\\"SPS.a*********\\\"}\",\n \"service\": \"AzureIoTEdge\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"XkAC2nHdy9j5elKwc7gLUx7AZFlmp0K8\",\n \"label\": \"sitewise-dev\",\n \"credentials\": \"{\\\"accessKey\\\":\\\"AKIAI*********\\\",\\\"secretAccessKey\\\":\\\"otnJc*********\\\",\\\"region\\\":\\\"us-east-1\\\"}\",\n \"service\": \"AWSIoTSitewise\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"BValsQj5RMDd8FrCA4iBmtE1rhsOns1g\",\n \"label\": \"azure-label\",\n \"credentials\": \"{\\\"subdomain\\\":\\\"felipe-dev-test\\\",\\\"centralDNS\\\":\\\"azureiotcentral.com\\\",\\\"token\\\":\\\"Share*********\\\"}\",\n \"service\": \"AzureIoTCentral\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"EoFMK6P6bwBQUKwecv8lBoTnBN7P5CVx\",\n \"label\": \"AzureIoTCentral-1594316660134\",\n \"credentials\": \"{\\\"centralDNS\\\":\\\"azureiotcentral.com\\\",\\\"subdomain\\\":\\\"samplecrz\\\",\\\"token\\\":\\\"Share*********\\\"}\",\n \"service\": \"AzureIoTCentral\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"2OYUJJwSbJ4F43xjTjXKxayqBY8AHeFJ\",\n \"label\": \"MACAC_LABEL\",\n \"credentials\": \"{\\\"accessKey\\\":\\\"EDITE********\\\",\\\"secretAccessKey\\\":\\\"SUPER*********\\\",\\\"ca\\\":\\\"-----BEGIN CERTIFICATE-----\\\\nMIIDQTCCAimgAwIBA**********\\\",\\\"endpoint\\\":\\\"ninjaazzzzaaaaa2mx2suo5f5iok-ats.iot.us-east-1.amazonaws.com\\\"}\",\n \"service\": \"AWS\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"O8lEPyoXBh2SLQgPLwToZ2jMaNh0ocSq\",\n \"label\": \"azure iot hub\",\n \"credentials\": \"{\\\"policyKey\\\":\\\"UXahu*********\\\",\\\"hostname\\\":\\\"felipe-dev-test.azure-devices.net\\\"}\",\n \"service\": \"Azure\",\n \"userId\": \"8fc7b...bb8a510df9\"\n },\n {\n \"id\": \"sm8Zq63IXaDrMHUqLCYKSncdAgsvoKkc\",\n \"label\": \"greengrass\",\n \"credentials\": \"{\\\"accessKey\\\":\\\"AKIAI*********\\\",\\\"secretAccessKey\\\":\\\"otnJc*********\\\",\\\"ca\\\":\\\"-----BEGIN CERTIFICATE-----\\\\nMIIDQTCCAimgAwIBA**********\\\",\\\"endpoint\\\":\\\"a2mx2suo5f5iok-ats.iot.us-east-1.amazonaws.com\\\"}\",\n \"service\": \"Greengrass\",\n \"userId\": \"8fc7b...bb8a510df9\"\n }\n ]\n}"}],"_postman_id":"0021a025-32eb-458a-a420-e65813da6e6e"},{"name":"Update Credential","id":"a90c609a-ce82-40cc-8d87-1c40245a5ea9","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialId\": \"RhRDMQxGGCpfjUQ9VSn2q6S09HqIzdUB\",\n \"credentials\": {\n \"accessKey\": \"das7dnyasi8d7yas7d8bas8\",\n \"secretAccessKey\": \"a9s8dnyas978d67as8b6da98E\",\n \"ca\": \"Edited certificate\",\n \"endpoint\": \"EDITED ENDPOINT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/credentials","description":"

Updates the values of the credential specified in the credentialId body parameter.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`credentialId`	required	The id of the credential to be edited
`credentials`	required	See each service credential structure in the Data structures or in the method example requests
`credentialLabel`	required	The name to be used by the credential in the management cloud

String - The ID of the credential you wish to delete

\n","type":"text"},{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/credentials","description":"

This request accepts addionial header called 'cr-header-id' which is nothing but ID of the credential that you want to delete.

Credentials Data Objects

AWS IoT Core Credential

See our oficial documentation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`accessKey`	required	String - Access key obtained for the current IAM user
`secretAccessKey`	required	String - Secret Access Key obtained for the current IAM user
`ca`	required	String - The AWS Root Certificate (RSA 2048 bit key) is used for device authentication and can be directly download from here Amazon Root CA 1. More information can be found here X.509 Certificates and AWS IoT
`endpoint`	required	String - The iot endpoint is in the format ABCDEFG1234567-ats.iot.Region.amazonaws.com. This can be found in the IoT Core settings for more details see IoT Core

Azure IoT Hub Credential

See our oficial documentation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`policyKey`	required	String - Is the Primary key of registryReadWrite
`hostname`	required	String - Azure endpoint is IoTHubName.azure-devices.net (e.g. NewSampleIoTHub.azure-devices.net)

","_postman_id":"e59b57f0-76ff-435f-94e5-8a3d07c70127","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Devices","item":[{"name":"Create AWS IoT Core Device","id":"82489e7b-c69f-4861-be6f-05b1750a47fd","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"9ztiVKbLLf8EUTePX5JN66JxhoOmwmlm\",\n \"deviceName\": \"testff\",\n \"readWriteConfig\": {\n \"frequency\": \"interval\",\n \"interval\": 4000\n },\n \"input\": {\n \"source\": \"00:02:01:0d:80:75\",\n \"inputId\": \"iolink4\",\n \"vendorId\": 310,\n \"deviceId\": 583,\n \"isRead\": true,\n \"isWrite\": false,\n \"icon\": \"fas fa-thermometer-half\"\n },\n \"deviceDescription\": \"\",\n \"usePort\": false,\n \"useShadow\": false\n}"},"url":"https://api.cloudrail.com/boxes/:box-id/devices/aws","description":"

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`credentialId`	required	The id of the AWS credential to be used
`deviceName`	required	The name of the device to be created
`readWriteConfig`	required	ReadWriteConfig, see structure in the Data Objects or in the method example requests
`input`	required	SourceInput, see structure in the Data Objects or in the method example requests.
`deviceDescription`	Required	Description of the device to be displayed in the CloudRail management cloud
`usePort`	required	Boolean - True if the device should use port 8883 instead of 443
`useShadow`	required	Boolean - True if the device should use the \"shadows\" feature from AWS hot core

The ID of the box containing the device you wish to create

\n","type":"text/plain"},"type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"bbefe6ef-a2c2-42b7-9671-d54065f21d24","name":"Read Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"deviceName\": \"APIOfficeTemperature22\",\n \"readWriteConfig\": {\n \"frequency\": \"interval\",\n \"interval\": 2000\n },\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"iolink1\",\n \"vendorId\": 310,\n \"deviceId\": 706,\n \"isRead\": true,\n \"isWrite\": false,\n \"icon\": \"fas fa-thermometer-half\"\n },\n \"deviceDescription\": \"This is a test device\",\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://kzzluxcxf8.execute-api.ap-south-1.amazonaws.com/dev/boxes/BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD/devices/aws"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 02:45:30 GMT"},{"key":"x-amzn-RequestId","value":"24939527-5f3c-4c3f-87d0-bdd8582e675a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYQHEFQCIAMFvrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b993c6-0610dae21e25c41f30584490;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f12c01365a7e1bcbb4b6d5b856516527.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUS51-C1"},{"key":"X-Amz-Cf-Id","value":"7y18on7JGlKEY4BtWE_Vm1M-nj8gOCdi49ZDu2sqWVBnnTj2iqLzWQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"01X5sv7MCmVm7lqlXk5XpUljrQzUb1Am\"\n }\n}"},{"id":"0a5b569e-dbf5-49ea-b709-ca8a7d510fa3","name":"Write Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"deviceName\": \"APILight\",\n \"readWriteConfig\": {\n \"opeatingMode\": \"RGBMode\"\n },\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"iolink2\",\n \"vendorId\": 310,\n \"deviceId\": 850,\n \"isRead\": false,\n \"isWrite\": true,\n \"icon\": \"fas fa-lightbulb\"\n },\n \"deviceDescription\": \"his is a test device\",\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id/devices/aws"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"868"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 03:34:58 GMT"},{"key":"x-amzn-RequestId","value":"a5667c06-2b19-4c5c-b6e7-11a2e6856c28"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYXWpGNEoAMFV3A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b99f5d-1bba99e05293141f67ed99b2;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e5b93012e2bfb81dc9846f43efd610a6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Id","value":"gNweXuZMZvPGGAAIrhiMREVdYOpiU2sGG3ja_PetPzxzqdDfnKaKJw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"kdnZigDWu4yP5FkhtzNAc9vg7L8APVpw\"\n }\n}"},{"id":"c829cbde-34cb-47ed-a0cb-e5fe91ec5adc","name":"Digital Read Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"deviceName\": \"APIDigitalRead22\",\n \"readWriteConfig\": {\n \"frequency\": \"change\"\n },\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"digital7\",\n \"vendorId\": 310,\n \"deviceId\": 706,\n \"isRead\": true,\n \"isWrite\": false\n },\n \"deviceDescription\": \"his is a test device\",\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id/devices/aws"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 03:49:17 GMT"},{"key":"x-amzn-RequestId","value":"81e19a71-1578-4b4d-8a95-b81543e4f8c5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYZdNE-DIAMFnZA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b9a2ba-187530622edfab556e27b27d;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0ee6aea018b9489b266252370f1e002e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUS51-C1"},{"key":"X-Amz-Cf-Id","value":"7sRkjs3DHArQdidYRBHoviKjuTSRHPZUxSSE9NTRUHNupu3d54EdRA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"nkHrYOIu9HCcuL5punffi29PBIPWLSsl\"\n }\n}"}],"_postman_id":"82489e7b-c69f-4861-be6f-05b1750a47fd"},{"name":"Create Azure IoT Hub Device","id":"0d48a8d4-1817-42a8-bc55-22de141e65a2","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"hostname\": \"VasantiHub.azure-devices.net\",\n \"credentialsId\": \"qzzJ0QxTVNSvPDMOrAtgnwL6j344kdBZ\",\n \"deviceName\": \"testAzure\",\n \"deviceDescription\": \"AzureDevice custom description\",\n \"input\": {\n \"isRead\": true,\n \"isWrite\": false,\n \"source\": \"00:02:01:0d:80:75\",\n \"inputId\": \"iolink4\",\n \"icon\": \"fas fa-thermometer-half\",\n \"vendorId\": 310,\n \"deviceId\": 706\n },\n \"readWriteConfig\": { \"frequency\": \"change\", \"tolerance\": 30, \"onChangeInterval\": 3000 },\n \"usePort\": false,\n \"useShadow\": false\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id/devices/azure-iot-hub","description":"

Body Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`credentialId`	required	String - The id of the AWS credential to be used
`deviceName`	required	String - The name of the device to be created
`readWriteConfig`	required	Object - ReadWriteConfig, see structure in the Data Objects or in the method example requests
`input`	required	Object - SourceInput, see structure in the Data Objects or in the method example requests.
`deviceDescription`	required	String - Description of the device to be displayed in the CloudRail management cloud
`usePort`	required	Boolean - True if the device should use port 8883 instead of 443
`useShadow`	required	Boolean - True if the device should use the \"shadows\" feature from AWS hot core
`hostname`	required	String - Same Hostname used in the azure iot hub credentials being referenced in the `credentialsId`SourceInput

The ID of the box containing the device you wish to create

\n","type":"text/plain"},"type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"66e0cf38-f097-4be9-80a4-dc789f280e12","name":"Read Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"hostname\": \"cloudrail.azure.com\",\n \"deviceName\": \"AzureTemperature\",\n \"deviceDescription\": \"AzureDevice custom description\",\n \"readWriteConfig\": {\n \"frequency\": \"interval\",\n \"interval\": 2000\n },\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"iolink1\",\n \"vendorId\": 310,\n \"deviceId\": 706,\n \"isRead\": true,\n \"isWrite\": false,\n \"icon\": \"fas fa-thermometer-half\"\n },\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://kzzluxcxf8.execute-api.ap-south-1.amazonaws.com/dev/boxes/BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD/devices/azure-iot-hub"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 02:45:30 GMT"},{"key":"x-amzn-RequestId","value":"24939527-5f3c-4c3f-87d0-bdd8582e675a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYQHEFQCIAMFvrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b993c6-0610dae21e25c41f30584490;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f12c01365a7e1bcbb4b6d5b856516527.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUS51-C1"},{"key":"X-Amz-Cf-Id","value":"7y18on7JGlKEY4BtWE_Vm1M-nj8gOCdi49ZDu2sqWVBnnTj2iqLzWQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"01X5sv7MCmVm7lqlXk5XpUljrQzUb1Am\"\n }\n}"},{"id":"8aab3d1c-ba46-48d0-9777-8355513800a1","name":"Write Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"deviceName\": \"APILight\",\n \"readWriteConfig\": {\n \"opeatingMode\": \"RGBMode\"\n },\n \"hostname\": \"felipe-dev-test.azure-devices.net\",\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"iolink2\",\n \"vendorId\": 310,\n \"deviceId\": 850,\n \"isRead\": false,\n \"isWrite\": true,\n \"icon\": \"fas fa-lightbulb\"\n },\n \"deviceDescription\": \"This is a test device\",\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id/devices/azure-iot-hub"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"868"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 03:34:58 GMT"},{"key":"x-amzn-RequestId","value":"a5667c06-2b19-4c5c-b6e7-11a2e6856c28"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYXWpGNEoAMFV3A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b99f5d-1bba99e05293141f67ed99b2;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e5b93012e2bfb81dc9846f43efd610a6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Id","value":"gNweXuZMZvPGGAAIrhiMREVdYOpiU2sGG3ja_PetPzxzqdDfnKaKJw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"kdnZigDWu4yP5FkhtzNAc9vg7L8APVpw\"\n }\n}"},{"id":"b3361bd7-82fc-4d8f-bcf1-aa00e0134486","name":"Digital Read Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credentialsId\": \"Gq8W4iAlOYa440ZWBrtxfUu82JTnw8Re\",\n \"deviceName\": \"APIDigitalRead22\",\n \"readWriteConfig\": {\n \"frequency\": \"change\"\n },\n \"input\": {\n \"source\": \"00:02:01:0b:80:cb\",\n \"inputId\": \"digital7\",\n \"vendorId\": 310,\n \"deviceId\": 706,\n \"isRead\": true,\n \"isWrite\": false\n },\n \"deviceDescription\": \"This is a test device\",\n \"usePort\": false,\n \"useShadow\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id/devices/azure-iot-hub"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 03:49:17 GMT"},{"key":"x-amzn-RequestId","value":"81e19a71-1578-4b4d-8a95-b81543e4f8c5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AYZdNE-DIAMFnZA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b9a2ba-187530622edfab556e27b27d;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0ee6aea018b9489b266252370f1e002e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DUS51-C1"},{"key":"X-Amz-Cf-Id","value":"7sRkjs3DHArQdidYRBHoviKjuTSRHPZUxSSE9NTRUHNupu3d54EdRA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deviceId\": \"nkHrYOIu9HCcuL5punffi29PBIPWLSsl\"\n }\n}"}],"_postman_id":"0d48a8d4-1817-42a8-bc55-22de141e65a2"},{"name":"Delete Brownfield Device","id":"1f2b4c87-58a1-4a08-8a09-adc09ce13014","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"forceDelete","value":"true","type":"text"},{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes/:box-id/devices/:device-id","description":"

This request is used for deleting Brownfield device. If you want to forcefully delete the device, please select forceDelete header under headers section which is set to true.

The box id of the box containing the device

\n","type":"text/plain"},"type":"any","value":":box-id","key":"box-id"},{"id":"700c2a1a-eccf-415c-94c7-a3091f15f147","description":{"content":"

The ID of the device you wish to perform the operation

\n","type":"text/plain"},"type":"any","value":":device-id","key":"device-id"}]}},"response":[{"id":"bd9ac97d-d945-4de7-9d93-1421785a1780","name":"Delete Brownfield Device","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id/devices/:device-id","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id","devices",":device-id"],"variable":[{"key":"box-id"},{"key":"device-id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"204"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 03 Jun 2021 22:49:02 GMT"},{"key":"x-amzn-RequestId","value":"0e9eab75-4650-4c17-b2b6-ec8274620ad0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AXteWGEvIAMFx1g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b95c5b-1d36475d1429f2721bd40a34;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 90cf045072373c2c671297de3161846f.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Id","value":"s4cntvBKDTOT3VW6_kwZ4y5bzZ90kTUEyUVsx4bOCYBk6sK1rNB-Dg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Device was deleted successfully\"\n }\n}"},{"id":"d6daf8a8-2545-4d86-b4b9-1902dc6623f7","name":"Force Delete Device","originalRequest":{"method":"DELETE","header":[{"key":"forceDelete","value":"true","type":"text"}],"url":{"raw":"https://api.cloudrail.com/boxes/:box-id/devices/:device-id","host":["https://api.cloudrail.com"],"path":["boxes",":box-id","devices",":device-id"],"variable":[{"key":"box-id","value":":box-id","description":"The box id of the box containing the device"},{"key":"device-id","value":"wFvddcE46TejIZePXe1b6mNa4Obf2jUC","description":"The ID of the device you wish to perform the operation"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 16 Feb 2023 10:28:42 GMT"},{"key":"x-amzn-RequestId","value":"74045e01-f5a3-4078-a40b-3056b5f62e7d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AbXE6Hr9hcwFj-Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63ee0552-01be0d5d59e7ddfa5ab54515"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e7ce1281af608c74f8f603f1d3f6740a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P1"},{"key":"X-Amz-Cf-Id","value":"cT2WkL-1qTd2pPD41BP812KvTt3hzrLG_FXuoUs2Da3Hx0yG-1SHQA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Device was deleted successfully\"\n }\n}"}],"_postman_id":"1f2b4c87-58a1-4a08-8a09-adc09ce13014"}],"id":"ef430666-414c-4a3f-a1eb-963476bcfa1c","description":"

Data Structures

ReadWriteConfig

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`OperatingMode`	required, for devices with different operating modes available	String - The string representing the desired operating mode for the device.
`frequency`	required, for devices with READ mode enabled.	String - ['interval', 'change'] - The frequency in witch device should be read. 'interval' - Read device data every X milliseconds determined by `interval` property. 'change' - Read device data every time the value changes above a certain threshold determined by the `tolerance` property
`tolerance`	required, for devices with READ mode enabled and frequency set to 'change'	Number - [0 - 100] - The threshold that the box should consider if the value changed or not, relative to the last value sent to the cloud.
`interval`	required, for devices with READ mode enabled and frequency set to 'interval'.	Number - The number in milliseconds that the box should wait in order to get the next value from the device.
`onChangeInterval`	optional, for devices with frequency set to 'change'.	Number - The number in milliseconds the box should wait before checking for changes in the data.

","_postman_id":"ef430666-414c-4a3f-a1eb-963476bcfa1c","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Discovery & Refresh","item":[{"name":"Request sources discovery","id":"6e584580-8f4d-49a9-84bb-f67ced0e8ded","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes/:box-id/refresh","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id","refresh"],"host":["https://api.cloudrail.com"],"query":[],"variable":[{"id":"a8dd75bd-f577-4a6a-b3b1-d47c9d9d9913","description":{"content":"

The ID of the box you wish to perform the operations

\n","type":"text/plain"},"type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"17c77b62-b9c2-44e0-b99e-89f69f6f3490","name":"Discovery Requested","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id/refresh","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id","refresh"],"variable":[{"key":"box-id","value":":box-id","description":"The ID of the box you wish to perform the operations"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"6e584580-8f4d-49a9-84bb-f67ced0e8ded"},{"name":"List last discovered sources","id":"fb9f739a-56f9-426f-bedb-4f97dcd06f4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes/:box-id/sources","description":"

This endpoint provides the last information of sources ( modules and devices ) attached to the current box.

The ID of the box you wish to perform the operations

\n","type":"text/plain"},"type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"b8ef11b4-6935-4f1e-aa2f-7364d6f40463","name":"Listed Sources","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id/sources","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id","sources"],"variable":[{"key":"box-id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"925"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 04 Jun 2021 00:03:26 GMT"},{"key":"x-amzn-RequestId","value":"e39f34b2-ef7b-4767-b27d-0fbd443d2829"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AX4YCFDcoAMFSvg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-60b96dcc-0d6e8a98142062d60862580c;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 debe291145dc27044f50d04bac101cd9.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Id","value":"pwnYoCKzv-GsAuSttkNDXUGyzURUU5ZYt5H8uj5CL3_-3CqPP9omHA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"timestamp\": 1633626955978,\n \"sources\": [\n {\n \"id\": \"00:02:01:0b:80:cb\",\n \"name\": \"ifm AL1303 (00:02:01:0b:80:cb)\",\n \"inputs\": [\n {\n \"name\": \"TN2xx5\",\n \"description\": \"Electronic temperature sensor, -50...150 °C, Length 30 mm, IO-Link, Process connection G 1/2\",\n \"id\": \"iolink1\",\n \"vendorId\": 310,\n \"deviceId\": 706,\n \"isRead\": true,\n \"isWrite\": false,\n \"icon\": \"fas fa-thermometer-half\",\n \"operatingModes\": []\n },\n {\n \"name\": \"K50L2\",\n \"description\": \"K50L2 Indicator with IO-Link\",\n \"id\": \"iolink2\",\n \"vendorId\": 451,\n \"deviceId\": 393218,\n \"isRead\": false,\n \"isWrite\": true,\n \"icon\": \"fas fa-lightbulb\",\n \"operatingModes\": []\n },\n {\n \"name\": \"RU100U-M18MS-AP8X2-H1151\",\n \"description\": \"ultrasonic sensor\\r\\nmaximum sensing range 100 cm\\r\\nM18 housing \\r\\n1 switching output\",\n \"id\": \"iolink3\",\n \"vendorId\": 317,\n \"deviceId\": 264704,\n \"isRead\": true,\n \"isWrite\": false,\n \"icon\": \"fas fa-rss\",\n \"operatingModes\": []\n },\n {\n \"name\": \"Port 4\",\n \"id\": \"digital4\",\n \"isRead\": false,\n \"isWrite\": false,\n \"operatingModes\": []\n },\n {\n \"name\": \"DV15x0\",\n \"description\": \"5 Segment-LED-Tower, Standard, with bracket, without buzzer\",\n \"id\": \"iolink5\",\n \"vendorId\": 310,\n \"deviceId\": 850,\n \"isRead\": false,\n \"isWrite\": true,\n \"icon\": \"fas fa-lightbulb\",\n \"operatingModes\": [\n \"OnOffmode\",\n \"RGBmode\",\n \"Analogmode\"\n ]\n },\n {\n \"name\": \"Port 6\",\n \"id\": \"digital6\",\n \"isRead\": false,\n \"isWrite\": false,\n \"operatingModes\": []\n },\n {\n \"name\": \"Port 7\",\n \"id\": \"digital7\",\n \"isRead\": false,\n \"isWrite\": false,\n \"operatingModes\": []\n },\n {\n \"name\": \"Port 8\",\n \"id\": \"digital8\",\n \"isRead\": false,\n \"isWrite\": false,\n \"operatingModes\": []\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"fb9f739a-56f9-426f-bedb-4f97dcd06f4c"}],"id":"2c0c27e4-8d9b-4992-b885-2771440ff088","_postman_id":"2c0c27e4-8d9b-4992-b885-2771440ff088","description":"","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Edge Functions","item":[{"name":"List Edge Functions","id":"603d3114-e53d-443a-8c04-6d5c872e2a4d","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/edge/functions","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["edge","functions"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"d5eb27f9-55da-4510-9704-756294c3adb6","name":"List Edge Functions","originalRequest":{"method":"GET","header":[],"url":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/edge/functions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"265"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 Sep 2021 21:11:03 GMT"},{"key":"x-amzn-RequestId","value":"4f5cbbc2-d569-44b4-a550-4ba9251732d7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"GZG0CHGAoAMFpMg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-615384e6-0fa51f032e574e397501ff03;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 122731c1a09cfba14dfeeff504946134.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P3"},{"key":"X-Amz-Cf-Id","value":"ornFV3iAc0ac1u_LpzamgxiOZLw1xJu9PR_zwnoWnuA75pO0InG-Lg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"fileExtension\": \"js\",\n \"functionName\": \"add_extra_property\",\n \"functionType\": \"OnDemand\"\n },\n {\n \"fileExtension\": \"js\",\n \"functionName\": \"add_timestamp\",\n \"functionType\": \"OnDemand\"\n },\n {\n \"fileExtension\": \"js\",\n \"functionName\": \"removing_extra_property\",\n \"functionType\": \"OnDemand\"\n }\n ]\n}"}],"_postman_id":"603d3114-e53d-443a-8c04-6d5c872e2a4d"},{"name":"Attach Edge Function","id":"8e40e1da-dfe3-4f4f-b1e7-2e43972b2e62","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"HG67SkLzb17BvBM8TqhYwbWMeHfr3hws\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/edge/functions/:edge-function-name/attach","description":"

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`deviceId`	required	The id of the desired device to attach the edge function.

The name of the edge function to attach to the device.

\n","type":"text/plain"},"type":"any","value":":edge-function-name","key":"edge-function-name"}]}},"response":[{"id":"c834fecb-3e9d-4375-8915-f88aa4e4bfe0","name":"Attach Edge Function","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"MDDUZHTKwKbyDnDuQB5QAOgZMBHkEueT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/edge/functions/:edge-function-name/attach","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","edge","functions",":edge-function-name","attach"],"variable":[{"key":"edge-function-name","value":":edge-function-name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 Sep 2021 21:45:06 GMT"},{"key":"x-amzn-RequestId","value":"89bbde8e-23e9-4445-9016-fa7e7a770a17"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"GZLyxFKnIAMF4Sg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61538cde-4cf271ba4ce3984322c73189;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 626c544a24a86c6cd608360f520b6d8d.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P3"},{"key":"X-Amz-Cf-Id","value":"MnB_x_yWswWfLSBbtBfUJwEvlJvw3Aoa2mM0VmUdvdDrdqQSR3fwEQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Edge Trigger Attached Successfully\"\n }\n}"}],"_postman_id":"8e40e1da-dfe3-4f4f-b1e7-2e43972b2e62"},{"name":"Detach Edge Function","id":"2087d607-0225-46e0-8f5e-4e9fbab0b75b","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"HG67SkLzb17BvBM8TqhYwbWMeHfr3hws\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/edge/functions/:edge-function-name/detach","description":"

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`deviceId`	required	The id of the desired device to detach the edge function.

The name of the edge function to attach to the device.

\n","type":"text/plain"},"type":"any","value":":edge-function-name","key":"edge-function-name"}]}},"response":[{"id":"d654db2f-b6f4-4003-9cae-c61b36adc0dc","name":"Detach Edge Function","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"deviceId\": \"MDDUZHTKwKbyDnDuQB5QAOgZMBHkEueT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/edge/functions/:edge-function-name/detach","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","edge","functions",":edge-function-name","detach"],"variable":[{"key":"edge-function-name","value":":edge-function-name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 Sep 2021 21:46:56 GMT"},{"key":"x-amzn-RequestId","value":"e102721a-d11f-4348-9ceb-f11a65de5d83"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"GZMEIFYRoAMFzSw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61538d4d-078df37f6a5d61da23caf3d4;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 626c544a24a86c6cd608360f520b6d8d.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA56-P3"},{"key":"X-Amz-Cf-Id","value":"0XTR3WGr0aAm1Z4CDZACPODlrLuvLceSSeC2poEkQWE03WJkRcIOcg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Edge Trigger Removed Successfully\"\n }\n}"}],"_postman_id":"2087d607-0225-46e0-8f5e-4e9fbab0b75b"}],"id":"4a85b858-b2bc-4851-9fd4-248ba20007dd","description":"

This section is dedicated to the the edge function related endpoints. Bear in mind that edge function creation still needs to be done by the CloudRail management cloud (https://devices.cloudrail.com). Also for more information regarding edge computing check our documentation.

\n","_postman_id":"4a85b858-b2bc-4851-9fd4-248ba20007dd","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Box","item":[{"name":"Reboot Boxes","id":"c8387713-b65c-4d58-acb0-6ade9e5cfefe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"NmM4ZTBhNWEtNTlhYy00NjQ3LTgzZTEtZTZkZWJiYzkyY2Y5|bCDaXIf-KnZIkrY!&4UG5HjZpoTWPkRvodYV#SnWZD65+NopKH1$LaP.Valoh7Uq"}],"body":{"mode":"raw","raw":"{\n \"boxIds\": [\"box_id_1\", \"box_id_2\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/reboot","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes","reboot"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"851dd81d-c396-47bb-bd8a-bd83c70e22de","name":"Reboot Boxes","originalRequest":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json"},{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"NmM4ZTBhNWEtNTlhYy00NjQ3LTgzZTEtZTZkZWJiYzkyY2Y5|bCDaXIf-KnZIkrY!&4UG5HjZpoTWPkRvodYV#SnWZD65+NopKH1$LaP.Valoh7Uq"}],"body":{"mode":"raw","raw":"{\n \"boxIds\": [\"IRXPlknCbS7AVT7BC5tVCsIshhhe3avl\",\"box_id_2\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/reboot"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"295"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 03:51:34 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696daa45-0e2642a075dfd8321c379792"},{"key":"x-amzn-RequestId","value":"a4283cb9-af83-4268-b1fe-3ab09971488f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"XaeK-GI1FiAEHBQ="},{"key":"Via","value":"1.1 4bf84ba57cd4e2459a129734709037b6.cloudfront.net (CloudFront), 1.1 1ce7d0f67780ff9e4b4a3aaf3348e99c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"T-aqtPuCiJlAosNif1Gr1AuIu6AoMBh1rvfPUZM2VibTtWiCIrF6Ug=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"summary\": {\n \"total\": 2,\n \"success\": 1,\n \"failed\": 1\n },\n \"results\": [\n {\n \"boxId\": \"IRXPlknCbS7AVT7BC5tVCsIshhhe3avl\",\n \"status\": \"success\",\n \"message\": \"Reboot command sent successfully.\"\n },\n {\n \"boxId\": \"box_id_2\",\n \"status\": \"failed\",\n \"message\": \"This box does not exist for this account. Please check the box-id.\"\n }\n ]\n }\n}"}],"_postman_id":"c8387713-b65c-4d58-acb0-6ade9e5cfefe"},{"name":"Box List","id":"5f6e62ad-34b9-4805-a64c-f39bb73ac5c4","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"1a822e70-a8c7-47fa-a47b-2d805a1197b0","name":"Boxes Listed","originalRequest":{"method":"GET","header":[],"url":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 10 Dec 2021 04:25:43 GMT"},{"key":"x-amzn-RequestId","value":"dd8edc2d-97a3-4dc0-9675-1ffd541e0076"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"KHZ-oEcoIAMFRcw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61b2d6c3-291b5ae32446adac5283f2d4;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6e432daa93321d42e8840614082fcdc3.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA6-C1"},{"key":"X-Amz-Cf-Id","value":"H8uV46dBkDKpX6O21h2KiU1vthJOm-VKGM8Ts5mbB3_SOV4iWx5WIw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"II0xKcWRrLHoLRjE0Bu7wo2CztcupWeH\",\n \"name\": \"Enterprise Box\",\n \"loggingEnabled\": true,\n \"description\": \"Captains log... suplemental.\",\n \"firmware\": \"1.8.1\"\n },\n {\n \"id\": \"jS62MATt3VTvK9PzEgxUXFjCFVypUqDG\",\n \"name\": \"Discovery Box\",\n \"loggingEnabled\": true,\n \"description\": \"Warp 7, engage.\",\n \"firmware\": \"1.8.1\"\n }\n ]\n}"}],"_postman_id":"5f6e62ad-34b9-4805-a64c-f39bb73ac5c4"},{"name":"Create Box","id":"33f07a33-06c0-4867-843d-2e513786b3e5","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"test Box\",\n \"description\": \"Cloudrail box\",\n \"id\": \"sss\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes","description":"

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Required	Description
`name`	required	The desired name of the box
`description`	required	A description to also add to the box creation
`id`	required	The Id of the box to be created

","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"398912eb-00cc-4dab-baad-f99eae38fe15","name":"Create Box","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test Box\",\n \"description\": \"Cloudrail box\",\n \"id\": \"cFhDodcAWy7BNkVkdQJWYzrS8JlQ8pSS\",\n \"groups\" : [\"C5emhPSHHhMmMaHkhsy1pqlJ8G1UkkNC\", \"Y5Rkrec5dPJ9CWz7JirZT1zqLtYmpfSh\", \"JkDsu1XA7MYdbYmz5rIDdvhXWOQbLIQy\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Mar 2023 07:02:06 GMT"},{"key":"x-amzn-RequestId","value":"c35d8d3e-4511-4743-945f-227ff680c4f6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"BgGfwFa_hcwFanw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64098464-3c26f57459dc64d506a6c029"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6e65028b4e532eed42927d1fb54e1d6e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P1"},{"key":"X-Amz-Cf-Id","value":"ESaKk1KG2p2wwQmL-mqgwY_eM1OK4s4lCUM3syD_xAfg7_vS-iElYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Box added successfully\"\n }\n}"}],"_postman_id":"33f07a33-06c0-4867-843d-2e513786b3e5"},{"name":"Delete Box","id":"2296c80f-f91f-4e55-b5e1-efba23e7d885","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes/:box-id","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id"],"host":["https://api.cloudrail.com"],"query":[],"variable":[{"id":"ac014783-c458-4634-ae1b-b51375d5d09b","type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"92149b54-9d7a-4584-b9e9-a1e2655ad4f6","name":"Delete Box","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id"],"variable":[{"key":"box-id","value":"XXEsxyeCd87M0jrlgAWV4NVA58oLNZiD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Mar 2023 07:18:28 GMT"},{"key":"x-amzn-RequestId","value":"e1b433ff-4be1-4d9c-a3ae-c6fd7d3adc5f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"BgI6jGf_hcwFRKA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64098843-2ad60f414ee22af7168ca665"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6e65028b4e532eed42927d1fb54e1d6e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P1"},{"key":"X-Amz-Cf-Id","value":"hfq4mQEc7fRXfdy5uTSQ90Ob9_aifuVNdH1HDgIGU-toHYONmzcjIw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Box successfully deleted.\"\n }\n}"}],"_postman_id":"2296c80f-f91f-4e55-b5e1-efba23e7d885"},{"name":"Get Box","event":[{"listen":"prerequest","script":{"id":"99a9aa36-b5d2-4970-b5e1-50afec84b7c0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"29bcbfa5-5b77-4aaa-b66a-5cd440af5234","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"url":"https://api.cloudrail.com/boxes/:box-id","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id"],"host":["https://api.cloudrail.com"],"query":[],"variable":[{"type":"any","value":"IRXPlknCbS7AVT7BC5tVCsIshhhe3avl","key":"box-id"}]}},"response":[{"id":"4c0e5de6-1523-46a6-8292-c88a9e4493bf","name":"Get Box","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id"],"variable":[{"key":"box-id","value":"BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"541"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Mar 2023 07:05:30 GMT"},{"key":"x-amzn-RequestId","value":"78ff59cb-f236-45d2-aec8-1c4747cbdcb0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"BgHBEFA7hcwFnDA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64098539-6954d91b16093c4e7d3acca5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6e65028b4e532eed42927d1fb54e1d6e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P1"},{"key":"X-Amz-Cf-Id","value":"aqq2Ju30EWaDKp1gTIULjZ9foKzqf_u2XFMwGl-nJUyGb3T1PsPp_g=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD\",\n \"status\": \"online\",\n \"name\": \"Pratik's Box\",\n \"loggingEnabled\": true,\n \"greengrassEnabled\": false,\n \"azureIoTEdgeEnabled\": false,\n \"description\": \"Fantastic box that pushes sensor data to cloud.\",\n \"firmware\": \"1.9.5\",\n \"groups\": [\n \"test group 3\",\n \"Box group 1\",\n \"test group 2\",\n \"test group 4\"\n ],\n \"deviceStatuses\": [\n {\n \"id\": \"H1N6dDllYjCPn3wmZMur7BO037Rbjlee\",\n \"name\": \"testDevice1\",\n \"inputId\": \"iolink4\",\n \"status\": \"online\"\n },\n {\n \"id\": \"HDWIUSdGShc8idD1JbxUF1H9oYKS4OKW\",\n \"name\": \"testDevice2\",\n \"inputId\": \"iolink2\",\n \"status\": \"unknown\"\n }\n ]\n }\n}"}],"_postman_id":"29bcbfa5-5b77-4aaa-b66a-5cd440af5234"},{"name":"Edit Box","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"cb1035b8-3146-4de3-8520-47cda5d6c704"}}],"id":"14f2bab5-90b6-4f14-a05b-241415495c84","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Pratik's Box\",\n \"description\": \"Fantastic box thasst pushesss sensor data to cloud.\",\n \"id\": \"sss\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudrail.com/boxes/:box-id","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id"],"host":["https://api.cloudrail.com"],"query":[],"variable":[{"id":"979b9bc1-8009-4693-a1bc-4371b961e138","type":"any","value":":box-id","key":"box-id"}]}},"response":[{"id":"e17c62af-0a57-4d01-a391-8a487e4bc1b1","name":"Edit Box","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Cloudrail Box\",\n \"description\": \"Fantastic box that pushes sensor data to cloud.\",\n \"id\": \"BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://vse8p39evj.execute-api.eu-central-1.amazonaws.com/prod/boxes/:box-id","protocol":"https","host":["vse8p39evj","execute-api","eu-central-1","amazonaws","com"],"path":["prod","boxes",":box-id"],"variable":[{"key":"box-id","value":"BBM0RrLCd87M0jrlgAWV4NVA58oLNZiD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 22 Feb 2023 09:30:37 GMT"},{"key":"x-amzn-RequestId","value":"e53aef3a-e080-41de-a5e2-75353e0c9ed4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"AvANTFxVhcwFq4g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63f5e0bb-7d12002e0a2e060f5e186e00"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7cec9ca881d721957a76cf4d9082182e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P1"},{"key":"X-Amz-Cf-Id","value":"6AZ7J43rzX82mhoLkjf9QlJ7tjhxLZxnl1TjFP-IoBy1yEZloZWETQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"message\": \"Box updated successfully\"\n }\n}"}],"_postman_id":"14f2bab5-90b6-4f14-a05b-241415495c84"}],"id":"d9f863b0-5f1c-4b2b-89c2-85e1775ffe33","_postman_id":"d9f863b0-5f1c-4b2b-89c2-85e1775ffe33","description":"","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Box Groups","item":[{"name":"Box group List","id":"9b3720e4-d206-4831-947b-209990433c54","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.cloudrail.com/groups","description":"

This request returns all box groups in your account with each group containing group details along with boxes in that group.

This request allows you to create a new box group.

Request Body Parameters :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sr. no	Parameter	Required	Data Type	Description
1	name	true	string	Name of box group
2	description	false	string	Description of box group
3	boxes	false	Array of strings	An Array of box serial numbers. These boxes will be added in the group.

This request returns details of particular box group.

This request is used to edit a particular box group. With this request, you can add or remove boxes from a group or change the group's name or description.

Request body paramters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sr. no	Parameter	Required	Data Type	Description
1	add	no	Array of strings	An array of box serial numbers need to be added to the group.
2	remove	no	Array of strings	An array of box serial numbers need to be removed from the group.
3	name	no	string	Name of the group
4	description	no	string	Description of the group

This request is used to delete a particular box group.

Box Groups are collections of boxes which serve the purpose of tagging boxes by whatever attribute the user or organization needs.

\n","_postman_id":"191b60a0-9bd3-48f5-b538-e49f5d53373a","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}},{"name":"Box Update","item":[{"name":"Get Update","id":"fa55be3f-a1a2-4694-94e6-3064bc9219de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id","update"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"ae2be419-1fad-4ec9-827f-25a1ef73eb35","name":"Get Update (None Available)","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 04:08:42 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696dae48-3e8f11e773ac8b063a51b227"},{"key":"x-amzn-RequestId","value":"be7ad08f-1bb3-41c5-bbd1-9332d0330426"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"XagraGRRFiAEUyA="},{"key":"Via","value":"1.1 a7ea69221f8b1ecb9bcdc98891b0e0b2.cloudfront.net (CloudFront), 1.1 b66f38a0aa84ff9d1f85daf54ab2c35a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"LKUxaGEVxFMoFNLcVbCobivVxWuv6DQbQzg6ZE44cpkFQ5O5h8Mf7A=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateAvailable\": false,\n \"statusCode\": 200\n }\n}"},{"id":"92b38925-1357-42f3-af68-73b463d71d57","name":"Get Update (Update Info)","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"180"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 04:12:17 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696daf21-5b68dab321d65abc7c9c59af"},{"key":"x-amzn-RequestId","value":"a11f4b18-2b64-4158-b53d-a6dd800678f3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"XahNOEeRFiAEBeg="},{"key":"Via","value":"1.1 e3fa108e9b3fe9d22878ae63261b1a56.cloudfront.net (CloudFront), 1.1 b66f38a0aa84ff9d1f85daf54ab2c35a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"ip7NE4dA-s6JRfKpu0Z4OBVK3NHmIlYbj6TvBWwXIP8fgBZBOem0hQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateAvailable\": true,\n \"updateDetails\": {\n \"latestFirmwareVersion\": \"2.2.2\",\n \"updateType\": \"app\",\n \"updateSize\": {\n \"downloadSize\": \"1.1GB\",\n \"installSize\": \"3.01GB\"\n }\n },\n \"statusCode\": 200\n }\n}"}],"_postman_id":"fa55be3f-a1a2-4694-94e6-3064bc9219de"},{"name":"Trigger Update","id":"bfde431a-7154-4803-846d-853fe5fd46fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update/","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id","update",""],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"4846e666-a610-47d7-a1e0-099859c8420d","name":"Trigger Update (Successful Initialization)","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 04:09:53 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696dae8c-0d2bc7341e57dc8958efea27"},{"key":"x-amzn-RequestId","value":"23a94e95-2f33-4637-a2df-c7ab48437d75"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"Xag2BGTpliAER8g="},{"key":"Via","value":"1.1 4ebba0c5401e3e42b9618d74bf6dd704.cloudfront.net (CloudFront), 1.1 b66f38a0aa84ff9d1f85daf54ab2c35a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"iQar3dizLOkI2MuIBjI8xf3u0dqX732zCYf-Zi7hLtLAboUeE8eO9g=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateStatus\": \"initiated\",\n \"timestamp\": 1768795793110\n }\n}"}],"_postman_id":"bfde431a-7154-4803-846d-853fe5fd46fe"},{"name":"Get Update Status","id":"984cb7e1-47d3-4871-8a21-91f93055e30e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update-status","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}},"urlObject":{"path":["boxes",":box-id","update-status"],"host":["https://api.cloudrail.com"],"query":[],"variable":[]}},"response":[{"id":"8ec4fe0e-a9d0-4d96-8789-16f5c6b8d042","name":"Get Update Status( In Progress)","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update-status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 04:10:03 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696dae9b-5fba7ca373c8c182495841ef"},{"key":"x-amzn-RequestId","value":"fc688438-9b90-4030-b817-220d0345bc1f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"Xag4UGdEliAEUjw="},{"key":"Via","value":"1.1 9c08d3456a35c9e76373bd2c999067c2.cloudfront.net (CloudFront), 1.1 b66f38a0aa84ff9d1f85daf54ab2c35a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"0UrNvxBidSr3lPogIkbs5upSqVgPTxwZ_BDaCsIcRNqz8Uao2IZXIw=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateState\": \"in_progress\",\n \"timestamp\": 1768795793447,\n \"version\": \"2.2.2\"\n }\n}"},{"id":"023539dd-62ec-4df1-88a6-0f3b30150959","name":"Get Update Status (Successful Update)","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv"}],"url":"https://api.cloudrail.com/boxes/:box-id/update-status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 19 Jan 2026 04:11:30 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-696daef2-46f7a2554d5ca34c40db1369"},{"key":"x-amzn-RequestId","value":"a66f56da-fbfb-4612-86e8-7c1f412a082f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amz-apigw-id","value":"XahF6HVOliAEb8Q="},{"key":"Via","value":"1.1 e3fa108e9b3fe9d22878ae63261b1a56.cloudfront.net (CloudFront), 1.1 b66f38a0aa84ff9d1f85daf54ab2c35a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P6"},{"key":"X-Amz-Cf-Pop","value":"BOM78-P5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"vnSvaPj1iM139VmKwehgmJ79oqkBxJKTT6pbQ8h0gCoeLXTt73kgdA=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateState\": \"success\",\n \"timestamp\": 1768795860508,\n \"version\": \"2.2.2\"\n }\n}"}],"_postman_id":"984cb7e1-47d3-4871-8a21-91f93055e30e"}],"id":"9ded0181-fee2-46b4-b1fc-601c0093d5b5","description":"

This set of APIs provide 3 endpoints.

Get Update : Returns current available update; returns 404 if box max is on latest version.
\n
Trigger Update: Sends command to Box Max to fetch latest updates and apply them. It will always choose latest update, user CANNOT choose which version to update to.
(Since command status updates are asynchronous, there is a 5min(300 seconds) cooldown time for a \"Successful\" update request.)
\n
Get Update Status: This api returns the current status of update.
\n
Here it is important to note that there is a milestone update 2.2.1which enables rootFS update.
Hence all Box.Max have to reach 2.2.1before applying further updates.
This means if you intend to reach 2.2.2 from any version < 2.2.1 you will have to use the API twice.
\n

\n","_postman_id":"9ded0181-fee2-46b4-b1fc-601c0093d5b5","auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""},"isInherited":true,"source":{"_postman_id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","id":"9f5c2693-25f9-4979-9744-dc2c85c5701b","name":"iot-public-api","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","key":""}},"event":[{"listen":"prerequest","script":{"id":"377c2c09-bfa1-4fd7-b802-6d3b240c9614","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a01ac401-a4b9-47d5-a20e-f969f5a54e03","type":"text/javascript","exec":[""]}}],"variable":[{"key":"box-id","value":":box-id"},{"key":"aws-credential-id","value":""},{"key":"device-id","value":":device-id"},{"key":"edge-function-name","value":":edge-function-name"},{"key":"apiKey","value":"Fs70Z0vtHR4pH8IbrJgJladlHqqfykoO7x4lzNdv","type":"string"},{"key":"cr-accept-version","value":"application/vnd.cloudrail.v1+json","type":"string"},{"key":"baseUrl","value":"https://api.cloudrail.com","type":"string"}]}