Update Device Configurations
Update requests use JSON Patch syntax.
When using JSON Patch you are required to specify a Content-Type header with value application/json-patch+json.
PATCH/v1/deviceConfigurations
Query Parameters
deviceId
stringrequired
Update device configurations by device ID.
Body Parameters
op
enum
remove
string
Remove the configured value and revert back to the default from schema, if present.
replace
string
Set the configured value
path
string
Only paths ending in /sources/configured/value are supported.
value
One of string OR number OR boolean
Response Properties
deviceId
string
Id of the device that the configurations are for.
items
Device Configuration
configuration_key
object
Key of the configuration
source
enum
The source of the current value that is applied to the device
default
string
Current value comes from the schema default
configured
string
Current value comes from configuredValue
sources
object
default
object
editability
object
isEditable
boolean
Whether or not the value is editable on this source (always false for "default")
reason
string
The reason value is not editable on this source (always "FACTORY_DEFAULT" for "default")
configured
object
editability
object
isEditable
boolean
Whether or not the value is editable on this source
reason
enum
The reason the value is not editable on this source
NOT_AUTHORIZED
string
User is not authorized to edit any values
CONFIG_MANAGED_BY_DIFFERENT_AUTHORITY
string
The configuration is managed by a different authority. For example CUCM.
valueSpace
object
JSON Schema describing the data format of the configuration as specified by the device.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
PATCH
/v1/deviceConfigurations{?deviceId}
Log in to try the API.
Header
Query Parameters
- Update device configurations by device ID.
Body
https://webexapis.com/v1/deviceConfigurations?deviceId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=
{
"op": "replace",
"path": "Audio.Ultrasound.MaxVolume/sources/configured/value",
"value": "enabled"
}201 / Created
{
"deviceId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=",
"items": {
"Audio.Ultrasound.MaxVolume": {
"value": 50,
"source": "configured",
"sources": {
"default": {
"value": 70,
"editability": {
"isEditable": false,
"reason": "FACTORY_DEFAULT"
}
},
"configured": {
"value": 50,
"editability": {
"isEditable": true
}
}
},
"valueSpace": {
"type": "integer",
"maximum": 100,
"minimum": 0
}
},
"FacilityService.Service[1].Name": {
"value": "Live Support",
"source": "default",
"sources": {
"default": {
"value": "Live Support",
"editability": {
"isEditable": false,
"reason": "FACTORY_DEFAULT"
}
},
"configured": {
"value": null,
"editability": {
"isEditable": true
}
}
},
"valueSpace": {
"type": "string",
"maxLength": 1024,
"minLength": 0
}
},
"Conference.MaxReceiveCallRate": {
"value": 6000,
"source": "default",
"sources": {
"default": {
"value": 6000,
"editability": {
"isEditable": false,
"reason": "FACTORY_DEFAULT"
}
},
"configured": {
"value": null,
"editability": {
"isEditable": true
}
}
},
"valueSpace": {
"type": "integer",
"maximum": 6000,
"minimum": 64
}
},
"Video.Output.Connector[2].Resolution": {
"value": "Auto",
"source": "default",
"sources": {
"default": {
"value": "Auto",
"editability": {
"isEditable": false,
"reason": "FACTORY_DEFAULT"
}
},
"configured": {
"value": null,
"editability": {
"isEditable": false,
"reason": "CONFIG_MANAGED_BY_DIFFERENT_AUTHORITY"
}
}
},
"valueSpace": {
"enum": [
"1920_1080_50",
"1920_1080_60",
"1920_1200_50",
"1920_1200_60",
"2560_1440_60",
"3840_2160_30",
"3840_2160_60",
"Auto"
],
"type": "string"
}
}
}
}