{
"openapi": "3.0.1",
"info": {
"title": "Cisco Meraki Dashboard API \u2014 camera",
"description": "The camera operations of the Cisco Meraki Dashboard API, split by product area from Cisco's published OpenAPI definition.",
"version": "1.72.0",
"contact": {
"name": "Meraki Developer Community",
"url": "https://meraki.io/community"
},
"x-provenance": {
"method": "harvested",
"authored_by": "Cisco Meraki",
"harvested_by": "API Evangelist",
"harvested_on": "2026-07-31",
"first_party": true,
"note": "Split by first tag from Cisco's published spec3.json; operations unmodified.",
"provider_published": true
},
"x-evidence": [
{
"type": "source",
"url": "https://github.com/meraki/openapi/blob/master/openapi/spec3.json"
},
{
"type": "raw",
"url": "https://raw.githubusercontent.com/meraki/openapi/master/openapi/spec3.json"
},
{
"type": "alternate",
"url": "https://api.meraki.com/api/v1/openapiSpec"
}
]
},
"servers": [
{
"url": "https://api.meraki.com/{basePath}",
"variables": {
"basePath": {
"default": "api/v1"
}
}
}
],
"security": [
{
"meraki_api_key": []
},
{
"bearerAuth": []
}
],
"tags": [
{
"name": "analytics",
"description": ""
},
{
"name": "areas",
"description": ""
},
{
"name": "artifacts",
"description": ""
},
{
"name": "boundaries",
"description": ""
},
{
"name": "byBoundary",
"description": ""
},
{
"name": "byDevice",
"description": ""
},
{
"name": "byInterval",
"description": ""
},
{
"name": "camera",
"description": ""
},
{
"name": "configure",
"description": ""
},
{
"name": "customAnalytics",
"description": ""
},
{
"name": "detections",
"description": ""
},
{
"name": "history",
"description": ""
},
{
"name": "lines",
"description": ""
},
{
"name": "live",
"description": ""
},
{
"name": "monitor",
"description": ""
},
{
"name": "objectDetectionModels",
"description": ""
},
{
"name": "onboarding",
"description": ""
},
{
"name": "overview",
"description": ""
},
{
"name": "permissions",
"description": ""
},
{
"name": "qualityAndRetention",
"description": ""
},
{
"name": "qualityRetentionProfiles",
"description": ""
},
{
"name": "recent",
"description": ""
},
{
"name": "roles",
"description": ""
},
{
"name": "schedules",
"description": ""
},
{
"name": "sense",
"description": ""
},
{
"name": "settings",
"description": ""
},
{
"name": "statuses",
"description": ""
},
{
"name": "video",
"description": ""
},
{
"name": "videoLink",
"description": ""
},
{
"name": "wirelessProfiles",
"description": ""
},
{
"name": "zones",
"description": ""
}
],
"components": {
"securitySchemes": {
"meraki_api_key": {
"type": "apiKey",
"name": "X-Cisco-Meraki-API-Key",
"in": "header"
},
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "API Key"
}
}
},
"paths": {
"/devices/{serial}/camera/analytics/live": {
"get": {
"deprecated": true,
"description": "Returns live state from camera analytics zones",
"operationId": "getDeviceCameraAnalyticsLive",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ts": {
"type": "string",
"description": "The current time"
},
"zones": {
"type": "object",
"properties": {
"zoneId": {
"type": "object",
"properties": {
"person": {
"type": "integer",
"description": "The count per type, dynamic"
}
},
"description": "The zone state, dynamic"
}
},
"description": "The zones state"
}
}
},
"example": {
"ts": "2018-08-15T18:32:38.123Z",
"zones": {
"zoneId": {
"person": 0
}
}
}
}
}
}
},
"summary": "Returns live state from camera analytics zones",
"tags": [
"camera",
"monitor",
"analytics",
"live"
],
"x-deprecation-notice": "Deprecated: This operation has been marked as deprecated. For more information, visit the deprecated operations page"
}
},
"/devices/{serial}/camera/analytics/overview": {
"get": {
"deprecated": true,
"description": "Returns an overview of aggregate analytics data for a timespan",
"operationId": "getDeviceCameraAnalyticsOverview",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 365 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0.",
"schema": {
"type": "string"
}
},
{
"name": "timespan",
"in": "query",
"description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour.",
"schema": {
"type": "number",
"format": "float",
"maximum": 604800
}
},
{
"name": "objectType",
"in": "query",
"description": "[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].",
"schema": {
"type": "string",
"enum": [
"person",
"vehicle"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time"
},
"zoneId": {
"type": "integer",
"description": "The zone id"
},
"entrances": {
"type": "integer",
"description": "The number of sentrances"
},
"averageCount": {
"type": "number",
"format": "float",
"description": "The average count"
}
}
}
},
"example": [
{
"startTs": "2018-08-15T18:32:38.123Z",
"endTs": "2018-08-15T18:33:38.123Z",
"zoneId": 0,
"entrances": 254,
"averageCount": 5.0
}
]
}
}
}
},
"summary": "Returns an overview of aggregate analytics data for a timespan",
"tags": [
"camera",
"monitor",
"analytics",
"overview"
],
"x-deprecation-notice": "Deprecated: This operation has been marked as deprecated. For more information, visit the deprecated operations page"
}
},
"/devices/{serial}/camera/analytics/recent": {
"get": {
"deprecated": true,
"description": "Returns most recent record for analytics zones",
"operationId": "getDeviceCameraAnalyticsRecent",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "objectType",
"in": "query",
"description": "[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].",
"schema": {
"type": "string",
"enum": [
"person",
"vehicle"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time"
},
"zoneId": {
"type": "integer",
"description": "The zone id"
},
"entrances": {
"type": "integer",
"description": "The number of entrances"
},
"averageCount": {
"type": "number",
"format": "float",
"description": "The average count"
}
}
}
},
"example": [
{
"startTs": "2018-08-15T18:32:38.123Z",
"endTs": "2018-08-15T18:33:38.123Z",
"zoneId": 0,
"entrances": 10,
"averageCount": 2.54
}
]
}
}
}
},
"summary": "Returns most recent record for analytics zones",
"tags": [
"camera",
"monitor",
"analytics",
"recent"
],
"x-deprecation-notice": "Deprecated: This operation has been marked as deprecated. For more information, visit the deprecated operations page"
}
},
"/devices/{serial}/camera/analytics/zones": {
"get": {
"deprecated": true,
"description": "Returns all configured analytic zones for this camera",
"operationId": "getDeviceCameraAnalyticsZones",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The zone ID"
},
"type": {
"type": "string",
"description": "The zone type"
},
"label": {
"type": "string",
"description": "The zone label"
},
"regionOfInterest": {
"type": "object",
"properties": {
"x0": {
"type": "string",
"description": "The x0 coordinate"
},
"y0": {
"type": "string",
"description": "The y0 coordinate"
},
"x1": {
"type": "string",
"description": "The x1 coordinate"
},
"y1": {
"type": "string",
"description": "The y1 coordinate"
}
},
"description": "The region of interest"
}
}
}
},
"example": [
{
"id": "0",
"type": "occupancy",
"label": "Full Frame",
"regionOfInterest": {
"x0": "0.00",
"y0": "0.00",
"x1": "1.00",
"y1": "1.00"
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns all configured analytic zones for this camera",
"tags": [
"camera",
"monitor",
"analytics",
"zones"
],
"x-deprecation-notice": "Deprecated: This operation has been marked as deprecated. For more information, visit the deprecated operations page"
}
},
"/devices/{serial}/camera/analytics/zones/{zoneId}/history": {
"get": {
"deprecated": true,
"description": "Return historical records for analytic zones",
"operationId": "getDeviceCameraAnalyticsZoneHistory",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "zoneId",
"in": "path",
"description": "Zone ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "t0",
"in": "query",
"description": "The beginning of the timespan for the data. The maximum lookback period is 365 days from today.",
"schema": {
"type": "string"
}
},
{
"name": "t1",
"in": "query",
"description": "The end of the timespan for the data. t1 can be a maximum of 14 hours after t0.",
"schema": {
"type": "string"
}
},
{
"name": "timespan",
"in": "query",
"description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour.",
"schema": {
"type": "number",
"format": "float",
"maximum": 50400
}
},
{
"name": "resolution",
"in": "query",
"description": "The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60.",
"schema": {
"type": "integer"
}
},
{
"name": "objectType",
"in": "query",
"description": "[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].",
"schema": {
"type": "string",
"enum": [
"person",
"vehicle"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTs": {
"type": "string",
"format": "date-time",
"description": "The start time"
},
"endTs": {
"type": "string",
"format": "date-time",
"description": "The end time"
},
"entrances": {
"type": "integer",
"description": "The number of entrances"
},
"averageCount": {
"type": "number",
"format": "float",
"description": "The average count"
}
}
}
},
"example": [
{
"startTs": "2018-08-15T18:32:38.123Z",
"endTs": "2018-08-15T18:33:38.123Z",
"entrances": 5,
"averageCount": 1.5
}
]
}
}
}
},
"summary": "Return historical records for analytic zones",
"tags": [
"camera",
"monitor",
"analytics",
"zones",
"history"
],
"x-deprecation-notice": "Deprecated: This operation has been marked as deprecated. For more information, visit the deprecated operations page"
}
},
"/devices/{serial}/camera/clip": {
"get": {
"description": "Generate a video clip of up to 5 minutes long.",
"operationId": "clipDeviceCamera",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "startTimestamp",
"in": "query",
"required": true,
"description": "The start time for the clip. The timestamp is expected to be in ISO 8601 format.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endTimestamp",
"in": "query",
"required": true,
"description": "The end time for the clip. The timestamp is expected to be in ISO 8601 format.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "imagerId",
"in": "query",
"description": "The imager ID to query. Required for multi-imager cameras (must be between 1 and the imager count). For single-imager cameras, must be omitted or set to 0.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"202": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Url for the snapshot"
},
"expiry": {
"type": "string",
"description": "Expiration details for snapshot image access"
}
}
},
"example": {
"url": "https://spn4.meraki.com/stream/jpeg/snapshot/b2d123asdf423qd22d2",
"expiry": "Access to the image will expire at 2018-12-11T03:12:39Z."
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:telemetry:write"
]
}
],
"summary": "Generate a video clip of up to 5 minutes long.",
"tags": [
"camera",
"monitor"
]
}
},
"/devices/{serial}/camera/customAnalytics": {
"get": {
"description": "Return custom analytics settings for a camera",
"operationId": "getDeviceCameraCustomAnalytics",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether custom analytics is enabled"
},
"artifactId": {
"type": "string",
"description": "Custom analytics artifact ID"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"value": {
"type": "number",
"format": "float",
"description": "Value of the parameter"
}
}
},
"description": "Parameters for the custom analytics workload"
}
}
},
"example": {
"enabled": true,
"artifactId": "1",
"parameters": [
{
"name": "detection_threshold",
"value": 0.5
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Return custom analytics settings for a camera",
"tags": [
"camera",
"configure",
"customAnalytics"
]
},
"put": {
"description": "Update custom analytics settings for a camera",
"operationId": "updateDeviceCameraCustomAnalytics",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable custom analytics"
},
"artifactId": {
"type": "string",
"description": "The ID of the custom analytics artifact"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"value": {
"type": "string",
"description": "Value of the parameter"
}
},
"required": [
"name",
"value"
]
},
"description": "Parameters for the custom analytics workload"
}
},
"example": {
"enabled": true,
"artifactId": "1",
"parameters": [
{
"name": "detection_threshold",
"value": "0.5"
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether custom analytics is enabled"
},
"artifactId": {
"type": "string",
"description": "Custom analytics artifact ID"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"value": {
"type": "number",
"format": "float",
"description": "Value of the parameter"
}
}
},
"description": "Parameters for the custom analytics workload"
}
}
},
"example": {
"enabled": true,
"artifactId": "1",
"parameters": [
{
"name": "detection_threshold",
"value": 0.5
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update custom analytics settings for a camera",
"tags": [
"camera",
"configure",
"customAnalytics"
]
}
},
"/devices/{serial}/camera/generateSnapshot": {
"post": {
"description": "Generate a snapshot of what the camera sees at the specified time and return a link to that image.",
"operationId": "generateDeviceCameraSnapshot",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"description": "[optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time."
},
"fullframe": {
"type": "boolean",
"description": "[optional] If set to \"true\" the snapshot will be taken at full sensor resolution. This will error if used with timestamp."
}
},
"example": {
"timestamp": "2021-04-30T15:18:08Z",
"fullframe": false
}
}
}
},
"required": false
},
"responses": {
"202": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Url for the snapshot"
},
"expiry": {
"type": "string",
"description": "Expiration details for snapshot image access"
}
}
},
"example": {
"url": "https://spn4.meraki.com/stream/jpeg/snapshot/b2d123asdf423qd22d2",
"expiry": "Access to the image will expire at 2018-12-11T03:12:39Z."
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:telemetry:write"
]
}
],
"summary": "Generate a snapshot of what the camera sees at the specified time and return a link to that image.",
"tags": [
"camera",
"monitor"
]
}
},
"/devices/{serial}/camera/qualityAndRetention": {
"get": {
"description": "Returns quality and retention settings for the given camera",
"operationId": "getDeviceCameraQualityAndRetention",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "Quality and retention profile ID; null if not using a profile",
"nullable": true
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"quality": {
"type": "string",
"description": "Video quality; null when the camera's stored configuration cannot be decoded into a documented quality value",
"nullable": true
},
"resolution": {
"type": "string",
"description": "Video resolution; null when the camera's stored configuration cannot be decoded into a documented resolution value",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
}
}
},
"example": {
"profileId": "1234",
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"restrictedBandwidthModeEnabled": false,
"quality": "Standard",
"resolution": "1280x720",
"motionDetectorVersion": 2
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns quality and retention settings for the given camera",
"tags": [
"camera",
"configure",
"qualityAndRetention"
]
},
"put": {
"description": "Update quality and retention settings for the given camera",
"operationId": "updateDeviceCameraQualityAndRetention",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"nullable": true,
"description": "The ID of a quality and retention profile to assign to the camera. The profile's settings will override all of the per-camera quality and retention settings. If the value of this parameter is null, any existing profile will be unassigned from the camera."
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Boolean indicating if motion-based retention is enabled(true) or disabled(false) on the camera."
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Boolean indicating if audio recording is enabled(true) or disabled(false) on the camera"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera. This setting does not apply to MV2 cameras."
},
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard",
"Ultra"
],
"description": "Quality of the camera. Can be one of 'Standard', 'High', 'Enhanced' or 'Ultra'. Not all qualities are supported by every camera model."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"1280x720",
"1920x1080",
"2112x2112",
"2688x1512",
"2880x2880",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080', '2112x2112', '2880x2880', '2688x1512' or '3840x2160'.Not all resolutions are supported by every camera model."
},
"motionDetectorVersion": {
"type": "integer",
"enum": [
1,
2
],
"description": "The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2."
}
},
"example": {
"profileId": "1234",
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"restrictedBandwidthModeEnabled": false,
"quality": "Standard",
"resolution": "1280x720",
"motionDetectorVersion": 2
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"description": "Quality and retention profile ID; null if not using a profile",
"nullable": true
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"quality": {
"type": "string",
"description": "Video quality; null when the camera's stored configuration cannot be decoded into a documented quality value",
"nullable": true
},
"resolution": {
"type": "string",
"description": "Video resolution; null when the camera's stored configuration cannot be decoded into a documented resolution value",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
}
}
},
"example": {
"profileId": "1234",
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"restrictedBandwidthModeEnabled": false,
"quality": "Standard",
"resolution": "1280x720",
"motionDetectorVersion": 2
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update quality and retention settings for the given camera",
"tags": [
"camera",
"configure",
"qualityAndRetention"
]
}
},
"/devices/{serial}/camera/sense": {
"get": {
"description": "Returns sense settings for a given camera",
"operationId": "getDeviceCameraSense",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"senseEnabled": {
"type": "boolean",
"description": "Whether MV Sense is enabled on the camera"
},
"mqttBrokerId": {
"type": "string",
"description": "ID of the MQTT broker; null if MQTT is disabled",
"nullable": true
},
"mqttTopics": {
"type": "array",
"items": {
"type": "string"
},
"description": "MQTT topics the camera publishes to"
},
"audioDetection": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether audio detection is enabled"
}
},
"description": "Audio detection configuration"
},
"detectionModelId": {
"type": "string",
"description": "ID of the object detection model",
"nullable": true
}
}
},
"example": {
"senseEnabled": true,
"mqttBrokerId": "1234",
"mqttTopics": [
"/merakimv/Q2AA-AAAA-1111/raw_detections",
"/merakimv/Q2AA-AAAA-1111/light"
],
"audioDetection": {
"enabled": false
},
"detectionModelId": "1234"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns sense settings for a given camera",
"tags": [
"camera",
"configure",
"sense"
]
},
"put": {
"description": "Update sense settings for the given camera",
"operationId": "updateDeviceCameraSense",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"senseEnabled": {
"type": "boolean",
"description": "Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera"
},
"mqttBrokerId": {
"type": "string",
"nullable": true,
"description": "The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera"
},
"audioDetection": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera"
}
},
"description": "The details of the audio detection config."
},
"detectionModelId": {
"type": "string",
"description": "The ID of the object detection model"
}
},
"example": {
"senseEnabled": true,
"mqttBrokerId": "1234",
"audioDetection": {
"enabled": false
},
"detectionModelId": "1234"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"senseEnabled": {
"type": "boolean",
"description": "Whether MV Sense is enabled on the camera"
},
"mqttBrokerId": {
"type": "string",
"description": "ID of the MQTT broker; null if MQTT is disabled",
"nullable": true
},
"mqttTopics": {
"type": "array",
"items": {
"type": "string"
},
"description": "MQTT topics the camera publishes to"
},
"audioDetection": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether audio detection is enabled"
}
},
"description": "Audio detection configuration"
},
"detectionModelId": {
"type": "string",
"description": "ID of the object detection model",
"nullable": true
}
}
},
"example": {
"senseEnabled": true,
"mqttBrokerId": "1234",
"mqttTopics": [
"/merakimv/Q2AA-AAAA-1111/raw_detections",
"/merakimv/Q2AA-AAAA-1111/light"
],
"audioDetection": {
"enabled": false
},
"detectionModelId": "1234"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update sense settings for the given camera",
"tags": [
"camera",
"configure",
"sense"
]
}
},
"/devices/{serial}/camera/sense/objectDetectionModels": {
"get": {
"description": "Returns the MV Sense object detection model list for the given camera",
"operationId": "getDeviceCameraSenseObjectDetectionModels",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Model ID"
},
"description": {
"type": "string",
"description": "Model description"
}
}
}
},
"example": [
{
"id": "0",
"description": "Model A"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns the MV Sense object detection model list for the given camera",
"tags": [
"camera",
"configure",
"sense",
"objectDetectionModels"
]
}
},
"/devices/{serial}/camera/video/settings": {
"get": {
"description": "Returns video settings for the given camera",
"operationId": "getDeviceCameraVideoSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"externalRtspEnabled": {
"type": "boolean",
"description": "Boolean indicating if external rtsp stream is exposed"
},
"rtspUrl": {
"type": "string",
"description": "External rstp url. Will only be returned if external rtsp stream is exposed"
}
}
},
"example": {
"externalRtspEnabled": true,
"rtspUrl": "rtsp://10.0.0.1:9000/live"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns video settings for the given camera",
"tags": [
"camera",
"configure",
"video",
"settings"
]
},
"put": {
"description": "Update video settings for the given camera",
"operationId": "updateDeviceCameraVideoSettings",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"externalRtspEnabled": {
"type": "boolean",
"description": "Boolean indicating if external rtsp stream is exposed"
}
},
"example": {
"externalRtspEnabled": true
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"externalRtspEnabled": {
"type": "boolean",
"description": "Boolean indicating if external rtsp stream is exposed"
},
"rtspUrl": {
"type": "string",
"description": "External rstp url. Will only be returned if external rtsp stream is exposed"
}
}
},
"example": {
"externalRtspEnabled": true,
"rtspUrl": "rtsp://10.0.0.1:9000/live"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update video settings for the given camera",
"tags": [
"camera",
"configure",
"video",
"settings"
]
}
},
"/devices/{serial}/camera/videoLink": {
"get": {
"description": "Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.",
"operationId": "getDeviceCameraVideoLink",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "timestamp",
"in": "query",
"description": "[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time.",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL to the camera video stream"
},
"visionUrl": {
"type": "string",
"description": "URL to the Meraki Vision camera view"
}
}
},
"example": {
"url": "https://n1.meraki.com/office-cameras/n/sample/manage/nodes/new_list/1284392014819?timestamp=1284392014819",
"visionUrl": "https://vision.meraki.com/n/2930418/cameras/1284392014819?ts=1284392014819"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns video link to the specified camera",
"tags": [
"camera",
"configure",
"videoLink"
]
}
},
"/devices/{serial}/camera/wirelessProfiles": {
"get": {
"description": "Returns wireless profile assigned to the given camera",
"operationId": "getDeviceCameraWirelessProfiles",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "Primary wireless profile ID"
},
"secondary": {
"type": "string",
"description": "Secondary wireless profile ID"
},
"backup": {
"type": "string",
"description": "Backup wireless profile ID"
}
},
"description": "IDs of assigned wireless profiles"
}
}
},
"example": {
"ids": {
"primary": "3",
"secondary": "2",
"backup": "1"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns wireless profile assigned to the given camera",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
},
"put": {
"description": "Assign wireless profiles to the given camera. Incremental updates are not supported, all profile assignment need to be supplied at once.",
"operationId": "updateDeviceCameraWirelessProfiles",
"parameters": [
{
"name": "serial",
"in": "path",
"description": "Serial",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "The id of the primary wireless profile",
"nullable": true
},
"secondary": {
"type": "string",
"description": "The id of the secondary wireless profile",
"nullable": true
},
"backup": {
"type": "string",
"description": "The id of the backup wireless profile",
"nullable": true
}
},
"description": "The ids of the wireless profile to assign to the given camera"
}
},
"example": {
"ids": {
"primary": "3",
"secondary": "2",
"backup": "1"
}
},
"required": [
"ids"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "Primary wireless profile ID"
},
"secondary": {
"type": "string",
"description": "Secondary wireless profile ID"
},
"backup": {
"type": "string",
"description": "Backup wireless profile ID"
}
},
"description": "IDs of assigned wireless profiles"
}
}
},
"example": {
"ids": {
"primary": "3",
"secondary": "2",
"backup": "1"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Assign wireless profiles to the given camera",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
}
},
"/networks/{networkId}/camera/qualityRetentionProfiles": {
"get": {
"description": "List the quality retention profiles for this network",
"operationId": "getNetworkCameraQualityRetentionProfiles",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the quality retention profile"
},
"networkId": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Name of the quality retention profile"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Whether cloud archive is enabled"
},
"maxRetentionDays": {
"type": "integer",
"description": "Maximum retention days"
},
"scheduleId": {
"type": "string",
"description": "Schedule ID",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether smart retention is enabled"
}
},
"description": "Smart retention settings"
},
"axisVideoQuality": {
"type": "string",
"description": "Video quality settings applied to all Axis cameras"
},
"videoSettings": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"description": "Video quality"
},
"resolution": {
"type": "string",
"description": "Video resolution"
}
},
"description": "Per-model video settings"
},
"description": "Video quality and resolution settings for camera models"
}
}
}
},
"example": [
{
"id": "1234",
"networkId": "N_24329156",
"name": "Sample quality retention profile",
"restrictedBandwidthModeEnabled": true,
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"cloudArchiveEnabled": false,
"maxRetentionDays": 7,
"scheduleId": "1234",
"motionDetectorVersion": 2,
"smartRetention": {
"enabled": true
},
"axisVideoQuality": "enhanced",
"videoSettings": {
"MV32": {
"quality": "Enhanced",
"resolution": "1080x1080"
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "List the quality retention profiles for this network",
"tags": [
"camera",
"configure",
"qualityRetentionProfiles"
]
},
"post": {
"description": "Creates new quality retention profile for this network.",
"operationId": "createNetworkCameraQualityRetentionProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique. This parameter is required."
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras."
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras."
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether or not to record audio. Can be either true or false. Defaults to false."
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Create redundant video backup using Cloud Archive. Can be either true or false. Defaults to false."
},
"motionDetectorVersion": {
"type": "integer",
"description": "The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2."
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if Smart Retention is enabled(true) or disabled(false)."
}
},
"description": "Smart Retention records footage in two qualities and intelligently retains higher quality when motion, people or vehicles are detected."
},
"scheduleId": {
"type": "string",
"nullable": true,
"description": "Schedule for which this camera will record video, or 'null' to always record."
},
"maxRetentionDays": {
"type": "integer",
"nullable": true,
"description": "The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be in the range of one to ninety days."
},
"videoSettings": {
"type": "object",
"properties": {
"MV12/MV22/MV72": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080"
],
"description": "Resolution of the camera. Can be one of '1280x720' or '1920x1080'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV12/MV22/MV72 camera models."
},
"MV12WE": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080"
],
"description": "Resolution of the camera. Can be one of '1280x720' or '1920x1080'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV12WE camera models."
},
"MV13": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV13 camera models."
},
"MV13M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV13M camera models."
},
"MV21/MV71": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720"
],
"description": "Resolution of the camera. Can be one of '1280x720'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV21/MV71 camera models."
},
"MV22X/MV72X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080",
"2688x1512"
],
"description": "Resolution of the camera. Can be one of '1280x720', '1920x1080' or '2688x1512'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV22X/MV72X camera models."
},
"MV23": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23 camera models."
},
"MV23M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23M camera models."
},
"MV23X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23X camera models."
},
"MV32": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112"
],
"description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV32 camera models."
},
"MV33": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV33 camera models."
},
"MV33M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV33M camera models."
},
"MV52": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1280x720', '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV52 camera models."
},
"MV63": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63 camera models."
},
"MV63M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63M camera models."
},
"MV63X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63X camera models."
},
"MV73": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73 camera models."
},
"MV73M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73M camera models."
},
"MV73X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73X camera models."
},
"MV93": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93 camera models."
},
"MV93M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93M camera models."
},
"MV93X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93X camera models."
},
"MV53X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV53X camera models."
},
"MV84X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'Enhanced'."
},
"resolution": {
"type": "string",
"enum": [
"1440x1080",
"2560x1920"
],
"description": "Resolution of the camera. Can be one of '1440x1080' or '2560x1920'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV84X camera models."
},
"MV44X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'Enhanced'."
},
"resolution": {
"type": "string",
"enum": [
"1440x1080",
"2560x1920"
],
"description": "Resolution of the camera. Can be one of '1440x1080' or '2560x1920'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV44X camera models."
},
"MV24": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV24 camera models."
},
"MV74": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV74 camera models."
},
"MV14": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV14 camera models."
},
"MV64": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV64 camera models."
},
"MV54N": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV54N camera models."
},
"MV94": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1768x1768",
"3556x3556"
],
"description": "Resolution of the camera. Can be one of '1768x1768' or '3556x3556'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV94 camera models."
},
"MV34": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1768x1768",
"3556x3556"
],
"description": "Resolution of the camera. Can be one of '1768x1768' or '3556x3556'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV34 camera models."
}
},
"description": "Video quality and resolution settings for all the camera models."
}
},
"example": {
"name": "Sample quality retention profile"
},
"required": [
"name"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the quality retention profile"
},
"networkId": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Name of the quality retention profile"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Whether cloud archive is enabled"
},
"maxRetentionDays": {
"type": "integer",
"description": "Maximum retention days"
},
"scheduleId": {
"type": "string",
"description": "Schedule ID",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether smart retention is enabled"
}
},
"description": "Smart retention settings"
},
"axisVideoQuality": {
"type": "string",
"description": "Video quality settings applied to all Axis cameras"
},
"videoSettings": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"description": "Video quality"
},
"resolution": {
"type": "string",
"description": "Video resolution"
}
},
"description": "Per-model video settings"
},
"description": "Video quality and resolution settings for camera models"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Sample quality retention profile",
"restrictedBandwidthModeEnabled": true,
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"cloudArchiveEnabled": false,
"maxRetentionDays": 7,
"scheduleId": "1234",
"motionDetectorVersion": 2,
"smartRetention": {
"enabled": true
},
"axisVideoQuality": "enhanced",
"videoSettings": {
"MV32": {
"quality": "Enhanced",
"resolution": "1080x1080"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Creates new quality retention profile for this network.",
"tags": [
"camera",
"configure",
"qualityRetentionProfiles"
]
}
},
"/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}": {
"get": {
"description": "Retrieve a single quality retention profile",
"operationId": "getNetworkCameraQualityRetentionProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "qualityRetentionProfileId",
"in": "path",
"description": "Quality retention profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the quality retention profile"
},
"networkId": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Name of the quality retention profile"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Whether cloud archive is enabled"
},
"maxRetentionDays": {
"type": "integer",
"description": "Maximum retention days"
},
"scheduleId": {
"type": "string",
"description": "Schedule ID",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether smart retention is enabled"
}
},
"description": "Smart retention settings"
},
"axisVideoQuality": {
"type": "string",
"description": "Video quality settings applied to all Axis cameras"
},
"videoSettings": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"description": "Video quality"
},
"resolution": {
"type": "string",
"description": "Video resolution"
}
},
"description": "Per-model video settings"
},
"description": "Video quality and resolution settings for camera models"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Sample quality retention profile",
"restrictedBandwidthModeEnabled": true,
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"cloudArchiveEnabled": false,
"maxRetentionDays": 7,
"scheduleId": "1234",
"motionDetectorVersion": 2,
"smartRetention": {
"enabled": true
},
"axisVideoQuality": "enhanced",
"videoSettings": {
"MV32": {
"quality": "Enhanced",
"resolution": "1080x1080"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Retrieve a single quality retention profile",
"tags": [
"camera",
"configure",
"qualityRetentionProfiles"
]
},
"put": {
"description": "Update an existing quality retention profile for this network.",
"operationId": "updateNetworkCameraQualityRetentionProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "qualityRetentionProfileId",
"in": "path",
"description": "Quality retention profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new profile. Must be unique."
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Deletes footage older than 3 days in which no motion was detected. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras."
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Disable features that require additional bandwidth such as Motion Recap. Can be either true or false. Defaults to false. This setting does not apply to MV2 cameras."
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether or not to record audio. Can be either true or false. Defaults to false."
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Create redundant video backup using Cloud Archive. Can be either true or false. Defaults to false."
},
"motionDetectorVersion": {
"type": "integer",
"description": "The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2."
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if Smart Retention is enabled(true) or disabled(false)."
}
},
"description": "Smart Retention records footage in two qualities and intelligently retains higher quality when motion, people or vehicles are detected."
},
"scheduleId": {
"type": "string",
"nullable": true,
"description": "Schedule for which this camera will record video, or 'null' to always record."
},
"maxRetentionDays": {
"type": "integer",
"nullable": true,
"description": "The maximum number of days for which the data will be stored, or 'null' to keep data until storage space runs out. If the former, it can be in the range of one to ninety days."
},
"videoSettings": {
"type": "object",
"properties": {
"MV12/MV22/MV72": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080"
],
"description": "Resolution of the camera. Can be one of '1280x720' or '1920x1080'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV12/MV22/MV72 camera models."
},
"MV12WE": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080"
],
"description": "Resolution of the camera. Can be one of '1280x720' or '1920x1080'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV12WE camera models."
},
"MV13": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV13 camera models."
},
"MV13M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV13M camera models."
},
"MV21/MV71": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720"
],
"description": "Resolution of the camera. Can be one of '1280x720'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV21/MV71 camera models."
},
"MV22X/MV72X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080",
"2688x1512"
],
"description": "Resolution of the camera. Can be one of '1280x720', '1920x1080' or '2688x1512'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV22X/MV72X camera models."
},
"MV23": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23 camera models."
},
"MV23M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23M camera models."
},
"MV23X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV23X camera models."
},
"MV32": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112"
],
"description": "Resolution of the camera. Can be one of '1080x1080' or '2112x2112'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV32 camera models."
},
"MV33": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV33 camera models."
},
"MV33M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV33M camera models."
},
"MV52": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1280x720",
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1280x720', '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV52 camera models."
},
"MV63": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63 camera models."
},
"MV63M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63M camera models."
},
"MV63X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV63X camera models."
},
"MV73": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73 camera models."
},
"MV73M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73M camera models."
},
"MV73X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV73X camera models."
},
"MV93": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93 camera models."
},
"MV93M": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93M camera models."
},
"MV93X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1080x1080",
"2112x2112",
"2880x2880"
],
"description": "Resolution of the camera. Can be one of '1080x1080', '2112x2112' or '2880x2880'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV93X camera models."
},
"MV53X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2688x1512",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2688x1512' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV53X camera models."
},
"MV84X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'Enhanced'."
},
"resolution": {
"type": "string",
"enum": [
"1440x1080",
"2560x1920"
],
"description": "Resolution of the camera. Can be one of '1440x1080' or '2560x1920'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV84X camera models."
},
"MV44X": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'Enhanced'."
},
"resolution": {
"type": "string",
"enum": [
"1440x1080",
"2560x1920"
],
"description": "Resolution of the camera. Can be one of '1440x1080' or '2560x1920'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV44X camera models."
},
"MV24": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV24 camera models."
},
"MV74": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV74 camera models."
},
"MV14": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV14 camera models."
},
"MV64": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV64 camera models."
},
"MV54N": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"Enhanced",
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard', 'Enhanced' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1920x1080",
"2560x1440",
"3840x2160"
],
"description": "Resolution of the camera. Can be one of '1920x1080', '2560x1440' or '3840x2160'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV54N camera models."
},
"MV94": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1768x1768",
"3556x3556"
],
"description": "Resolution of the camera. Can be one of '1768x1768' or '3556x3556'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV94 camera models."
},
"MV34": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"enum": [
"High",
"Standard"
],
"description": "Quality of the camera. Can be one of 'Standard' or 'High'."
},
"resolution": {
"type": "string",
"enum": [
"1768x1768",
"3556x3556"
],
"description": "Resolution of the camera. Can be one of '1768x1768' or '3556x3556'."
}
},
"required": [
"quality",
"resolution"
],
"description": "Quality and resolution for MV34 camera models."
}
},
"description": "Video quality and resolution settings for all the camera models."
}
},
"example": {}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the quality retention profile"
},
"networkId": {
"type": "string",
"description": "Network ID"
},
"name": {
"type": "string",
"description": "Name of the quality retention profile"
},
"restrictedBandwidthModeEnabled": {
"type": "boolean",
"description": "Whether restricted bandwidth mode is enabled"
},
"motionBasedRetentionEnabled": {
"type": "boolean",
"description": "Whether motion-based retention is enabled"
},
"audioRecordingEnabled": {
"type": "boolean",
"description": "Whether audio recording is enabled"
},
"cloudArchiveEnabled": {
"type": "boolean",
"description": "Whether cloud archive is enabled"
},
"maxRetentionDays": {
"type": "integer",
"description": "Maximum retention days"
},
"scheduleId": {
"type": "string",
"description": "Schedule ID",
"nullable": true
},
"motionDetectorVersion": {
"type": "integer",
"description": "Motion detector version"
},
"smartRetention": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether smart retention is enabled"
}
},
"description": "Smart retention settings"
},
"axisVideoQuality": {
"type": "string",
"description": "Video quality settings applied to all Axis cameras"
},
"videoSettings": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"quality": {
"type": "string",
"description": "Video quality"
},
"resolution": {
"type": "string",
"description": "Video resolution"
}
},
"description": "Per-model video settings"
},
"description": "Video quality and resolution settings for camera models"
}
}
},
"example": {
"id": "1234",
"networkId": "N_24329156",
"name": "Sample quality retention profile",
"restrictedBandwidthModeEnabled": true,
"motionBasedRetentionEnabled": false,
"audioRecordingEnabled": false,
"cloudArchiveEnabled": false,
"maxRetentionDays": 7,
"scheduleId": "1234",
"motionDetectorVersion": 2,
"smartRetention": {
"enabled": true
},
"axisVideoQuality": "enhanced",
"videoSettings": {
"MV32": {
"quality": "Enhanced",
"resolution": "1080x1080"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update an existing quality retention profile for this network.",
"tags": [
"camera",
"configure",
"qualityRetentionProfiles"
]
},
"delete": {
"description": "Delete an existing quality retention profile for this network.",
"operationId": "deleteNetworkCameraQualityRetentionProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "qualityRetentionProfileId",
"in": "path",
"description": "Quality retention profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Delete an existing quality retention profile for this network.",
"tags": [
"camera",
"configure",
"qualityRetentionProfiles"
]
}
},
"/networks/{networkId}/camera/schedules": {
"get": {
"description": "Returns a list of all camera recording schedules.",
"operationId": "getNetworkCameraSchedules",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Schedule id"
},
"name": {
"type": "string",
"description": "Schedule name"
}
}
}
},
"example": [
{
"id": "123",
"name": "Weekday schedule"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns a list of all camera recording schedules.",
"tags": [
"camera",
"configure",
"schedules"
]
}
},
"/networks/{networkId}/camera/wirelessProfiles": {
"post": {
"description": "Creates a new camera wireless profile for this network.",
"operationId": "createNetworkCameraWirelessProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the camera wireless profile. This parameter is required."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"enum": [
"8021x-radius",
"psk"
],
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID. It can be set to ('wpa', 'wpa-eap'). With 'wpa' mode, the authMode should be 'psk' and with 'wpa-eap' the authMode should be '8021x-radius'"
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID."
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
},
"example": {
"name": "wireless profile A",
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
},
"required": [
"name",
"ssid"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the camera wireless profile."
},
"name": {
"type": "string",
"description": "The name of the camera wireless profile."
},
"appliedDeviceCount": {
"type": "integer",
"description": "The count of the applied devices."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID."
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID, if mode is PSK"
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
}
},
"example": {
"id": "152",
"name": "wireless profile A",
"appliedDeviceCount": 0,
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Creates a new camera wireless profile for this network.",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
},
"get": {
"description": "List the camera wireless profiles for this network.",
"operationId": "getNetworkCameraWirelessProfiles",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the camera wireless profile."
},
"name": {
"type": "string",
"description": "The name of the camera wireless profile."
},
"appliedDeviceCount": {
"type": "integer",
"description": "The count of the applied devices."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID."
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID, if mode is PSK"
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
}
}
},
"example": [
{
"id": "152",
"name": "wireless profile A",
"appliedDeviceCount": 0,
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "List the camera wireless profiles for this network.",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
}
},
"/networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId}": {
"get": {
"description": "Retrieve a single camera wireless profile.",
"operationId": "getNetworkCameraWirelessProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "wirelessProfileId",
"in": "path",
"description": "Wireless profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the camera wireless profile."
},
"name": {
"type": "string",
"description": "The name of the camera wireless profile."
},
"appliedDeviceCount": {
"type": "integer",
"description": "The count of the applied devices."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID."
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID, if mode is PSK"
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
}
},
"example": {
"id": "152",
"name": "wireless profile A",
"appliedDeviceCount": 0,
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Retrieve a single camera wireless profile.",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
},
"put": {
"description": "Update an existing camera wireless profile in this network.",
"operationId": "updateNetworkCameraWirelessProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "wirelessProfileId",
"in": "path",
"description": "Wireless profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the camera wireless profile."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"enum": [
"8021x-radius",
"psk"
],
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID. It can be set to ('wpa', 'wpa-eap'). With 'wpa' mode, the authMode should be 'psk' and with 'wpa-eap' the authMode should be '8021x-radius'"
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID."
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
},
"example": {
"name": "wireless profile A",
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the camera wireless profile."
},
"name": {
"type": "string",
"description": "The name of the camera wireless profile."
},
"appliedDeviceCount": {
"type": "integer",
"description": "The count of the applied devices."
},
"ssid": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SSID."
},
"authMode": {
"type": "string",
"description": "The auth mode of the SSID. It can be set to ('psk', '8021x-radius')."
},
"encryptionMode": {
"type": "string",
"description": "The encryption mode of the SSID."
},
"psk": {
"type": "string",
"description": "The pre-shared key of the SSID, if mode is PSK"
}
},
"description": "The details of the SSID config."
},
"identity": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the identity."
},
"password": {
"type": "string",
"description": "The password of the identity."
}
},
"description": "The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode."
}
}
},
"example": {
"id": "152",
"name": "wireless profile A",
"appliedDeviceCount": 0,
"ssid": {
"name": "ssid test",
"authMode": "8021x-radius",
"encryptionMode": "wpa-eap",
"psk": "sampleKey"
},
"identity": {
"username": "identityname",
"password": "password123"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update an existing camera wireless profile in this network.",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
},
"delete": {
"description": "Delete an existing camera wireless profile for this network.",
"operationId": "deleteNetworkCameraWirelessProfile",
"parameters": [
{
"name": "networkId",
"in": "path",
"description": "Network ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "wirelessProfileId",
"in": "path",
"description": "Wireless profile ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Delete an existing camera wireless profile for this network.",
"tags": [
"camera",
"configure",
"wirelessProfiles"
]
}
},
"/organizations/{organizationId}/camera/boundaries/areas/byDevice": {
"get": {
"description": "Returns all configured area boundaries of cameras",
"operationId": "getOrganizationCameraBoundariesAreasByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "serials",
"in": "query",
"description": "A list of serial numbers. The returned cameras will be filtered to only include these serials.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network id of the camera"
},
"serial": {
"type": "string",
"description": "The serial number of the camera"
},
"boundaries": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The area boundary id"
},
"type": {
"type": "string",
"description": "The area boundary type"
},
"name": {
"type": "string",
"description": "The area boundary name"
},
"vertices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "number",
"format": "float",
"description": "The vertex x coordinate"
},
"y": {
"type": "number",
"format": "float",
"description": "The vertex y coordinate"
}
}
},
"description": "The area boundary vertices"
}
},
"description": "Configured area boundaries of the camera"
}
}
}
},
"example": [
{
"networkId": "N_24329156",
"serial": "Q234-ABCD-5678",
"boundaries": {
"id": "k74272e",
"type": "area",
"name": "myarea",
"vertices": [
{
"x": 0.1,
"y": 0.1
}
]
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns all configured area boundaries of cameras",
"tags": [
"camera",
"configure",
"boundaries",
"areas",
"byDevice"
]
}
},
"/organizations/{organizationId}/camera/boundaries/lines/byDevice": {
"get": {
"description": "Returns all configured crossingline boundaries of cameras",
"operationId": "getOrganizationCameraBoundariesLinesByDevice",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "serials",
"in": "query",
"description": "A list of serial numbers. The returned cameras will be filtered to only include these serials.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "The network id of the camera"
},
"serial": {
"type": "string",
"description": "The serial number of the camera"
},
"boundaries": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The line boundary id"
},
"type": {
"type": "string",
"description": "The line boundary type"
},
"name": {
"type": "string",
"description": "The line boundary name"
},
"vertices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "number",
"format": "float",
"description": "The vertex x coordinate"
},
"y": {
"type": "number",
"format": "float",
"description": "The vertex y coordinate"
}
}
},
"description": "The line boundary vertices"
},
"directionVertex": {
"type": "object",
"properties": {
"x": {
"type": "number",
"format": "float",
"description": "The vertex x coordinate"
},
"y": {
"type": "number",
"format": "float",
"description": "The vertex y coordinate"
}
},
"description": "The line boundary crossing direction vertex"
}
},
"description": "Configured line boundaries of the camera"
}
}
}
},
"example": [
{
"networkId": "N_24329156",
"serial": "Q234-ABCD-5678",
"boundaries": {
"id": "k74272e",
"type": "line",
"name": "mycline",
"vertices": [
{
"x": 0.375,
"y": 0.5
}
],
"directionVertex": {
"x": 0.5,
"y": 0.54
}
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns all configured crossingline boundaries of cameras",
"tags": [
"camera",
"configure",
"boundaries",
"lines",
"byDevice"
]
}
},
"/organizations/{organizationId}/camera/customAnalytics/artifacts": {
"get": {
"description": "List Custom Analytics Artifacts",
"operationId": "getOrganizationCameraCustomAnalyticsArtifacts",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifactId": {
"type": "string",
"description": "Custom analytics artifact ID"
},
"organizationId": {
"type": "string",
"description": "Organization ID"
},
"name": {
"type": "string",
"description": "Custom analytics artifact name"
},
"status": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Status type"
},
"message": {
"type": "string",
"description": "Status message"
}
},
"description": "Custom analytics artifact status"
}
}
}
},
"example": [
{
"artifactId": "1",
"organizationId": "2",
"name": "example",
"status": {
"type": "pending",
"message": "sample message"
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "List Custom Analytics Artifacts",
"tags": [
"camera",
"configure",
"customAnalytics",
"artifacts"
]
},
"post": {
"description": "Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.",
"operationId": "createOrganizationCameraCustomAnalyticsArtifact",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique name of the artifact"
}
},
"example": {
"name": "example"
}
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"artifactId": {
"type": "string",
"description": "Custom analytics artifact ID"
},
"organizationId": {
"type": "string",
"description": "Organization ID"
},
"name": {
"type": "string",
"description": "Custom analytics artifact name"
},
"status": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Status type"
},
"message": {
"type": "string",
"description": "Status message"
}
},
"description": "Custom analytics artifact status"
},
"uploadId": {
"type": "string",
"description": "Upload ID"
},
"uploadUrl": {
"type": "string",
"description": "Upload URL"
},
"uploadUrlExpiry": {
"type": "string",
"format": "date-time",
"description": "Upload URL expiry time"
}
}
},
"example": {
"artifactId": "1",
"organizationId": "2",
"name": "example",
"status": {
"type": "pending",
"message": "sample message"
},
"uploadId": "00112233445566778899aabbccddeeff",
"uploadUrl": "https://meraki_custom_cv_upload_url",
"uploadUrlExpiry": "2022-01-23T01:23:45.123456+00:00"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Create custom analytics artifact",
"tags": [
"camera",
"configure",
"customAnalytics",
"artifacts"
]
}
},
"/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}": {
"get": {
"description": "Get Custom Analytics Artifact",
"operationId": "getOrganizationCameraCustomAnalyticsArtifact",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "artifactId",
"in": "path",
"description": "Artifact ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"artifactId": {
"type": "string",
"description": "Custom analytics artifact ID"
},
"organizationId": {
"type": "string",
"description": "Organization ID"
},
"name": {
"type": "string",
"description": "Custom analytics artifact name"
},
"status": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Status type"
},
"message": {
"type": "string",
"description": "Status message"
}
},
"description": "Custom analytics artifact status"
}
}
},
"example": {
"artifactId": "1",
"organizationId": "2",
"name": "example",
"status": {
"type": "pending",
"message": "sample message"
}
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Get Custom Analytics Artifact",
"tags": [
"camera",
"configure",
"customAnalytics",
"artifacts"
]
},
"delete": {
"description": "Delete Custom Analytics Artifact",
"operationId": "deleteOrganizationCameraCustomAnalyticsArtifact",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "artifactId",
"in": "path",
"description": "Artifact ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Delete Custom Analytics Artifact",
"tags": [
"camera",
"configure",
"customAnalytics",
"artifacts"
]
}
},
"/organizations/{organizationId}/camera/detections/history/byBoundary/byInterval": {
"get": {
"description": "Returns analytics data for timespans",
"operationId": "getOrganizationCameraDetectionsHistoryByBoundaryByInterval",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "boundaryIds",
"in": "query",
"required": true,
"description": "A list of boundary ids. The returned cameras will be filtered to only include these ids.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ranges",
"in": "query",
"required": true,
"description": "A list of time ranges with intervals",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"description": "The range start time"
},
"endTime": {
"type": "string",
"description": "The range end time"
},
"interval": {
"type": "integer",
"description": "The range interval in seconds"
}
},
"required": [
"startTime",
"endTime",
"interval"
]
}
}
},
{
"name": "duration",
"in": "query",
"description": "The minimum time, in seconds, that the person or car remains in the area to be counted. Defaults to boundary configuration or 60.",
"schema": {
"type": "integer"
}
},
{
"name": "perPage",
"in": "query",
"description": "The number of entries per page returned. Acceptable range is 1 - 1000. Defaults to 1000.",
"schema": {
"type": "integer"
}
},
{
"name": "boundaryTypes",
"in": "query",
"description": "The detection types. Defaults to 'person'.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"person",
"vehicle"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"boundaryId": {
"type": "string",
"description": "The boundary id"
},
"type": {
"type": "string",
"description": "The boundary type"
},
"results": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"description": "The period start time"
},
"endTime": {
"type": "string",
"description": "The period end time"
},
"objectType": {
"type": "string",
"description": "The detection type"
},
"in": {
"type": "integer",
"description": "The number of detections entered"
},
"out": {
"type": "integer",
"description": "The number of detections exited"
}
},
"description": "The analytics data"
}
}
}
},
"example": [
{
"boundaryId": "k74272e",
"type": "line",
"results": {
"startTime": "2018-02-11T00:00:00Z",
"endTime": "2018-05-12T00:00:00Z",
"objectType": "person",
"in": 22,
"out": 13
}
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Returns analytics data for timespans",
"tags": [
"camera",
"configure",
"detections",
"history",
"byBoundary",
"byInterval"
]
}
},
"/organizations/{organizationId}/camera/onboarding/statuses": {
"get": {
"description": "Fetch onboarding status of cameras",
"operationId": "getOrganizationCameraOnboardingStatuses",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "serials",
"in": "query",
"description": "A list of serial numbers. The returned cameras will be filtered to only include these serials.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "networkIds",
"in": "query",
"description": "A list of network IDs. The returned cameras will be filtered to only include these networks.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"networkId": {
"type": "string",
"description": "Network ID"
},
"serial": {
"type": "string",
"description": "Camera serial number"
},
"status": {
"type": "string",
"description": "Onboarding status"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "When the status was last updated"
}
}
}
},
"example": [
{
"networkId": "N_12345",
"serial": "Q234-ABCD-5678",
"status": "pending onboarding",
"updatedAt": "2018-02-11T00:00:00.090210Z"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:telemetry:read"
]
}
],
"summary": "Fetch onboarding status of cameras",
"tags": [
"camera",
"configure",
"onboarding",
"statuses"
]
},
"put": {
"description": "Notify that credential handoff to camera has completed",
"operationId": "updateOrganizationCameraOnboardingStatuses",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"serial": {
"type": "string",
"description": "Serial of camera"
},
"wirelessCredentialsSent": {
"type": "boolean",
"description": "Note whether credentials were sent successfully"
}
},
"example": {
"serial": "Q234-ABCD-5678",
"wirelessCredentialsSent": true
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Whether the update succeeded"
}
}
},
"example": {
"success": true
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:telemetry:write"
]
}
],
"summary": "Notify that credential handoff to camera has completed",
"tags": [
"camera",
"configure",
"onboarding",
"statuses"
]
}
},
"/organizations/{organizationId}/camera/permissions": {
"get": {
"description": "List the permissions scopes for this organization",
"operationId": "getOrganizationCameraPermissions",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Permission scope id"
},
"name": {
"type": "string",
"description": "Name of permission scope"
},
"level": {
"type": "string",
"description": "Permission scope level"
}
}
}
},
"example": [
{
"id": "1234",
"name": "camera_video",
"level": "live_video"
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "List the permissions scopes for this organization",
"tags": [
"camera",
"configure",
"permissions"
]
}
},
"/organizations/{organizationId}/camera/permissions/{permissionScopeId}": {
"get": {
"description": "Retrieve a single permission scope",
"operationId": "getOrganizationCameraPermission",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "permissionScopeId",
"in": "path",
"description": "Permission scope ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Permission scope id"
},
"name": {
"type": "string",
"description": "Name of permission scope"
},
"level": {
"type": "string",
"description": "Permission scope level"
}
}
},
"example": {
"id": "1234",
"name": "camera_video",
"level": "live_video"
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Retrieve a single permission scope",
"tags": [
"camera",
"configure",
"permissions"
]
}
},
"/organizations/{organizationId}/camera/roles": {
"get": {
"description": "List all the roles in this organization",
"operationId": "getOrganizationCameraRoles",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the role"
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag"
},
"id": {
"type": "string",
"description": "Device ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Devices the role is applied to"
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Networks the role is applied to"
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Organization tag"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Organization-wide permissions"
}
}
}
},
"example": [
{
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1",
"permissionScope": "camera-video",
"permissionLevel": "view_and_export"
}
],
"appliedOnNetworks": [
{
"tag": "",
"id": "2568",
"permissionScopeId": "2",
"permissionScope": "camera-video",
"permissionLevel": "view"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"permissionScopeId": "2",
"permissionScope": "camera_video",
"permissionLevel": "view_live"
}
]
}
]
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "List all the roles in this organization",
"tags": [
"camera",
"configure",
"roles"
]
},
"post": {
"description": "Creates new role for this organization.",
"operationId": "createOrganizationCameraRole",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new role. Must be unique. This parameter is required."
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag."
},
"id": {
"type": "string",
"description": "Device id."
},
"inNetworksWithTag": {
"type": "string",
"description": "Network tag scope"
},
"inNetworksWithId": {
"type": "string",
"description": "Network id scope"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Device tag on which this specified permission is applied."
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network id."
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Network tag on which this specified permission is applied."
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Permissions to be applied org wide."
}
},
"example": {
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1"
}
],
"appliedOnNetworks": [
{
"tag": "building-a",
"id": "",
"permissionScopeId": "2"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"id": "",
"permissionScopeId": "2"
}
]
},
"required": [
"name"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the role"
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag"
},
"id": {
"type": "string",
"description": "Device ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Devices the role is applied to"
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Networks the role is applied to"
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Organization tag"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Organization-wide permissions"
}
}
},
"example": {
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1",
"permissionScope": "camera-video",
"permissionLevel": "view_and_export"
}
],
"appliedOnNetworks": [
{
"tag": "",
"id": "2568",
"permissionScopeId": "2",
"permissionScope": "camera-video",
"permissionLevel": "view"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"permissionScopeId": "2",
"permissionScope": "camera_video",
"permissionLevel": "view_live"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Creates new role for this organization.",
"tags": [
"camera",
"configure",
"roles"
]
}
},
"/organizations/{organizationId}/camera/roles/{roleId}": {
"get": {
"description": "Retrieve a single role.",
"operationId": "getOrganizationCameraRole",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the role"
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag"
},
"id": {
"type": "string",
"description": "Device ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Devices the role is applied to"
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Networks the role is applied to"
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Organization tag"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Organization-wide permissions"
}
}
},
"example": {
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1",
"permissionScope": "camera-video",
"permissionLevel": "view_and_export"
}
],
"appliedOnNetworks": [
{
"tag": "",
"id": "2568",
"permissionScopeId": "2",
"permissionScope": "camera-video",
"permissionLevel": "view"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"permissionScopeId": "2",
"permissionScope": "camera_video",
"permissionLevel": "view_live"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:read"
]
}
],
"summary": "Retrieve a single role.",
"tags": [
"camera",
"configure",
"roles"
]
},
"delete": {
"description": "Delete an existing role for this organization.",
"operationId": "deleteOrganizationCameraRole",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Successful operation"
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Delete an existing role for this organization.",
"tags": [
"camera",
"configure",
"roles"
]
},
"put": {
"description": "Update an existing role in this organization.",
"operationId": "updateOrganizationCameraRole",
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "Organization ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new role. Must be unique."
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag."
},
"id": {
"type": "string",
"description": "Device id."
},
"inNetworksWithTag": {
"type": "string",
"description": "Network tag scope"
},
"inNetworksWithId": {
"type": "string",
"description": "Network id scope"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Device tag on which this specified permission is applied."
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network id"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Network tag on which this specified permission is applied."
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permissionScopeId": {
"type": "string",
"description": "Permission scope id"
}
},
"required": [
"permissionScopeId"
]
},
"description": "Permissions to be applied org wide."
}
},
"example": {
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1"
}
],
"appliedOnNetworks": [
{
"tag": "building-a",
"id": "",
"permissionScopeId": "2"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"id": "",
"permissionScopeId": "2"
}
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the role"
},
"appliedOnDevices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Device tag"
},
"id": {
"type": "string",
"description": "Device ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Devices the role is applied to"
},
"appliedOnNetworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Network tag"
},
"id": {
"type": "string",
"description": "Network ID"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Networks the role is applied to"
},
"appliedOrgWide": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Organization tag"
},
"permissionScopeId": {
"type": "string",
"description": "Permission scope ID"
},
"permissionScope": {
"type": "string",
"description": "Permission scope name"
},
"permissionLevel": {
"type": "string",
"enum": [
"full_access",
"read_only",
"view",
"view_and_export",
"view_live"
],
"description": "Permission level"
}
}
},
"description": "Organization-wide permissions"
}
}
},
"example": {
"name": "Security_Guard",
"appliedOnDevices": [
{
"tag": "reception-desk",
"id": "",
"permissionScopeId": "1",
"permissionScope": "camera-video",
"permissionLevel": "view_and_export"
}
],
"appliedOnNetworks": [
{
"tag": "",
"id": "2568",
"permissionScopeId": "2",
"permissionScope": "camera-video",
"permissionLevel": "view"
}
],
"appliedOrgWide": [
{
"tag": "building-a",
"permissionScopeId": "2",
"permissionScope": "camera_video",
"permissionLevel": "view_live"
}
]
}
}
}
}
},
"security": [
{
"oauth2": [
"camera:config:write"
]
}
],
"summary": "Update an existing role in this organization.",
"tags": [
"camera",
"configure",
"roles"
]
}
}
}
}