Generate Channel Write Key

2017-10-07 11:44:10

Overview


This API call is used to generate a new write key for a channel or to reset the existing key. After calling this API, the previous write key will no longer be valid. Please note that this will cause your device to stop uploading data as the credentials will have changed.

API URL


https://webapi.ubibot.com/channels/CHANNEL_ID/api_keys?action=generate_write_key&parameters

Where CHANNEL_ID is the ID of the target channel and the parameters are as defined below.

HTTP Method


POST

URL Parameters





Name Type Required Description
account_key String Required Specify the account_key obtained from the web console panel.

Response


An HTTP code of 200 is responded for each successful data requests. The message body contains a JSON object containing the new write key for the specified channel.

Error: See the separate list of error codes for more details.

Examples


POST https://webapi.ubibot.com/channels/CHANNEL_ID/api_keys?action=generate_write_key&account_key=xxxxxx-xxxxxx-xxxxxx-xxxxx
{"
result": "success",
"server_time": "2017 - 09 - 04 T08: 59: 30 Z",
"write_key": "9 b11Xxxx5XbacbXa0e8dd53″
}