Retrieve Available Settings
get
/iot/api/v2/settings
Returns settings for all setting groups.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Examples
The following example shows how to view all system configuration parameters in all groups 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
Example of Response Header
The following shows an example of the response header when the request is successful.
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.
{
"items":[
{
"name":"general",
"items":[
],
"count":0,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/general"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/general"
}
]
},
{
"name":"artifacts",
"items":[
{
"name":"uploadFileSizeMax",
"value":-1,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/artifacts/uploadFileSizeMax"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/artifacts/uploadFileSizeMax"
}
]
}
],
"count":1,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/artifacts"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/artifacts"
}
]
},
{
"name":"security",
"items":[
{
"name":"tokenExpirationPeriod",
"value":3600,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/security/tokenExpirationPeriod"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/security/tokenExpirationPeriod"
}
]
}
],
"count":1,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/security"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/security"
}
]
},
{
"name":"messaging",
"items":[
{
"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"
}
]
},
{
"name":"messageTTLPeriod",
"value":90,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/messaging/messageTTLPeriod"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/messaging/messageTTLPeriod"
}
]
}
],
"count":2,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/messaging"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/messaging"
}
]
},
{
"name":"ui",
"items":[
{
"name":"notificationTimeout",
"value":"5",
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/ui/notificationTimeout"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/ui/notificationTimeout"
}
]
},
{
"name":"dateAndTimeDisplay",
"value":"LOCAL",
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/ui/dateAndTimeDisplay"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/ui/dateAndTimeDisplay"
}
]
}
],
"count":2,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/ui"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/ui"
}
]
},
{
"name":"connectivity",
"items":[
{
"name":"inactivityTimeout",
"value":3600,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/connectivity/inactivityTimeout"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/connectivity/inactivityTimeout"
}
]
}
],
"count":1,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/connectivity"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/connectivity"
}
]
},
{
"name":"cors",
"items":[
{
"name":"allowedOrigins",
"value":"*",
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/cors/allowedOrigins"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/cors/allowedOrigins"
}
]
}
],
"count":1,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/cors"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/cors"
}
]
},
{
"items":[
{
"name":"testNameString",
"value":"Test value",
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/test/testNameString"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/test/testNameString"
}
]
},
{
"name":"testNameBoolean",
"value":false,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/test/testNameBoolean"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/test/testNameBoolean"
}
]
},
{
"name":"testNameInteger",
"value":256,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/test/testNameInteger"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/test/testNameInteger"
}
]
}
],
"count":3,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings/test"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings/test"
}
]
}
],
"count":8,
"links":[
{
"rel":"canonical",
"href":"http://iotserver/iot/api/v2/settings"
},
{
"rel":"self",
"href":"http://iotserver/iot/api/v2/settings"
}
]
}
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/iot/api/v2/settings
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
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.