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

ParameterRequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
apiKeyFriendlyNameOptionalNoneA name you give to your api key. This is included in any informational or warning emails you may received about your API key use.
resetStatsOptionalfalseWhether to reset the statistics on your API key use.

Response

ParameterDescription
successtrue | false. If false then failureReason should also be returned.
infoObject containing optional information.
  apiKeyFriendlyNameNew friendly name for your API key.