api.postman_collection.json

{
	"info": {
		"_postman_id": "ccf05e5f-96ee-4ded-9f2f-6a165f5352c4",
		"name": "ArloAPI",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "List Devices",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/device",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device"
					]
				}
			},
			"response": []
		},
		{
			"name": "Device set friendlyname",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"name\": \"My Friendly Name\"}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/friendlyname",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"friendlyname"
					]
				}
			},
			"response": []
		},
		{
			"name": "Device status request",
			"request": {
				"method": "POST",
				"header": [],
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/statusrequest",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"statusrequest"
					]
				},
				"description": "Request the device to send a status update."
			},
			"response": []
		},
		{
			"name": "Device Status",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "Device Registration",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/registration",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"registration"
					]
				}
			},
			"response": []
		},
		{
			"name": "Device set UserStreamActive",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"active\":0}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/userstreamactive",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"userstreamactive"
					]
				},
				"description": "Appears to be called when the user requests a stream from the mobile app.\n\nSet to 1 after the user starts streaming, and 0 when they stop."
			},
			"response": []
		},
		{
			"name": "Device Audio Mic",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"enabled\":true}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/audiomic",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"audiomic"
					]
				},
				"description": "Doesn't appear to prevent audio recordings?"
			},
			"response": []
		},
		{
			"name": "Device Audio Speaker",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"enabled\":true}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/audiospeaker",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"audiospeaker"
					]
				},
				"description": "Doesn't prevent audio transmissions?"
			},
			"response": []
		},
		{
			"name": "Device Arm",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"PIRTargetState\":\"Disarmed\",\"VideoMotionEstimationEnable\":false,\"AudioTargetState\":\"Disarmed\"}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/arm",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"arm"
					]
				},
				"description": "Its unclear what VideoMotionEstimationEnable does - it doesn't appear to do anything on its own."
			},
			"response": []
		},
		{
			"name": "Device PIR LED",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"enabled\":false,\"sensitivity\":80}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/pirled",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"pirled"
					]
				},
				"description": "Causes an amber LED to flash when the PIR sensor is triggered. Does not activate device alerts."
			},
			"response": []
		},
		{
			"name": "Device Set Quality",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"quality\":\"high\"}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/quality",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"quality"
					]
				},
				"description": "Set to high, medium, low or subscription presets."
			},
			"response": []
		},
		{
			"name": "Device Set Activity Zones",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{stuff}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/activityzones",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"activityzones"
					]
				},
				"description": "Can set up to 3 activity zones..."
			},
			"response": []
		},
		{
			"name": "Device Unset Activity Zones",
			"request": {
				"method": "DELETE",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/activityzones",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"activityzones"
					]
				},
				"description": "Removes all activity zones."
			},
			"response": []
		},
		{
			"name": "Device Request Snapshot",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\"url\":\"http://172.14.1.1:5000/snapshot/blah/temp.jpg\"}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{base_url}}/device/{{serial_number}}/snapshot",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"device",
						"{{serial_number}}",
						"snapshot"
					]
				}
			},
			"response": []
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"id": "d6bacf95-bac4-44b3-90a5-7a52a9477f6b",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"id": "c0d8ad19-5ec5-4aba-9eb6-b6d6856b7355",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"id": "22f284c3-aa17-49d4-a8d7-f5de49ca86fa",
			"key": "base_url",
			"value": "http://localhost:5000"
		},
		{
			"id": "ea117322-3d44-45cc-8178-53c0ed80f22c",
			"key": "serial_number",
			"value": "test"
		}
	],
	"protocolProfileBehavior": {}
}