Set information API
https://api.alert.alertinghub.co.uk/api/json/setinfo
The setinfo API allows you to specify some basic information related to your API key.
JSON sample
{
"version": "latest",
"apiKey": "abcdefghijklmnopqrstuvwxyz",
"apiKeyFriendlyName" : "MyFirstApiKey",
"resetStats" : false
}
Api parameters
| Parameter | Requirement | Default | Description |
|---|---|---|---|
| version | Mandatory | None | See API guide |
| apiKey | Mandatory | None | See API guide |
| apiKeyFriendlyName | Optional | None | A name you give to your api key. This is included in any informational or warning emails you may received about your API key use. |
| resetStats | Optional | false | Whether to reset the statistics on your API key use. |
Response
| Parameter | Description |
|---|---|
| success | true | false. If false then failureReason should also be returned. |
| info | Object containing optional information. |
| apiKeyFriendlyName | New friendly name for your API key. |
