Update the device connection details and optionally run connection test.

patch

http://rest.cameramanager.com/rest/v2.4/devices/{deviceId}/connection/details

Updates the connection details of a device. If the skipValidation parameter is set to false (default) it
will run a test for manually added devices to see whether it can establish a connection with the global url.
If there is a new global host or port provided, it will run the test with the new global host/port, otherwise
it will test the current global url. If this test fails it will not update ANY connection detail provided in
the ConnectionDetailUpdate object and will throw a validation error. If the test is succesful
(when skipValidation is false) and the settings are changed correctly it will return OK.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

deviceId

integer

required

ID of the device.

Query Params

skipValidation

boolean

Defaults to false

This controls whether the endpoint should perform a test to establish a connection to the global url of the device
before updating optional connection details. This test makes the request take a lot longer to return a response.
If the test fails, the values that were changed in this request will be reverted to the values it had before the
request and it will return a validation error.

Body Params

The details of a specific device regarding setting up and establishing a connection with the device. Only manually added devices can edit these fields.

localSSL

boolean

This indicates whether the local URL is using the https protocol. If false the local url is using the http protocol.

localHost

string

Local host of the device, this is not required since devices that connect via 4g do not necesarily have this.

localPort

integer

1 to 65535

globalSSL

boolean

This indicates whether the global URL is using the https protocol. If false the global url is using the http protocol.

globalHost

string

This global address is used in two ways:

To decide if a device is located in the same network as a client by comparing the global host of the device with the global host of the client. If they are the same, the client is likely in the same network as the device.
By manually connected devices to actually connect to the device, which is why it can be altered. For pnp connected devices this field is read only.

globalPort

integer

1 to 65535

This is only present in and can only be altered for manual connected devices, since this is needed by the cloud to establish a connection to the device. This will not be returned for pnp devices, since here the device connects to the cloud.

Responses

204

Success

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

406The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

409There was a conflict while trying to perform your request. See error details for more information.

500Something went wrong in the server. Please try again.