Retrieve Setting
get
/iot/api/v2/settings/{group}/{name}
Retrieve setting by group and name.
Request
Path Parameters
-
group: string
Setting group
-
name: string
Setting name
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
401 Response
Unauthorized. The request requires user authentication.
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.
Examples
The following example shows how to view a single configuration parameter by submitting a GET 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 GET -k -H "Accept: application/json" https://user:password@iotserver/iot/api/v2/settings/messaging/persistMessages
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.
{ "name":"persistMessages", "value":true, "links":[ { "rel":"canonical", "href":"http://iotserver/iot/api/v2/settings/messaging/persistMessages" }, { "rel":"self", "href":"http://iotserver/iot/api/v2/settings/messaging/persistMessages" } ] }
curl -X GET
-u <username>:<password>
-H 'Accept: 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 GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/iot/api/v2/settings/{group}/{name}
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.