1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. System Configuration

Update Setting

put

/iot/api/v2/settings/{group}/{name}

Update setting by group and name.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

The following example shows how to set a single configuration parameter by submitting a PUT request on the REST resource using cURL. Note that in both the request and response, iotserver will be replaced by the name and port of your assigned IoT cloud server. For more information about cURL, see Use cURL. 

curl -X PUT -k -H 'Accept: application/json' -H 'Content-Type: application/json'
http://user:password@iotserver/iot/api/v2/settings/messaging/persistMessages
-d '{ "value" : false }'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "value":false
}

curl -X PUT 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   https://iotserver/iot/api/v2/settings/{group}/{name}




Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X PUT 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json'   
   -d '{"value":45}'
   https://iotserver/iot/api/v2/settings/messaging/maxLongPollTimeout



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top