diff --git a/docs/api_doc/butler-api.html b/docs/api_doc/butler-api.html
index 8c8c2816..92ea91e4 100644
--- a/docs/api_doc/butler-api.html
+++ b/docs/api_doc/butler-api.html
@@ -377,7 +377,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-eulNck iEaKWZ api-content"><div class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx api-info"><h1 class="sc-imWYAI sc-gmgFlS cILgPb crFmld">Butler API documentation<!-- --> <span>(<!-- -->9.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kMkxaj iQWvAY">Download</a></p><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-summary"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-description"><p>Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-eulNck iEaKWZ api-content"><div class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx api-info"><h1 class="sc-imWYAI sc-gmgFlS cILgPb crFmld">Butler API documentation<!-- --> <span>(<!-- -->9.1.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kMkxaj iQWvAY">Download</a></p><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-summary"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-description"><p>Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.
 Butler offers both a REST API and things like failed reload notifications etc.</p>
 <p>This page contains the API documentation. Full documentation is available at <a href="https://butler.ptarmiganlabs.com">https://butler.ptarmiganlabs.com</a></p>
 </div><div class="sc-eZkCL faldoo"><a href="https://github.com/ptarmiganlabs">Butler family of tools on GitHub</a></div></div></div></div><div id="/paths/~1v4~1configfile~1endpointsenabled/get" data-section-id="/paths/~1v4~1configfile~1endpointsenabled/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#/paths/~1v4~1configfile~1endpointsenabled/get" aria-label="/paths/~1v4~1configfile~1endpointsenabled/get"></a>Get an array of all enabled API endpoints.<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get an array of all enabled API endpoints, using the key names from the Butler config file.</p>
@@ -567,7 +567,7 @@
 </span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">500<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Internal error.</p>
 </span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="put" class="sc-dlWCHZ lenzxa http-verb put">put</span><span class="sc-EgOXT fVtHyw">/v4/slackpostmessage</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span>http://localhost:8081</span>/v4/slackpostmessage</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-178" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-179" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-179" aria-labelledby="react-tabs-178"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel"</span>: <span class="token string">&quot;#reload-notification&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_user"</span>: <span class="token string">&quot;Butler the Bot&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;This is a message from Qlik Sense&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emoji"</span>: <span class="token string">&quot;thumbsup&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-180" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-181" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="react-tabs-182" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-183" data-rttab="true">400</li><li class="tab-error" role="tab" id="react-tabs-184" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-185" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-181" aria-labelledby="react-tabs-180"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel"</span>: <span class="token string">&quot;#reload-notification&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_user"</span>: <span class="token string">&quot;Butler the Bot&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;This is a message from Qlik Sense&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emoji"</span>: <span class="token string">&quot;thumbsup&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-183" aria-labelledby="react-tabs-182"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-185" aria-labelledby="react-tabs-184"></div></div></div></div></div></div></div><div class="sc-dExYaf gZbfaQ"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Butler API documentation","description":"Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.\nButler offers both a REST API and things like failed reload notifications etc.\n\nThis page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com","version":"9.0.0"},"components":{"schemas":{}},"paths":{"/v4/configfile/endpointsenabled":{"get":{"summary":"Get an array of all enabled API endpoints.","description":"Get an array of all enabled API endpoints, using the key names from the Butler config file.\n\nNote: Endpoints are enabled/disabled in the Butler main configuration file.","responses":{"200":{"description":"Enabled API enpooints.","content":{"application/json":{"schema":{"description":"Enabled API enpooints.","type":"array","items":{"type":"string"}},"example":["activeUserCount","activeUsers","apiListEnbledEndpoints"]}}}}}},"/v4/base62tobase16":{"get":{"summary":"Converts strings from base62 to base16.","description":"Converts strings from base62 to base16.","parameters":[{"schema":{"type":"string"},"example":"6DMW88LpSok9Z7P7hUK0wv7bF","in":"query","name":"base62","required":true,"description":"The base62 encoded string that should be converted to base16"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base16 encoded string."}}},"example":{"base62":"6DMW88LpSok9Z7P7hUK0wv7bF","base16":"3199af08bfeeaf5d420f27ed9c01e74370077"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/base16tobase62":{"get":{"summary":"Converts strings from base16 to base62.","description":"Converts strings from base16 to base62.","parameters":[{"schema":{"type":"string"},"example":"3199af08bfeeaf5d420f27ed9c01e74370077","in":"query","name":"base16","required":true,"description":"The base16 encoded string that should be converted to base62"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base62 encoded string."}}},"example":{"base16":"3199af08bfeeaf5d420f27ed9c01e74370077","base62":"6DMW88LpSok9Z7P7hUK0wv7bF"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/butlerping":{"get":{"summary":"Tests if Butler is alive and responding","description":"Tests if Butler is alive and responding","responses":{"200":{"description":"Butler is alive and well.","content":{"application/json":{"schema":{"description":"Butler is alive and well.","type":"object","properties":{"response":{"type":"string","example":"Butler reporting for duty"},"butlerVersion":{"type":"string","example":"5.5.0"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filecopy":{"put":{"summary":"Copy file(s) between well defined, approved locations.","description":"Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File copied.","content":{"application/json":{"schema":{"description":"File copied.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filemove":{"put":{"summary":"Move file(s) between well defined, approved locations.","description":"Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File moved.","content":{"application/json":{"schema":{"description":"File moved.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy.","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filedelete":{"delete":{"summary":"Delete file(s) in well defined, approved locations.","description":"It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleteFile":{"type":"string","description":"Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.","examples":["data/qvdstore/sales/file1.qvd"]}}}}}},"responses":{"204":{"description":"File deleted.","content":{"application/json":{"schema":{"description":"File deleted.","type":"object"}}}},"400":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved directory matches the delete request.","content":{"application/json":{"schema":{"description":"No approved directory matches the delete request.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdirqvd":{"post":{"summary":"Creates a directory in designated QVD directory.","description":"Creates a directory in QVD directory (which is defined in Butler's config file).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Directory that should be created.","examples":["subfolder/2020-10"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["subfolder/2020-10"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdir":{"post":{"summary":"Creates a directory anywhere in the file system.","description":"If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Path to directory that should be created. Can be a relative or absolute path.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error (file system permissions etc).","content":{"application/json":{"schema":{"description":"Internal error (file system permissions etc).","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvaluesnamespaces":{"get":{"summary":"List all currently defined namespaces.","responses":{"200":{"description":"Array of all namespaces.","content":{"application/json":{"schema":{"description":"Array of all namespaces.","type":"array","items":{"type":"string"}},"example":["Weekly sales app","Sales ETL step 1","Sales ETL step 2"]}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}":{"get":{"summary":"Get the value associated with a key, in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key and it's associated value and metadata returned.","content":{"application/json":{"schema":{"description":"Key and it's associated value and metadata returned.","type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Create a new key-value pair in the specified namespace.","description":"If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Key to use","examples":["ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"]},"value":{"type":"string","description":"Value to set","examples":["12345.789"]},"ttl":{"type":"number","description":"Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted","examples":[10000]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"201":{"description":"Key successfully set.","content":{"application/json":{"schema":{"description":"Key successfully set.","type":"object","properties":{"namespace":{"type":"string","description":"Name of namespace.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]},"ttl":{"type":"number","description":"Time-to-live for the key-value pair. 0 if no ttl was set, otherwise in milliseconds.","examples":[60000]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a namespace and all key-value pairs in it.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"204":{"description":"Namespace successfully deleted.","content":{"application/json":{"schema":{"description":"Namespace successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/keyexists":{"get":{"summary":"Checks if a key exists in a namespace.","description":"Returns true if the specified key exists, otherwise false.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key exist/no-exist returned, together with the data if the does exist.","content":{"application/json":{"schema":{"description":"Key exist/no-exist returned, together with the data if the does exist.","type":"object","properties":{"keyExists":{"type":"boolean","description":"true/false flag indicating whether the specified key exists in the given namespace."},"keyValue":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/{key}":{"delete":{"summary":"Delete a key-value pair in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."},{"schema":{"type":"string"},"example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1","in":"path","name":"key","required":true,"description":"Key to use"}],"responses":{"204":{"description":"Key-value pair successfully deleted.","content":{"application/json":{"schema":{"description":"Key-value pair successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keylist/{namespace}":{"get":{"summary":"Retrieve a list of all keys present in the specified namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace whose keys should be returned."}],"responses":{"200":{"description":"Object containing namespace name + list of allkeys in the namespace.","content":{"application/json":{"schema":{"description":"Object containing namespace name + list of allkeys in the namespace.","type":"object","properties":{"namespace":{"type":"string","description":"","examples":["Sales ETL step 2"]},"keys":{"type":"array","items":{"type":"object","key":{"type":"string"}},"examples":[[{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2"}]]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/mqttpublishmessage":{"put":{"summary":"Publish a message to a MQTT topic.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Topic to which message should be published.","examples":["qliksense/new_data_notification/sales"]},"message":{"type":"string","description":"The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.","examples":["dt=20201028"]}},"required":["topic","message"]}}},"required":true},"responses":{"201":{"description":"MQTT message successfully published.","content":{"application/json":{"schema":{"description":"MQTT message successfully published.","type":"object","properties":{"topic":{"type":"string","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","example":"dt=20201028"}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/event":{"post":{"summary":"Post events to New Relic.","description":"This endpoint posts events to the New Relic event API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventType":{"type":"string","description":"Event type. Can be a combination of alphanumeric characters, _ underscores, and : colons.","examples":["relead-failed"],"maxLength":254},"timestamp":{"type":"number","description":"The event's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Events reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"attributes":{"type":"array","description":"Dimensions/attributs that will be associated with the event.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"],"maxLength":4096}}}}},"required":["eventType"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/metric":{"post":{"summary":"Post metrics to New Relic.","description":"This endpoint posts metrics to the New Relic metrics API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Metric name.","examples":["memory.heap"],"maxLength":254},"type":{"type":"string","description":"Metric type.","examples":["gauge"],"enum":["gauge"]},"value":{"type":"number","description":"Value of the metric.","examples":[2.3]},"timestamp":{"type":"number","description":"The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"interval":{"type":"number","description":"The length of the time window (millisec). Required for count and summary metric types."},"attributes":{"type":"array","description":"Dimensions that will be associated with the metric.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"]}}}}},"required":["name","type","value"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/reload":{"put":{"summary":"Do a stand-alone reload of a Qlik Sense app, without using a task.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reloadMode":{"type":"integer","description":"Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used"},"partialReload":{"type":"boolean","description":"Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.","examples":[true]},"startQSEoWTaskOnSuccess":{"type":"array","description":"Array of task IDs that should be started when the app has successfully reloaded.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]},"startQSEoWTaskOnFailure":{"type":"array","description":"Array of task IDs that should be started if the app fails reloading.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"201":{"description":"App successfully reloaded.","content":{"application/json":{"schema":{"description":"App successfully reloaded.","type":"object","properties":{"appId":{"type":"string","description":"ID of reloaded app","examples":["210832b5-6174-4572-bd19-3e61eda675ef"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senseappdump/{appId}":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/app/:appId/dump`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/dump":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/senseappdump/:appId`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senselistapps":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/apps/list`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/apps/list":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/senselistapps`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/reloadtask/{taskId}/start":{"put":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/slackpostmessage":{"put":{"summary":"Send message to Slack.","description":"Sends a basic message to Slack.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}},"required":["channel","from_user","msg"]}}},"required":true},"responses":{"201":{"description":"Message successfully sent to Slack.","content":{"application/json":{"schema":{"description":"Message successfully sent to Slack.","type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}}},"servers":[{"url":"http://localhost:8081"}],"externalDocs":{"url":"https://github.com/ptarmiganlabs","description":"Butler family of tools on GitHub"}}},"searchIndex":{"store":["/paths/~1v4~1configfile~1endpointsenabled/get","/paths/~1v4~1base62tobase16/get","/paths/~1v4~1base16tobase62/get","/paths/~1v4~1butlerping/get","/paths/~1v4~1filecopy/put","/paths/~1v4~1filemove/put","/paths/~1v4~1filedelete/delete","/paths/~1v4~1createdirqvd/post","/paths/~1v4~1createdir/post","/paths/~1v4~1keyvaluesnamespaces/get","/paths/~1v4~1keyvalues~1{namespace}/get","/paths/~1v4~1keyvalues~1{namespace}/post","/paths/~1v4~1keyvalues~1{namespace}/delete","/paths/~1v4~1keyvalues~1{namespace}~1keyexists/get","/paths/~1v4~1keyvalues~1{namespace}~1{key}/delete","/paths/~1v4~1keylist~1{namespace}/get","/paths/~1v4~1mqttpublishmessage/put","/paths/~1v4~1newrelic~1event/post","/paths/~1v4~1newrelic~1metric/post","/paths/~1v4~1app~1{appId}~1reload/put","/paths/~1v4~1senseappdump~1{appId}/get","/paths/~1v4~1app~1{appId}~1dump/get","/paths/~1v4~1senselistapps/get","/paths/~1v4~1apps~1list/get","/paths/~1v4~1reloadtask~1{taskId}~1start/put","/paths/~1v4~1reloadtask~1{taskId}~1start/post","/paths/~1v4~1slackpostmessage/put"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.947,1,1.947,2,1.947,3,1.947]],["description/0",[0,1.588,1,1.588,2,1.588,3,2.277,4,1.588,5,1.269,6,2.543,7,2.027,8,1.414,9,1.819,10,2.543,11,2.543,12,2.543,13,2.543,14,2.543]],["title/1",[15,1.947,16,1.947,17,1.947,18,1.947]],["description/1",[15,2.449,16,2.449,17,2.449,18,2.449,19,3.921]],["title/2",[15,1.947,16,1.947,17,1.947,18,1.947]],["description/2",[15,2.449,16,2.449,17,2.449,18,2.449,20,3.921]],["title/3",[7,1.734,21,2.573,22,2.573,23,2.573]],["description/3",[7,2.18,21,3.236,22,3.236,23,3.236,24,3.921]],["title/4",[25,2.014,26,1.733,27,1.524,28,1.733,29,0.994,30,1.217,31,1.733]],["description/4",[8,1.308,9,1.719,25,2.844,27,1.469,29,0.958,30,1.174,32,1.942,33,1.671,34,1.835,35,2.844,36,1.942,37,1.671,38,1.174,39,1.942,40,1.671,41,2.352]],["title/5",[26,1.733,27,1.524,28,1.733,29,0.994,30,1.217,31,1.733,42,2.014]],["description/5",[8,1.308,9,1.719,27,1.469,29,0.958,30,1.174,32,1.942,33,1.671,34,1.835,35,2.844,36,1.942,37,1.671,38,1.174,39,1.942,40,1.671,42,2.844,43,2.352]],["title/6",[26,1.869,28,1.869,29,1.071,30,1.312,31,1.869,44,1.643]],["description/6",[8,1.539,9,1.932,29,1.127,30,1.381,33,1.966,34,1.742,37,1.966,38,1.381,40,1.966,44,1.729,45,1.966,46,2.767,47,2.767]],["title/7",[34,1.78,48,1.587,49,2.853,50,2.355]],["description/7",[8,1.869,9,1.677,29,1.369,34,1.988,38,1.677,48,1.869,50,2.774,51,3.36]],["title/8",[9,1.424,34,1.284,48,1.587,52,2.853,53,2.853]],["description/8",[34,1.742,48,1.539,54,2.284,55,1.729,56,2.767,57,2.767,58,2.767,59,2.767,60,2.767,61,2.767,62,2.767,63,2.767,64,2.284,65,2.767]],["title/9",[29,1.27,66,1.947,67,2.215,68,1.403]],["description/9",[69,4.705]],["title/10",[5,1.424,68,1.284,70,2.027,71,2.853,72,2.355]],["description/10",[73,3.343]],["title/11",[48,1.463,68,1.184,74,1.184,75,1.463,76,1.463,77,1.643]],["description/11",[5,1.719,54,1.942,55,1.469,73,1.671,77,1.469,78,2.352,79,2.267,80,2.352,81,2.897,82,1.308,83,2.352,84,2.352,85,1.671,86,2.352,87,2.352,88,2.352]],["title/12",[44,1.947,68,1.403,75,1.734,76,1.734]],["description/12",[73,3.343]],["title/13",[5,1.556,55,1.947,68,1.403,89,3.118]],["description/13",[5,1.739,55,2.177,64,2.877,77,2.177,90,3.485,91,3.485,92,3.485,93,3.485]],["title/14",[44,1.782,68,1.284,72,2.355,75,1.587,76,1.587]],["description/14",[94,4.705]],["title/15",[5,1.312,66,1.643,68,1.184,77,1.643,95,2.63,96,2.63]],["description/15",[97,4.705]],["title/16",[98,3.118,99,1.734,100,3.118,101,3.118]],["description/16",[102,4.705]],["title/17",[74,1.403,79,1.734,103,2.573,104,1.947]],["description/17",[2,2.177,3,2.177,74,1.569,79,1.938,103,3.733,104,2.177,105,3.485]],["title/18",[74,1.403,79,1.734,104,1.947,106,2.573]],["description/18",[2,2.177,3,2.177,74,1.569,79,1.938,104,2.177,106,3.733,107,3.485]],["title/19",[4,1.421,108,2.275,109,1.616,110,1.616,111,1.024,112,1.265,113,2.275,114,1.265]],["description/19",[115,4.705]],["title/20",[111,1.403,112,1.734,116,2.573,117,2.573]],["description/20",[118,2.556,119,2.556,120,4.091,121,4.091]],["title/21",[111,1.403,112,1.734,116,2.573,117,2.573]],["description/21",[118,2.556,119,2.556,122,4.091,123,4.091]],["title/22",[66,1.947,111,1.403,112,1.734,124,2.573]],["description/22",[118,2.556,119,2.556,125,3.377,126,3.377]],["title/23",[66,1.947,111,1.403,112,1.734,124,2.573]],["description/23",[118,2.556,119,2.556,125,3.377,126,3.377]],["title/24",[82,1.734,110,2.215,111,1.403,114,1.734]],["description/24",[0,0.999,1,0.57,4,0.999,7,0.508,38,0.798,45,0.649,67,0.649,70,0.649,74,0.411,75,1.187,76,0.89,81,0.649,82,0.89,85,0.649,99,0.508,109,0.649,114,1.62,127,0.754,128,0.754,129,0.754,130,0.754,131,1.762,132,0.754,133,0.754,134,0.754,135,0.754,136,0.754,137,0.754,138,2.405,139,1.762,140,1.321,141,0.754,142,1.321,143,0.754,144,0.754,145,1.762,146,0.754,147,0.754,148,0.754,149,0.754,150,1.762,151,0.754,152,0.754,153,1.321,154,0.754,155,0.754,156,0.754,157,0.754,158,0.754,159,0.754,160,0.754,161,0.754,162,0.754,163,0.754,164,0.754,165,0.754,166,0.754,167,0.754]],["title/25",[82,1.734,110,2.215,111,1.403,114,1.734]],["description/25",[0,0.999,1,0.57,4,0.999,7,0.508,38,0.798,45,0.649,67,0.649,70,0.649,74,0.411,75,1.187,76,0.89,81,0.649,82,0.89,85,0.649,99,0.508,109,0.649,114,1.62,127,0.754,128,0.754,129,0.754,130,0.754,131,1.762,132,0.754,133,0.754,134,0.754,135,0.754,136,0.754,137,0.754,138,2.405,139,1.762,140,1.321,141,0.754,142,1.321,143,0.754,144,0.754,145,1.762,146,0.754,147,0.754,148,0.754,149,0.754,150,1.762,151,0.754,152,0.754,153,1.321,154,0.754,155,0.754,156,0.754,157,0.754,158,0.754,159,0.754,160,0.754,161,0.754,162,0.754,163,0.754,164,0.754,165,0.754,166,0.754,167,0.754]],["title/26",[99,1.911,168,2.836,169,2.836]],["description/26",[99,2.18,168,3.236,169,3.236,170,3.921,171,3.921]]],"invertedIndex":[["",{"_index":138,"title":{},"description":{"24":{},"25":{}}}],["add",{"_index":163,"title":{},"description":{"24":{},"25":{}}}],["addit",{"_index":133,"title":{},"description":{"24":{},"25":{}}}],["aliv",{"_index":22,"title":{"3":{}},"description":{"3":{}}}],["allow",{"_index":60,"title":{},"description":{"8":{}}}],["alreadi",{"_index":54,"title":{},"description":{"8":{},"11":{}}}],["anywher",{"_index":52,"title":{"8":{}},"description":{}}],["api",{"_index":2,"title":{"0":{}},"description":{"0":{},"17":{},"18":{}}}],["app",{"_index":112,"title":{"19":{},"20":{},"21":{},"22":{},"23":{}},"description":{}}],["approv",{"_index":30,"title":{"4":{},"5":{},"6":{}},"description":{"4":{},"5":{},"6":{}}}],["array",{"_index":0,"title":{"0":{}},"description":{"0":{},"24":{},"25":{}}}],["associ",{"_index":71,"title":{"10":{}},"description":{}}],["base16",{"_index":18,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["base62",{"_index":17,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["basic",{"_index":170,"title":{},"description":{"26":{}}}],["be",{"_index":136,"title":{},"description":{"24":{},"25":{}}}],["between",{"_index":27,"title":{"4":{},"5":{}},"description":{"4":{},"5":{}}}],["bodi",{"_index":132,"title":{},"description":{"24":{},"25":{}}}],["butler",{"_index":7,"title":{"3":{}},"description":{"0":{},"3":{},"24":{},"25":{}}}],["butler'",{"_index":38,"title":{},"description":{"4":{},"5":{},"6":{},"7":{},"24":{},"25":{}}}],["check",{"_index":89,"title":{"13":{}},"description":{}}],["config",{"_index":8,"title":{},"description":{"0":{},"4":{},"5":{},"6":{},"7":{}}}],["configur",{"_index":13,"title":{},"description":{"0":{}}}],["contain",{"_index":39,"title":{},"description":{"4":{},"5":{}}}],["convert",{"_index":15,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["copi",{"_index":25,"title":{"4":{}},"description":{"4":{}}}],["count",{"_index":83,"title":{},"description":{"11":{}}}],["creat",{"_index":48,"title":{"7":{},"8":{},"11":{}},"description":{"7":{},"8":{}}}],["current",{"_index":67,"title":{"9":{}},"description":{"24":{},"25":{}}}],["custom",{"_index":154,"title":{},"description":{"24":{},"25":{}}}],["data",{"_index":80,"title":{},"description":{"11":{}}}],["defin",{"_index":29,"title":{"4":{},"5":{},"6":{},"9":{}},"description":{"4":{},"5":{},"6":{},"7":{}}}],["delet",{"_index":44,"title":{"6":{},"12":{},"14":{}},"description":{"6":{}}}],["design",{"_index":49,"title":{"7":{}},"description":{}}],["destin",{"_index":36,"title":{},"description":{"4":{},"5":{}}}],["directori",{"_index":34,"title":{"7":{},"8":{}},"description":{"4":{},"5":{},"6":{},"7":{},"8":{}}}],["disabl",{"_index":147,"title":{},"description":{"24":{},"25":{}}}],["don't",{"_index":59,"title":{},"description":{"8":{}}}],["done",{"_index":37,"title":{},"description":{"4":{},"5":{},"6":{}}}],["dump",{"_index":116,"title":{"20":{},"21":{}},"description":{}}],["enabl",{"_index":1,"title":{"0":{}},"description":{"0":{},"24":{},"25":{}}}],["enabled/dis",{"_index":11,"title":{},"description":{"0":{}}}],["endpoint",{"_index":3,"title":{"0":{}},"description":{"0":{},"17":{},"18":{}}}],["environ",{"_index":124,"title":{"22":{},"23":{}},"description":{}}],["error",{"_index":63,"title":{},"description":{"8":{}}}],["event",{"_index":103,"title":{"17":{}},"description":{"17":{}}}],["exist",{"_index":55,"title":{"13":{}},"description":{"8":{},"11":{},"13":{}}}],["expir",{"_index":149,"title":{},"description":{"24":{},"25":{}}}],["fals",{"_index":92,"title":{},"description":{"13":{}}}],["featur",{"_index":148,"title":{},"description":{"24":{},"25":{}}}],["file",{"_index":9,"title":{"8":{}},"description":{"0":{},"4":{},"5":{},"6":{},"7":{}}}],["file(",{"_index":26,"title":{"4":{},"5":{},"6":{}},"description":{}}],["format",{"_index":158,"title":{},"description":{"24":{},"25":{}}}],["futur",{"_index":165,"title":{},"description":{"24":{},"25":{}}}],["gener",{"_index":156,"title":{},"description":{"24":{},"25":{}}}],["happen",{"_index":57,"title":{},"description":{"8":{}}}],["i.",{"_index":85,"title":{},"description":{"11":{},"24":{},"25":{}}}],["identifi",{"_index":150,"title":{},"description":{"24":{},"25":{}}}],["ignor",{"_index":144,"title":{},"description":{"24":{},"25":{}}}],["info",{"_index":134,"title":{},"description":{"24":{},"25":{}}}],["inform",{"_index":141,"title":{},"description":{"24":{},"25":{}}}],["integr",{"_index":164,"title":{},"description":{"24":{},"25":{}}}],["invalid",{"_index":62,"title":{},"description":{"8":{}}}],["it'",{"_index":161,"title":{},"description":{"24":{},"25":{}}}],["json",{"_index":117,"title":{"20":{},"21":{}},"description":{}}],["json/object",{"_index":157,"title":{},"description":{"24":{},"25":{}}}],["key",{"_index":5,"title":{"10":{},"13":{},"15":{}},"description":{"0":{},"11":{},"13":{}}}],["key-valu",{"_index":75,"title":{"11":{},"12":{},"14":{}},"description":{"24":{},"25":{}}}],["kv",{"_index":140,"title":{},"description":{"24":{},"25":{}}}],["list",{"_index":66,"title":{"9":{},"15":{},"22":{},"23":{}},"description":{}}],["locat",{"_index":31,"title":{"4":{},"5":{},"6":{}},"description":{}}],["main",{"_index":12,"title":{},"description":{"0":{}}}],["messag",{"_index":99,"title":{"16":{},"26":{}},"description":{"24":{},"25":{},"26":{}}}],["metric",{"_index":106,"title":{"18":{}},"description":{"18":{}}}],["more",{"_index":129,"title":{},"description":{"24":{},"25":{}}}],["move",{"_index":42,"title":{"5":{}},"description":{"5":{}}}],["mqtt",{"_index":100,"title":{"16":{}},"description":{}}],["name",{"_index":6,"title":{},"description":{"0":{}}}],["namespac",{"_index":68,"title":{"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{}},"description":{}}],["new",{"_index":74,"title":{"11":{},"17":{},"18":{}},"description":{"17":{},"18":{},"24":{},"25":{}}}],["note",{"_index":10,"title":{},"description":{"0":{}}}],["noth",{"_index":56,"title":{},"description":{"8":{}}}],["object",{"_index":130,"title":{},"description":{"24":{},"25":{}}}],["occur",{"_index":84,"title":{},"description":{"11":{}}}],["option",{"_index":127,"title":{},"description":{"24":{},"25":{}}}],["otherwis",{"_index":91,"title":{},"description":{"13":{}}}],["overwritten",{"_index":78,"title":{},"description":{"11":{}}}],["pair",{"_index":76,"title":{"11":{},"12":{},"14":{}},"description":{"24":{},"25":{}}}],["paramet",{"_index":142,"title":{},"description":{"24":{},"25":{}}}],["pass",{"_index":131,"title":{},"description":{"24":{},"25":{}}}],["path",{"_index":61,"title":{},"description":{"8":{}}}],["payload",{"_index":160,"title":{},"description":{"24":{},"25":{}}}],["permiss",{"_index":58,"title":{},"description":{"8":{}}}],["possibl",{"_index":45,"title":{},"description":{"6":{},"24":{},"25":{}}}],["post",{"_index":79,"title":{"17":{},"18":{}},"description":{"11":{},"17":{},"18":{}}}],["posttibl",{"_index":32,"title":{},"description":{"4":{},"5":{}}}],["pre-approv",{"_index":33,"title":{},"description":{"4":{},"5":{},"6":{}}}],["present",{"_index":96,"title":{"15":{}},"description":{}}],["previouli",{"_index":86,"title":{},"description":{"11":{}}}],["properti",{"_index":155,"title":{},"description":{"24":{},"25":{}}}],["publish",{"_index":98,"title":{"16":{}},"description":{}}],["qlik",{"_index":110,"title":{"19":{},"24":{},"25":{}},"description":{}}],["qmc",{"_index":153,"title":{},"description":{"24":{},"25":{}}}],["qvd",{"_index":50,"title":{"7":{}},"description":{"7":{}}}],["recent",{"_index":88,"title":{},"description":{"11":{}}}],["relat",{"_index":135,"title":{},"description":{"24":{},"25":{}}}],["relic",{"_index":104,"title":{"17":{},"18":{}},"description":{"17":{},"18":{}}}],["reload",{"_index":109,"title":{"19":{}},"description":{"24":{},"25":{}}}],["replac",{"_index":87,"title":{},"description":{"11":{}}}],["respond",{"_index":23,"title":{"3":{}},"description":{"3":{}}}],["retriev",{"_index":95,"title":{"15":{}},"description":{}}],["return",{"_index":64,"title":{},"description":{"8":{},"13":{}}}],["same",{"_index":118,"title":{},"description":{"20":{},"21":{},"22":{},"23":{}}}],["send",{"_index":168,"title":{"26":{}},"description":{"26":{}}}],["sens",{"_index":111,"title":{"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{}},"description":{}}],["set",{"_index":145,"title":{},"description":{"24":{},"25":{}}}],["simpli",{"_index":143,"title":{},"description":{"24":{},"25":{}}}],["slack",{"_index":169,"title":{"26":{}},"description":{"26":{}}}],["sourc",{"_index":35,"title":{},"description":{"4":{},"5":{}}}],["specif",{"_index":72,"title":{"10":{},"14":{}},"description":{}}],["specifi",{"_index":77,"title":{"11":{},"15":{}},"description":{"11":{},"13":{}}}],["stand-alon",{"_index":108,"title":{"19":{}},"description":{}}],["start",{"_index":82,"title":{"24":{},"25":{}},"description":{"11":{},"24":{},"25":{}}}],["store",{"_index":139,"title":{},"description":{"24":{},"25":{}}}],["string",{"_index":16,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["subdirectori",{"_index":40,"title":{},"description":{"4":{},"5":{},"6":{}}}],["support",{"_index":137,"title":{},"description":{"24":{},"25":{}}}],["system",{"_index":53,"title":{"8":{}},"description":{}}],["tag",{"_index":152,"title":{},"description":{"24":{},"25":{}}}],["task",{"_index":114,"title":{"19":{},"24":{},"25":{}},"description":{"24":{},"25":{}}}],["taskid",{"_index":151,"title":{},"description":{"24":{},"25":{}}}],["test",{"_index":21,"title":{"3":{}},"description":{"3":{}}}],["thereof",{"_index":46,"title":{},"description":{"6":{}}}],["thing",{"_index":119,"title":{},"description":{"20":{},"21":{},"22":{},"23":{}}}],["thu",{"_index":162,"title":{},"description":{"24":{},"25":{}}}],["topic",{"_index":101,"title":{"16":{}},"description":{}}],["true",{"_index":90,"title":{},"description":{"13":{}}}],["ttl",{"_index":81,"title":{},"description":{"11":{},"24":{},"25":{}}}],["ttl=0",{"_index":146,"title":{},"description":{"24":{},"25":{}}}],["type",{"_index":159,"title":{},"description":{"24":{},"25":{}}}],["us",{"_index":4,"title":{"19":{}},"description":{"0":{},"24":{},"25":{}}}],["v4/app/:appid/dump",{"_index":120,"title":{},"description":{"20":{}}}],["v4/app/{appid}/dump",{"_index":123,"title":{},"description":{"21":{}}}],["v4/app/{appid}/reload",{"_index":115,"title":{},"description":{"19":{}}}],["v4/apps/list",{"_index":125,"title":{},"description":{"22":{},"23":{}}}],["v4/base16tobase62",{"_index":20,"title":{},"description":{"2":{}}}],["v4/base62tobase16",{"_index":19,"title":{},"description":{"1":{}}}],["v4/butlerp",{"_index":24,"title":{},"description":{"3":{}}}],["v4/configfile/endpointsen",{"_index":14,"title":{},"description":{"0":{}}}],["v4/createdir",{"_index":65,"title":{},"description":{"8":{}}}],["v4/createdirqvd",{"_index":51,"title":{},"description":{"7":{}}}],["v4/filecopi",{"_index":41,"title":{},"description":{"4":{}}}],["v4/filedelet",{"_index":47,"title":{},"description":{"6":{}}}],["v4/filemov",{"_index":43,"title":{},"description":{"5":{}}}],["v4/keylist/{namespac",{"_index":97,"title":{},"description":{"15":{}}}],["v4/keyvalues/{namespac",{"_index":73,"title":{},"description":{"10":{},"11":{},"12":{}}}],["v4/keyvalues/{namespace}/keyexist",{"_index":93,"title":{},"description":{"13":{}}}],["v4/keyvalues/{namespace}/{key",{"_index":94,"title":{},"description":{"14":{}}}],["v4/keyvaluesnamespac",{"_index":69,"title":{},"description":{"9":{}}}],["v4/mqttpublishmessag",{"_index":102,"title":{},"description":{"16":{}}}],["v4/newrelic/ev",{"_index":105,"title":{},"description":{"17":{}}}],["v4/newrelic/metr",{"_index":107,"title":{},"description":{"18":{}}}],["v4/reloadtask/{taskid}/start",{"_index":167,"title":{},"description":{"24":{},"25":{}}}],["v4/senseappdump/:appid",{"_index":122,"title":{},"description":{"21":{}}}],["v4/senseappdump/{appid",{"_index":121,"title":{},"description":{"20":{}}}],["v4/senselistapp",{"_index":126,"title":{},"description":{"22":{},"23":{}}}],["v4/slackpostmessag",{"_index":171,"title":{},"description":{"26":{}}}],["valu",{"_index":70,"title":{"10":{}},"description":{"24":{},"25":{}}}],["version",{"_index":166,"title":{},"description":{"24":{},"25":{}}}],["well",{"_index":28,"title":{"4":{},"5":{},"6":{}},"description":{}}],["without",{"_index":113,"title":{"19":{}},"description":{}}],["zero",{"_index":128,"title":{},"description":{"24":{},"25":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Butler API documentation","description":"Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.\nButler offers both a REST API and things like failed reload notifications etc.\n\nThis page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com","version":"9.1.0"},"components":{"schemas":{}},"paths":{"/v4/configfile/endpointsenabled":{"get":{"summary":"Get an array of all enabled API endpoints.","description":"Get an array of all enabled API endpoints, using the key names from the Butler config file.\n\nNote: Endpoints are enabled/disabled in the Butler main configuration file.","responses":{"200":{"description":"Enabled API enpooints.","content":{"application/json":{"schema":{"description":"Enabled API enpooints.","type":"array","items":{"type":"string"}},"example":["activeUserCount","activeUsers","apiListEnbledEndpoints"]}}}}}},"/v4/base62tobase16":{"get":{"summary":"Converts strings from base62 to base16.","description":"Converts strings from base62 to base16.","parameters":[{"schema":{"type":"string"},"example":"6DMW88LpSok9Z7P7hUK0wv7bF","in":"query","name":"base62","required":true,"description":"The base62 encoded string that should be converted to base16"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base16 encoded string."}}},"example":{"base62":"6DMW88LpSok9Z7P7hUK0wv7bF","base16":"3199af08bfeeaf5d420f27ed9c01e74370077"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/base16tobase62":{"get":{"summary":"Converts strings from base16 to base62.","description":"Converts strings from base16 to base62.","parameters":[{"schema":{"type":"string"},"example":"3199af08bfeeaf5d420f27ed9c01e74370077","in":"query","name":"base16","required":true,"description":"The base16 encoded string that should be converted to base62"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base62 encoded string."}}},"example":{"base16":"3199af08bfeeaf5d420f27ed9c01e74370077","base62":"6DMW88LpSok9Z7P7hUK0wv7bF"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/butlerping":{"get":{"summary":"Tests if Butler is alive and responding","description":"Tests if Butler is alive and responding","responses":{"200":{"description":"Butler is alive and well.","content":{"application/json":{"schema":{"description":"Butler is alive and well.","type":"object","properties":{"response":{"type":"string","example":"Butler reporting for duty"},"butlerVersion":{"type":"string","example":"5.5.0"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filecopy":{"put":{"summary":"Copy file(s) between well defined, approved locations.","description":"Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File copied.","content":{"application/json":{"schema":{"description":"File copied.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filemove":{"put":{"summary":"Move file(s) between well defined, approved locations.","description":"Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File moved.","content":{"application/json":{"schema":{"description":"File moved.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy.","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filedelete":{"delete":{"summary":"Delete file(s) in well defined, approved locations.","description":"It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleteFile":{"type":"string","description":"Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.","examples":["data/qvdstore/sales/file1.qvd"]}}}}}},"responses":{"204":{"description":"File deleted.","content":{"application/json":{"schema":{"description":"File deleted.","type":"object"}}}},"400":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved directory matches the delete request.","content":{"application/json":{"schema":{"description":"No approved directory matches the delete request.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdirqvd":{"post":{"summary":"Creates a directory in designated QVD directory.","description":"Creates a directory in QVD directory (which is defined in Butler's config file).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Directory that should be created.","examples":["subfolder/2020-10"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["subfolder/2020-10"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdir":{"post":{"summary":"Creates a directory anywhere in the file system.","description":"If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Path to directory that should be created. Can be a relative or absolute path.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error (file system permissions etc).","content":{"application/json":{"schema":{"description":"Internal error (file system permissions etc).","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvaluesnamespaces":{"get":{"summary":"List all currently defined namespaces.","responses":{"200":{"description":"Array of all namespaces.","content":{"application/json":{"schema":{"description":"Array of all namespaces.","type":"array","items":{"type":"string"}},"example":["Weekly sales app","Sales ETL step 1","Sales ETL step 2"]}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}":{"get":{"summary":"Get the value associated with a key, in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key and it's associated value and metadata returned.","content":{"application/json":{"schema":{"description":"Key and it's associated value and metadata returned.","type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Create a new key-value pair in the specified namespace.","description":"If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Key to use","examples":["ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"]},"value":{"type":"string","description":"Value to set","examples":["12345.789"]},"ttl":{"type":"number","description":"Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted","examples":[10000]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"201":{"description":"Key successfully set.","content":{"application/json":{"schema":{"description":"Key successfully set.","type":"object","properties":{"namespace":{"type":"string","description":"Name of namespace.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]},"ttl":{"type":"number","description":"Time-to-live for the key-value pair. 0 if no ttl was set, otherwise in milliseconds.","examples":[60000]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a namespace and all key-value pairs in it.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"204":{"description":"Namespace successfully deleted.","content":{"application/json":{"schema":{"description":"Namespace successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/keyexists":{"get":{"summary":"Checks if a key exists in a namespace.","description":"Returns true if the specified key exists, otherwise false.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key exist/no-exist returned, together with the data if the does exist.","content":{"application/json":{"schema":{"description":"Key exist/no-exist returned, together with the data if the does exist.","type":"object","properties":{"keyExists":{"type":"boolean","description":"true/false flag indicating whether the specified key exists in the given namespace."},"keyValue":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/{key}":{"delete":{"summary":"Delete a key-value pair in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."},{"schema":{"type":"string"},"example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1","in":"path","name":"key","required":true,"description":"Key to use"}],"responses":{"204":{"description":"Key-value pair successfully deleted.","content":{"application/json":{"schema":{"description":"Key-value pair successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keylist/{namespace}":{"get":{"summary":"Retrieve a list of all keys present in the specified namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace whose keys should be returned."}],"responses":{"200":{"description":"Object containing namespace name + list of allkeys in the namespace.","content":{"application/json":{"schema":{"description":"Object containing namespace name + list of allkeys in the namespace.","type":"object","properties":{"namespace":{"type":"string","description":"","examples":["Sales ETL step 2"]},"keys":{"type":"array","items":{"type":"object","key":{"type":"string"}},"examples":[[{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2"}]]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/mqttpublishmessage":{"put":{"summary":"Publish a message to a MQTT topic.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Topic to which message should be published.","examples":["qliksense/new_data_notification/sales"]},"message":{"type":"string","description":"The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.","examples":["dt=20201028"]}},"required":["topic","message"]}}},"required":true},"responses":{"201":{"description":"MQTT message successfully published.","content":{"application/json":{"schema":{"description":"MQTT message successfully published.","type":"object","properties":{"topic":{"type":"string","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","example":"dt=20201028"}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/event":{"post":{"summary":"Post events to New Relic.","description":"This endpoint posts events to the New Relic event API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventType":{"type":"string","description":"Event type. Can be a combination of alphanumeric characters, _ underscores, and : colons.","examples":["relead-failed"],"maxLength":254},"timestamp":{"type":"number","description":"The event's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Events reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"attributes":{"type":"array","description":"Dimensions/attributs that will be associated with the event.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"],"maxLength":4096}}}}},"required":["eventType"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/metric":{"post":{"summary":"Post metrics to New Relic.","description":"This endpoint posts metrics to the New Relic metrics API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Metric name.","examples":["memory.heap"],"maxLength":254},"type":{"type":"string","description":"Metric type.","examples":["gauge"],"enum":["gauge"]},"value":{"type":"number","description":"Value of the metric.","examples":[2.3]},"timestamp":{"type":"number","description":"The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"interval":{"type":"number","description":"The length of the time window (millisec). Required for count and summary metric types."},"attributes":{"type":"array","description":"Dimensions that will be associated with the metric.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"]}}}}},"required":["name","type","value"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/reload":{"put":{"summary":"Do a stand-alone reload of a Qlik Sense app, without using a task.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reloadMode":{"type":"integer","description":"Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used"},"partialReload":{"type":"boolean","description":"Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.","examples":[true]},"startQSEoWTaskOnSuccess":{"type":"array","description":"Array of task IDs that should be started when the app has successfully reloaded.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]},"startQSEoWTaskOnFailure":{"type":"array","description":"Array of task IDs that should be started if the app fails reloading.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"201":{"description":"App successfully reloaded.","content":{"application/json":{"schema":{"description":"App successfully reloaded.","type":"object","properties":{"appId":{"type":"string","description":"ID of reloaded app","examples":["210832b5-6174-4572-bd19-3e61eda675ef"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senseappdump/{appId}":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/app/:appId/dump`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/dump":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/senseappdump/:appId`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senselistapps":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/apps/list`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/apps/list":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/senselistapps`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/reloadtask/{taskId}/start":{"put":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/slackpostmessage":{"put":{"summary":"Send message to Slack.","description":"Sends a basic message to Slack.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}},"required":["channel","from_user","msg"]}}},"required":true},"responses":{"201":{"description":"Message successfully sent to Slack.","content":{"application/json":{"schema":{"description":"Message successfully sent to Slack.","type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}}},"servers":[{"url":"http://localhost:8081"}],"externalDocs":{"url":"https://github.com/ptarmiganlabs","description":"Butler family of tools on GitHub"}}},"searchIndex":{"store":["/paths/~1v4~1configfile~1endpointsenabled/get","/paths/~1v4~1base62tobase16/get","/paths/~1v4~1base16tobase62/get","/paths/~1v4~1butlerping/get","/paths/~1v4~1filecopy/put","/paths/~1v4~1filemove/put","/paths/~1v4~1filedelete/delete","/paths/~1v4~1createdirqvd/post","/paths/~1v4~1createdir/post","/paths/~1v4~1keyvaluesnamespaces/get","/paths/~1v4~1keyvalues~1{namespace}/get","/paths/~1v4~1keyvalues~1{namespace}/post","/paths/~1v4~1keyvalues~1{namespace}/delete","/paths/~1v4~1keyvalues~1{namespace}~1keyexists/get","/paths/~1v4~1keyvalues~1{namespace}~1{key}/delete","/paths/~1v4~1keylist~1{namespace}/get","/paths/~1v4~1mqttpublishmessage/put","/paths/~1v4~1newrelic~1event/post","/paths/~1v4~1newrelic~1metric/post","/paths/~1v4~1app~1{appId}~1reload/put","/paths/~1v4~1senseappdump~1{appId}/get","/paths/~1v4~1app~1{appId}~1dump/get","/paths/~1v4~1senselistapps/get","/paths/~1v4~1apps~1list/get","/paths/~1v4~1reloadtask~1{taskId}~1start/put","/paths/~1v4~1reloadtask~1{taskId}~1start/post","/paths/~1v4~1slackpostmessage/put"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.947,1,1.947,2,1.947,3,1.947]],["description/0",[0,1.588,1,1.588,2,1.588,3,2.277,4,1.588,5,1.269,6,2.543,7,2.027,8,1.414,9,1.819,10,2.543,11,2.543,12,2.543,13,2.543,14,2.543]],["title/1",[15,1.947,16,1.947,17,1.947,18,1.947]],["description/1",[15,2.449,16,2.449,17,2.449,18,2.449,19,3.921]],["title/2",[15,1.947,16,1.947,17,1.947,18,1.947]],["description/2",[15,2.449,16,2.449,17,2.449,18,2.449,20,3.921]],["title/3",[7,1.734,21,2.573,22,2.573,23,2.573]],["description/3",[7,2.18,21,3.236,22,3.236,23,3.236,24,3.921]],["title/4",[25,2.014,26,1.733,27,1.524,28,1.733,29,0.994,30,1.217,31,1.733]],["description/4",[8,1.308,9,1.719,25,2.844,27,1.469,29,0.958,30,1.174,32,1.942,33,1.671,34,1.835,35,2.844,36,1.942,37,1.671,38,1.174,39,1.942,40,1.671,41,2.352]],["title/5",[26,1.733,27,1.524,28,1.733,29,0.994,30,1.217,31,1.733,42,2.014]],["description/5",[8,1.308,9,1.719,27,1.469,29,0.958,30,1.174,32,1.942,33,1.671,34,1.835,35,2.844,36,1.942,37,1.671,38,1.174,39,1.942,40,1.671,42,2.844,43,2.352]],["title/6",[26,1.869,28,1.869,29,1.071,30,1.312,31,1.869,44,1.643]],["description/6",[8,1.539,9,1.932,29,1.127,30,1.381,33,1.966,34,1.742,37,1.966,38,1.381,40,1.966,44,1.729,45,1.966,46,2.767,47,2.767]],["title/7",[34,1.78,48,1.587,49,2.853,50,2.355]],["description/7",[8,1.869,9,1.677,29,1.369,34,1.988,38,1.677,48,1.869,50,2.774,51,3.36]],["title/8",[9,1.424,34,1.284,48,1.587,52,2.853,53,2.853]],["description/8",[34,1.742,48,1.539,54,2.284,55,1.729,56,2.767,57,2.767,58,2.767,59,2.767,60,2.767,61,2.767,62,2.767,63,2.767,64,2.284,65,2.767]],["title/9",[29,1.27,66,1.947,67,2.215,68,1.403]],["description/9",[69,4.705]],["title/10",[5,1.424,68,1.284,70,2.027,71,2.853,72,2.355]],["description/10",[73,3.343]],["title/11",[48,1.463,68,1.184,74,1.184,75,1.463,76,1.463,77,1.643]],["description/11",[5,1.719,54,1.942,55,1.469,73,1.671,77,1.469,78,2.352,79,2.267,80,2.352,81,2.897,82,1.308,83,2.352,84,2.352,85,1.671,86,2.352,87,2.352,88,2.352]],["title/12",[44,1.947,68,1.403,75,1.734,76,1.734]],["description/12",[73,3.343]],["title/13",[5,1.556,55,1.947,68,1.403,89,3.118]],["description/13",[5,1.739,55,2.177,64,2.877,77,2.177,90,3.485,91,3.485,92,3.485,93,3.485]],["title/14",[44,1.782,68,1.284,72,2.355,75,1.587,76,1.587]],["description/14",[94,4.705]],["title/15",[5,1.312,66,1.643,68,1.184,77,1.643,95,2.63,96,2.63]],["description/15",[97,4.705]],["title/16",[98,3.118,99,1.734,100,3.118,101,3.118]],["description/16",[102,4.705]],["title/17",[74,1.403,79,1.734,103,2.573,104,1.947]],["description/17",[2,2.177,3,2.177,74,1.569,79,1.938,103,3.733,104,2.177,105,3.485]],["title/18",[74,1.403,79,1.734,104,1.947,106,2.573]],["description/18",[2,2.177,3,2.177,74,1.569,79,1.938,104,2.177,106,3.733,107,3.485]],["title/19",[4,1.421,108,2.275,109,1.616,110,1.616,111,1.024,112,1.265,113,2.275,114,1.265]],["description/19",[115,4.705]],["title/20",[111,1.403,112,1.734,116,2.573,117,2.573]],["description/20",[118,2.556,119,2.556,120,4.091,121,4.091]],["title/21",[111,1.403,112,1.734,116,2.573,117,2.573]],["description/21",[118,2.556,119,2.556,122,4.091,123,4.091]],["title/22",[66,1.947,111,1.403,112,1.734,124,2.573]],["description/22",[118,2.556,119,2.556,125,3.377,126,3.377]],["title/23",[66,1.947,111,1.403,112,1.734,124,2.573]],["description/23",[118,2.556,119,2.556,125,3.377,126,3.377]],["title/24",[82,1.734,110,2.215,111,1.403,114,1.734]],["description/24",[0,0.999,1,0.57,4,0.999,7,0.508,38,0.798,45,0.649,67,0.649,70,0.649,74,0.411,75,1.187,76,0.89,81,0.649,82,0.89,85,0.649,99,0.508,109,0.649,114,1.62,127,0.754,128,0.754,129,0.754,130,0.754,131,1.762,132,0.754,133,0.754,134,0.754,135,0.754,136,0.754,137,0.754,138,2.405,139,1.762,140,1.321,141,0.754,142,1.321,143,0.754,144,0.754,145,1.762,146,0.754,147,0.754,148,0.754,149,0.754,150,1.762,151,0.754,152,0.754,153,1.321,154,0.754,155,0.754,156,0.754,157,0.754,158,0.754,159,0.754,160,0.754,161,0.754,162,0.754,163,0.754,164,0.754,165,0.754,166,0.754,167,0.754]],["title/25",[82,1.734,110,2.215,111,1.403,114,1.734]],["description/25",[0,0.999,1,0.57,4,0.999,7,0.508,38,0.798,45,0.649,67,0.649,70,0.649,74,0.411,75,1.187,76,0.89,81,0.649,82,0.89,85,0.649,99,0.508,109,0.649,114,1.62,127,0.754,128,0.754,129,0.754,130,0.754,131,1.762,132,0.754,133,0.754,134,0.754,135,0.754,136,0.754,137,0.754,138,2.405,139,1.762,140,1.321,141,0.754,142,1.321,143,0.754,144,0.754,145,1.762,146,0.754,147,0.754,148,0.754,149,0.754,150,1.762,151,0.754,152,0.754,153,1.321,154,0.754,155,0.754,156,0.754,157,0.754,158,0.754,159,0.754,160,0.754,161,0.754,162,0.754,163,0.754,164,0.754,165,0.754,166,0.754,167,0.754]],["title/26",[99,1.911,168,2.836,169,2.836]],["description/26",[99,2.18,168,3.236,169,3.236,170,3.921,171,3.921]]],"invertedIndex":[["",{"_index":138,"title":{},"description":{"24":{},"25":{}}}],["add",{"_index":163,"title":{},"description":{"24":{},"25":{}}}],["addit",{"_index":133,"title":{},"description":{"24":{},"25":{}}}],["aliv",{"_index":22,"title":{"3":{}},"description":{"3":{}}}],["allow",{"_index":60,"title":{},"description":{"8":{}}}],["alreadi",{"_index":54,"title":{},"description":{"8":{},"11":{}}}],["anywher",{"_index":52,"title":{"8":{}},"description":{}}],["api",{"_index":2,"title":{"0":{}},"description":{"0":{},"17":{},"18":{}}}],["app",{"_index":112,"title":{"19":{},"20":{},"21":{},"22":{},"23":{}},"description":{}}],["approv",{"_index":30,"title":{"4":{},"5":{},"6":{}},"description":{"4":{},"5":{},"6":{}}}],["array",{"_index":0,"title":{"0":{}},"description":{"0":{},"24":{},"25":{}}}],["associ",{"_index":71,"title":{"10":{}},"description":{}}],["base16",{"_index":18,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["base62",{"_index":17,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["basic",{"_index":170,"title":{},"description":{"26":{}}}],["be",{"_index":136,"title":{},"description":{"24":{},"25":{}}}],["between",{"_index":27,"title":{"4":{},"5":{}},"description":{"4":{},"5":{}}}],["bodi",{"_index":132,"title":{},"description":{"24":{},"25":{}}}],["butler",{"_index":7,"title":{"3":{}},"description":{"0":{},"3":{},"24":{},"25":{}}}],["butler'",{"_index":38,"title":{},"description":{"4":{},"5":{},"6":{},"7":{},"24":{},"25":{}}}],["check",{"_index":89,"title":{"13":{}},"description":{}}],["config",{"_index":8,"title":{},"description":{"0":{},"4":{},"5":{},"6":{},"7":{}}}],["configur",{"_index":13,"title":{},"description":{"0":{}}}],["contain",{"_index":39,"title":{},"description":{"4":{},"5":{}}}],["convert",{"_index":15,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["copi",{"_index":25,"title":{"4":{}},"description":{"4":{}}}],["count",{"_index":83,"title":{},"description":{"11":{}}}],["creat",{"_index":48,"title":{"7":{},"8":{},"11":{}},"description":{"7":{},"8":{}}}],["current",{"_index":67,"title":{"9":{}},"description":{"24":{},"25":{}}}],["custom",{"_index":154,"title":{},"description":{"24":{},"25":{}}}],["data",{"_index":80,"title":{},"description":{"11":{}}}],["defin",{"_index":29,"title":{"4":{},"5":{},"6":{},"9":{}},"description":{"4":{},"5":{},"6":{},"7":{}}}],["delet",{"_index":44,"title":{"6":{},"12":{},"14":{}},"description":{"6":{}}}],["design",{"_index":49,"title":{"7":{}},"description":{}}],["destin",{"_index":36,"title":{},"description":{"4":{},"5":{}}}],["directori",{"_index":34,"title":{"7":{},"8":{}},"description":{"4":{},"5":{},"6":{},"7":{},"8":{}}}],["disabl",{"_index":147,"title":{},"description":{"24":{},"25":{}}}],["don't",{"_index":59,"title":{},"description":{"8":{}}}],["done",{"_index":37,"title":{},"description":{"4":{},"5":{},"6":{}}}],["dump",{"_index":116,"title":{"20":{},"21":{}},"description":{}}],["enabl",{"_index":1,"title":{"0":{}},"description":{"0":{},"24":{},"25":{}}}],["enabled/dis",{"_index":11,"title":{},"description":{"0":{}}}],["endpoint",{"_index":3,"title":{"0":{}},"description":{"0":{},"17":{},"18":{}}}],["environ",{"_index":124,"title":{"22":{},"23":{}},"description":{}}],["error",{"_index":63,"title":{},"description":{"8":{}}}],["event",{"_index":103,"title":{"17":{}},"description":{"17":{}}}],["exist",{"_index":55,"title":{"13":{}},"description":{"8":{},"11":{},"13":{}}}],["expir",{"_index":149,"title":{},"description":{"24":{},"25":{}}}],["fals",{"_index":92,"title":{},"description":{"13":{}}}],["featur",{"_index":148,"title":{},"description":{"24":{},"25":{}}}],["file",{"_index":9,"title":{"8":{}},"description":{"0":{},"4":{},"5":{},"6":{},"7":{}}}],["file(",{"_index":26,"title":{"4":{},"5":{},"6":{}},"description":{}}],["format",{"_index":158,"title":{},"description":{"24":{},"25":{}}}],["futur",{"_index":165,"title":{},"description":{"24":{},"25":{}}}],["gener",{"_index":156,"title":{},"description":{"24":{},"25":{}}}],["happen",{"_index":57,"title":{},"description":{"8":{}}}],["i.",{"_index":85,"title":{},"description":{"11":{},"24":{},"25":{}}}],["identifi",{"_index":150,"title":{},"description":{"24":{},"25":{}}}],["ignor",{"_index":144,"title":{},"description":{"24":{},"25":{}}}],["info",{"_index":134,"title":{},"description":{"24":{},"25":{}}}],["inform",{"_index":141,"title":{},"description":{"24":{},"25":{}}}],["integr",{"_index":164,"title":{},"description":{"24":{},"25":{}}}],["invalid",{"_index":62,"title":{},"description":{"8":{}}}],["it'",{"_index":161,"title":{},"description":{"24":{},"25":{}}}],["json",{"_index":117,"title":{"20":{},"21":{}},"description":{}}],["json/object",{"_index":157,"title":{},"description":{"24":{},"25":{}}}],["key",{"_index":5,"title":{"10":{},"13":{},"15":{}},"description":{"0":{},"11":{},"13":{}}}],["key-valu",{"_index":75,"title":{"11":{},"12":{},"14":{}},"description":{"24":{},"25":{}}}],["kv",{"_index":140,"title":{},"description":{"24":{},"25":{}}}],["list",{"_index":66,"title":{"9":{},"15":{},"22":{},"23":{}},"description":{}}],["locat",{"_index":31,"title":{"4":{},"5":{},"6":{}},"description":{}}],["main",{"_index":12,"title":{},"description":{"0":{}}}],["messag",{"_index":99,"title":{"16":{},"26":{}},"description":{"24":{},"25":{},"26":{}}}],["metric",{"_index":106,"title":{"18":{}},"description":{"18":{}}}],["more",{"_index":129,"title":{},"description":{"24":{},"25":{}}}],["move",{"_index":42,"title":{"5":{}},"description":{"5":{}}}],["mqtt",{"_index":100,"title":{"16":{}},"description":{}}],["name",{"_index":6,"title":{},"description":{"0":{}}}],["namespac",{"_index":68,"title":{"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{}},"description":{}}],["new",{"_index":74,"title":{"11":{},"17":{},"18":{}},"description":{"17":{},"18":{},"24":{},"25":{}}}],["note",{"_index":10,"title":{},"description":{"0":{}}}],["noth",{"_index":56,"title":{},"description":{"8":{}}}],["object",{"_index":130,"title":{},"description":{"24":{},"25":{}}}],["occur",{"_index":84,"title":{},"description":{"11":{}}}],["option",{"_index":127,"title":{},"description":{"24":{},"25":{}}}],["otherwis",{"_index":91,"title":{},"description":{"13":{}}}],["overwritten",{"_index":78,"title":{},"description":{"11":{}}}],["pair",{"_index":76,"title":{"11":{},"12":{},"14":{}},"description":{"24":{},"25":{}}}],["paramet",{"_index":142,"title":{},"description":{"24":{},"25":{}}}],["pass",{"_index":131,"title":{},"description":{"24":{},"25":{}}}],["path",{"_index":61,"title":{},"description":{"8":{}}}],["payload",{"_index":160,"title":{},"description":{"24":{},"25":{}}}],["permiss",{"_index":58,"title":{},"description":{"8":{}}}],["possibl",{"_index":45,"title":{},"description":{"6":{},"24":{},"25":{}}}],["post",{"_index":79,"title":{"17":{},"18":{}},"description":{"11":{},"17":{},"18":{}}}],["posttibl",{"_index":32,"title":{},"description":{"4":{},"5":{}}}],["pre-approv",{"_index":33,"title":{},"description":{"4":{},"5":{},"6":{}}}],["present",{"_index":96,"title":{"15":{}},"description":{}}],["previouli",{"_index":86,"title":{},"description":{"11":{}}}],["properti",{"_index":155,"title":{},"description":{"24":{},"25":{}}}],["publish",{"_index":98,"title":{"16":{}},"description":{}}],["qlik",{"_index":110,"title":{"19":{},"24":{},"25":{}},"description":{}}],["qmc",{"_index":153,"title":{},"description":{"24":{},"25":{}}}],["qvd",{"_index":50,"title":{"7":{}},"description":{"7":{}}}],["recent",{"_index":88,"title":{},"description":{"11":{}}}],["relat",{"_index":135,"title":{},"description":{"24":{},"25":{}}}],["relic",{"_index":104,"title":{"17":{},"18":{}},"description":{"17":{},"18":{}}}],["reload",{"_index":109,"title":{"19":{}},"description":{"24":{},"25":{}}}],["replac",{"_index":87,"title":{},"description":{"11":{}}}],["respond",{"_index":23,"title":{"3":{}},"description":{"3":{}}}],["retriev",{"_index":95,"title":{"15":{}},"description":{}}],["return",{"_index":64,"title":{},"description":{"8":{},"13":{}}}],["same",{"_index":118,"title":{},"description":{"20":{},"21":{},"22":{},"23":{}}}],["send",{"_index":168,"title":{"26":{}},"description":{"26":{}}}],["sens",{"_index":111,"title":{"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{}},"description":{}}],["set",{"_index":145,"title":{},"description":{"24":{},"25":{}}}],["simpli",{"_index":143,"title":{},"description":{"24":{},"25":{}}}],["slack",{"_index":169,"title":{"26":{}},"description":{"26":{}}}],["sourc",{"_index":35,"title":{},"description":{"4":{},"5":{}}}],["specif",{"_index":72,"title":{"10":{},"14":{}},"description":{}}],["specifi",{"_index":77,"title":{"11":{},"15":{}},"description":{"11":{},"13":{}}}],["stand-alon",{"_index":108,"title":{"19":{}},"description":{}}],["start",{"_index":82,"title":{"24":{},"25":{}},"description":{"11":{},"24":{},"25":{}}}],["store",{"_index":139,"title":{},"description":{"24":{},"25":{}}}],["string",{"_index":16,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["subdirectori",{"_index":40,"title":{},"description":{"4":{},"5":{},"6":{}}}],["support",{"_index":137,"title":{},"description":{"24":{},"25":{}}}],["system",{"_index":53,"title":{"8":{}},"description":{}}],["tag",{"_index":152,"title":{},"description":{"24":{},"25":{}}}],["task",{"_index":114,"title":{"19":{},"24":{},"25":{}},"description":{"24":{},"25":{}}}],["taskid",{"_index":151,"title":{},"description":{"24":{},"25":{}}}],["test",{"_index":21,"title":{"3":{}},"description":{"3":{}}}],["thereof",{"_index":46,"title":{},"description":{"6":{}}}],["thing",{"_index":119,"title":{},"description":{"20":{},"21":{},"22":{},"23":{}}}],["thu",{"_index":162,"title":{},"description":{"24":{},"25":{}}}],["topic",{"_index":101,"title":{"16":{}},"description":{}}],["true",{"_index":90,"title":{},"description":{"13":{}}}],["ttl",{"_index":81,"title":{},"description":{"11":{},"24":{},"25":{}}}],["ttl=0",{"_index":146,"title":{},"description":{"24":{},"25":{}}}],["type",{"_index":159,"title":{},"description":{"24":{},"25":{}}}],["us",{"_index":4,"title":{"19":{}},"description":{"0":{},"24":{},"25":{}}}],["v4/app/:appid/dump",{"_index":120,"title":{},"description":{"20":{}}}],["v4/app/{appid}/dump",{"_index":123,"title":{},"description":{"21":{}}}],["v4/app/{appid}/reload",{"_index":115,"title":{},"description":{"19":{}}}],["v4/apps/list",{"_index":125,"title":{},"description":{"22":{},"23":{}}}],["v4/base16tobase62",{"_index":20,"title":{},"description":{"2":{}}}],["v4/base62tobase16",{"_index":19,"title":{},"description":{"1":{}}}],["v4/butlerp",{"_index":24,"title":{},"description":{"3":{}}}],["v4/configfile/endpointsen",{"_index":14,"title":{},"description":{"0":{}}}],["v4/createdir",{"_index":65,"title":{},"description":{"8":{}}}],["v4/createdirqvd",{"_index":51,"title":{},"description":{"7":{}}}],["v4/filecopi",{"_index":41,"title":{},"description":{"4":{}}}],["v4/filedelet",{"_index":47,"title":{},"description":{"6":{}}}],["v4/filemov",{"_index":43,"title":{},"description":{"5":{}}}],["v4/keylist/{namespac",{"_index":97,"title":{},"description":{"15":{}}}],["v4/keyvalues/{namespac",{"_index":73,"title":{},"description":{"10":{},"11":{},"12":{}}}],["v4/keyvalues/{namespace}/keyexist",{"_index":93,"title":{},"description":{"13":{}}}],["v4/keyvalues/{namespace}/{key",{"_index":94,"title":{},"description":{"14":{}}}],["v4/keyvaluesnamespac",{"_index":69,"title":{},"description":{"9":{}}}],["v4/mqttpublishmessag",{"_index":102,"title":{},"description":{"16":{}}}],["v4/newrelic/ev",{"_index":105,"title":{},"description":{"17":{}}}],["v4/newrelic/metr",{"_index":107,"title":{},"description":{"18":{}}}],["v4/reloadtask/{taskid}/start",{"_index":167,"title":{},"description":{"24":{},"25":{}}}],["v4/senseappdump/:appid",{"_index":122,"title":{},"description":{"21":{}}}],["v4/senseappdump/{appid",{"_index":121,"title":{},"description":{"20":{}}}],["v4/senselistapp",{"_index":126,"title":{},"description":{"22":{},"23":{}}}],["v4/slackpostmessag",{"_index":171,"title":{},"description":{"26":{}}}],["valu",{"_index":70,"title":{"10":{}},"description":{"24":{},"25":{}}}],["version",{"_index":166,"title":{},"description":{"24":{},"25":{}}}],["well",{"_index":28,"title":{"4":{},"5":{},"6":{}},"description":{}}],["without",{"_index":113,"title":{"19":{}},"description":{}}],["zero",{"_index":128,"title":{},"description":{"24":{},"25":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/api_doc/butler-api.json b/docs/api_doc/butler-api.json
index ba50f395..0828fcaa 100644
--- a/docs/api_doc/butler-api.json
+++ b/docs/api_doc/butler-api.json
@@ -1 +1 @@
-{"openapi":"3.0.3","info":{"title":"Butler API documentation","description":"Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.\nButler offers both a REST API and things like failed reload notifications etc.\n\nThis page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com","version":"9.0.0"},"components":{"schemas":{}},"paths":{"/v4/configfile/endpointsenabled":{"get":{"summary":"Get an array of all enabled API endpoints.","description":"Get an array of all enabled API endpoints, using the key names from the Butler config file.\n\nNote: Endpoints are enabled/disabled in the Butler main configuration file.","responses":{"200":{"description":"Enabled API enpooints.","content":{"application/json":{"schema":{"description":"Enabled API enpooints.","type":"array","items":{"type":"string"}},"example":["activeUserCount","activeUsers","apiListEnbledEndpoints"]}}}}}},"/v4/base62tobase16":{"get":{"summary":"Converts strings from base62 to base16.","description":"Converts strings from base62 to base16.","parameters":[{"schema":{"type":"string"},"example":"6DMW88LpSok9Z7P7hUK0wv7bF","in":"query","name":"base62","required":true,"description":"The base62 encoded string that should be converted to base16"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base16 encoded string."}}},"example":{"base62":"6DMW88LpSok9Z7P7hUK0wv7bF","base16":"3199af08bfeeaf5d420f27ed9c01e74370077"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/base16tobase62":{"get":{"summary":"Converts strings from base16 to base62.","description":"Converts strings from base16 to base62.","parameters":[{"schema":{"type":"string"},"example":"3199af08bfeeaf5d420f27ed9c01e74370077","in":"query","name":"base16","required":true,"description":"The base16 encoded string that should be converted to base62"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base62 encoded string."}}},"example":{"base16":"3199af08bfeeaf5d420f27ed9c01e74370077","base62":"6DMW88LpSok9Z7P7hUK0wv7bF"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/butlerping":{"get":{"summary":"Tests if Butler is alive and responding","description":"Tests if Butler is alive and responding","responses":{"200":{"description":"Butler is alive and well.","content":{"application/json":{"schema":{"description":"Butler is alive and well.","type":"object","properties":{"response":{"type":"string","example":"Butler reporting for duty"},"butlerVersion":{"type":"string","example":"5.5.0"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filecopy":{"put":{"summary":"Copy file(s) between well defined, approved locations.","description":"Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File copied.","content":{"application/json":{"schema":{"description":"File copied.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filemove":{"put":{"summary":"Move file(s) between well defined, approved locations.","description":"Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File moved.","content":{"application/json":{"schema":{"description":"File moved.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy.","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filedelete":{"delete":{"summary":"Delete file(s) in well defined, approved locations.","description":"It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleteFile":{"type":"string","description":"Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.","examples":["data/qvdstore/sales/file1.qvd"]}}}}}},"responses":{"204":{"description":"File deleted.","content":{"application/json":{"schema":{"description":"File deleted.","type":"object"}}}},"400":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved directory matches the delete request.","content":{"application/json":{"schema":{"description":"No approved directory matches the delete request.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdirqvd":{"post":{"summary":"Creates a directory in designated QVD directory.","description":"Creates a directory in QVD directory (which is defined in Butler's config file).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Directory that should be created.","examples":["subfolder/2020-10"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["subfolder/2020-10"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdir":{"post":{"summary":"Creates a directory anywhere in the file system.","description":"If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Path to directory that should be created. Can be a relative or absolute path.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error (file system permissions etc).","content":{"application/json":{"schema":{"description":"Internal error (file system permissions etc).","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvaluesnamespaces":{"get":{"summary":"List all currently defined namespaces.","responses":{"200":{"description":"Array of all namespaces.","content":{"application/json":{"schema":{"description":"Array of all namespaces.","type":"array","items":{"type":"string"}},"example":["Weekly sales app","Sales ETL step 1","Sales ETL step 2"]}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}":{"get":{"summary":"Get the value associated with a key, in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key and it's associated value and metadata returned.","content":{"application/json":{"schema":{"description":"Key and it's associated value and metadata returned.","type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Create a new key-value pair in the specified namespace.","description":"If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Key to use","examples":["ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"]},"value":{"type":"string","description":"Value to set","examples":["12345.789"]},"ttl":{"type":"number","description":"Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted","examples":[10000]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"201":{"description":"Key successfully set.","content":{"application/json":{"schema":{"description":"Key successfully set.","type":"object","properties":{"namespace":{"type":"string","description":"Name of namespace.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]},"ttl":{"type":"number","description":"Time-to-live for the key-value pair. 0 if no ttl was set, otherwise in milliseconds.","examples":[60000]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a namespace and all key-value pairs in it.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"204":{"description":"Namespace successfully deleted.","content":{"application/json":{"schema":{"description":"Namespace successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/keyexists":{"get":{"summary":"Checks if a key exists in a namespace.","description":"Returns true if the specified key exists, otherwise false.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key exist/no-exist returned, together with the data if the does exist.","content":{"application/json":{"schema":{"description":"Key exist/no-exist returned, together with the data if the does exist.","type":"object","properties":{"keyExists":{"type":"boolean","description":"true/false flag indicating whether the specified key exists in the given namespace."},"keyValue":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/{key}":{"delete":{"summary":"Delete a key-value pair in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."},{"schema":{"type":"string"},"example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1","in":"path","name":"key","required":true,"description":"Key to use"}],"responses":{"204":{"description":"Key-value pair successfully deleted.","content":{"application/json":{"schema":{"description":"Key-value pair successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keylist/{namespace}":{"get":{"summary":"Retrieve a list of all keys present in the specified namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace whose keys should be returned."}],"responses":{"200":{"description":"Object containing namespace name + list of allkeys in the namespace.","content":{"application/json":{"schema":{"description":"Object containing namespace name + list of allkeys in the namespace.","type":"object","properties":{"namespace":{"type":"string","description":"","examples":["Sales ETL step 2"]},"keys":{"type":"array","items":{"type":"object","key":{"type":"string"}},"examples":[[{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2"}]]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/mqttpublishmessage":{"put":{"summary":"Publish a message to a MQTT topic.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Topic to which message should be published.","examples":["qliksense/new_data_notification/sales"]},"message":{"type":"string","description":"The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.","examples":["dt=20201028"]}},"required":["topic","message"]}}},"required":true},"responses":{"201":{"description":"MQTT message successfully published.","content":{"application/json":{"schema":{"description":"MQTT message successfully published.","type":"object","properties":{"topic":{"type":"string","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","example":"dt=20201028"}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/event":{"post":{"summary":"Post events to New Relic.","description":"This endpoint posts events to the New Relic event API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventType":{"type":"string","description":"Event type. Can be a combination of alphanumeric characters, _ underscores, and : colons.","examples":["relead-failed"],"maxLength":254},"timestamp":{"type":"number","description":"The event's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Events reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"attributes":{"type":"array","description":"Dimensions/attributs that will be associated with the event.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"],"maxLength":4096}}}}},"required":["eventType"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/metric":{"post":{"summary":"Post metrics to New Relic.","description":"This endpoint posts metrics to the New Relic metrics API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Metric name.","examples":["memory.heap"],"maxLength":254},"type":{"type":"string","description":"Metric type.","examples":["gauge"],"enum":["gauge"]},"value":{"type":"number","description":"Value of the metric.","examples":[2.3]},"timestamp":{"type":"number","description":"The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"interval":{"type":"number","description":"The length of the time window (millisec). Required for count and summary metric types."},"attributes":{"type":"array","description":"Dimensions that will be associated with the metric.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"]}}}}},"required":["name","type","value"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/reload":{"put":{"summary":"Do a stand-alone reload of a Qlik Sense app, without using a task.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reloadMode":{"type":"integer","description":"Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used"},"partialReload":{"type":"boolean","description":"Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.","examples":[true]},"startQSEoWTaskOnSuccess":{"type":"array","description":"Array of task IDs that should be started when the app has successfully reloaded.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]},"startQSEoWTaskOnFailure":{"type":"array","description":"Array of task IDs that should be started if the app fails reloading.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"201":{"description":"App successfully reloaded.","content":{"application/json":{"schema":{"description":"App successfully reloaded.","type":"object","properties":{"appId":{"type":"string","description":"ID of reloaded app","examples":["210832b5-6174-4572-bd19-3e61eda675ef"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senseappdump/{appId}":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/app/:appId/dump`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/dump":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/senseappdump/:appId`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senselistapps":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/apps/list`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/apps/list":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/senselistapps`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/reloadtask/{taskId}/start":{"put":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/slackpostmessage":{"put":{"summary":"Send message to Slack.","description":"Sends a basic message to Slack.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}},"required":["channel","from_user","msg"]}}},"required":true},"responses":{"201":{"description":"Message successfully sent to Slack.","content":{"application/json":{"schema":{"description":"Message successfully sent to Slack.","type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}}},"servers":[{"url":"http://localhost:8081"}],"externalDocs":{"url":"https://github.com/ptarmiganlabs","description":"Butler family of tools on GitHub"}}
\ No newline at end of file
+{"openapi":"3.0.3","info":{"title":"Butler API documentation","description":"Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.\nButler offers both a REST API and things like failed reload notifications etc.\n\nThis page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com","version":"9.1.0"},"components":{"schemas":{}},"paths":{"/v4/configfile/endpointsenabled":{"get":{"summary":"Get an array of all enabled API endpoints.","description":"Get an array of all enabled API endpoints, using the key names from the Butler config file.\n\nNote: Endpoints are enabled/disabled in the Butler main configuration file.","responses":{"200":{"description":"Enabled API enpooints.","content":{"application/json":{"schema":{"description":"Enabled API enpooints.","type":"array","items":{"type":"string"}},"example":["activeUserCount","activeUsers","apiListEnbledEndpoints"]}}}}}},"/v4/base62tobase16":{"get":{"summary":"Converts strings from base62 to base16.","description":"Converts strings from base62 to base16.","parameters":[{"schema":{"type":"string"},"example":"6DMW88LpSok9Z7P7hUK0wv7bF","in":"query","name":"base62","required":true,"description":"The base62 encoded string that should be converted to base16"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base16 encoded string."}}},"example":{"base62":"6DMW88LpSok9Z7P7hUK0wv7bF","base16":"3199af08bfeeaf5d420f27ed9c01e74370077"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/base16tobase62":{"get":{"summary":"Converts strings from base16 to base62.","description":"Converts strings from base16 to base62.","parameters":[{"schema":{"type":"string"},"example":"3199af08bfeeaf5d420f27ed9c01e74370077","in":"query","name":"base16","required":true,"description":"The base16 encoded string that should be converted to base62"}],"responses":{"200":{"description":"Base conversion successful.","content":{"application/json":{"schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base62 encoded string."}}},"example":{"base16":"3199af08bfeeaf5d420f27ed9c01e74370077","base62":"6DMW88LpSok9Z7P7hUK0wv7bF"}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/butlerping":{"get":{"summary":"Tests if Butler is alive and responding","description":"Tests if Butler is alive and responding","responses":{"200":{"description":"Butler is alive and well.","content":{"application/json":{"schema":{"description":"Butler is alive and well.","type":"object","properties":{"response":{"type":"string","example":"Butler reporting for duty"},"butlerVersion":{"type":"string","example":"5.5.0"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filecopy":{"put":{"summary":"Copy file(s) between well defined, approved locations.","description":"Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File copied.","content":{"application/json":{"schema":{"description":"File copied.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","examples":[false]},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy, or UNC path used when Butler is running on non-Windows operating system","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filemove":{"put":{"summary":"Move file(s) between well defined, approved locations.","description":"Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"responses":{"201":{"description":"File moved.","content":{"application/json":{"schema":{"description":"File moved.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","examples":["subfolder/file1.qvd"]},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","examples":["archive/file1_20200925.qvd"]},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","examples":[false]}}}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved fromDir/toDir for file copy.","content":{"application/json":{"schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/filedelete":{"delete":{"summary":"Delete file(s) in well defined, approved locations.","description":"It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleteFile":{"type":"string","description":"Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.","examples":["data/qvdstore/sales/file1.qvd"]}}}}}},"responses":{"204":{"description":"File deleted.","content":{"application/json":{"schema":{"description":"File deleted.","type":"object"}}}},"400":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","content":{"application/json":{"schema":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"403":{"description":"No approved directory matches the delete request.","content":{"application/json":{"schema":{"description":"No approved directory matches the delete request.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdirqvd":{"post":{"summary":"Creates a directory in designated QVD directory.","description":"Creates a directory in QVD directory (which is defined in Butler's config file).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Directory that should be created.","examples":["subfolder/2020-10"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["subfolder/2020-10"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/createdir":{"post":{"summary":"Creates a directory anywhere in the file system.","description":"If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"string","description":"Path to directory that should be created. Can be a relative or absolute path.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"responses":{"201":{"description":"Directory created.","content":{"application/json":{"schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","examples":["/Users/joe/data/qvds/2020"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error (file system permissions etc).","content":{"application/json":{"schema":{"description":"Internal error (file system permissions etc).","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvaluesnamespaces":{"get":{"summary":"List all currently defined namespaces.","responses":{"200":{"description":"Array of all namespaces.","content":{"application/json":{"schema":{"description":"Array of all namespaces.","type":"array","items":{"type":"string"}},"example":["Weekly sales app","Sales ETL step 1","Sales ETL step 2"]}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}":{"get":{"summary":"Get the value associated with a key, in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key and it's associated value and metadata returned.","content":{"application/json":{"schema":{"description":"Key and it's associated value and metadata returned.","type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Create a new key-value pair in the specified namespace.","description":"If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Key to use","examples":["ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"]},"value":{"type":"string","description":"Value to set","examples":["12345.789"]},"ttl":{"type":"number","description":"Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted","examples":[10000]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"201":{"description":"Key successfully set.","content":{"application/json":{"schema":{"description":"Key successfully set.","type":"object","properties":{"namespace":{"type":"string","description":"Name of namespace.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]},"ttl":{"type":"number","description":"Time-to-live for the key-value pair. 0 if no ttl was set, otherwise in milliseconds.","examples":[60000]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a namespace and all key-value pairs in it.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."}],"responses":{"204":{"description":"Namespace successfully deleted.","content":{"application/json":{"schema":{"description":"Namespace successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/keyexists":{"get":{"summary":"Checks if a key exists in a namespace.","description":"Returns true if the specified key exists, otherwise false.","parameters":[{"schema":{"type":"string"},"example":"Last extract timestamp","in":"query","name":"key","required":true},{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true}],"responses":{"200":{"description":"Key exist/no-exist returned, together with the data if the does exist.","content":{"application/json":{"schema":{"description":"Key exist/no-exist returned, together with the data if the does exist.","type":"object","properties":{"keyExists":{"type":"boolean","description":"true/false flag indicating whether the specified key exists in the given namespace."},"keyValue":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","examples":["Sales ETL step 2"]},"key":{"type":"string","description":"Key name.","examples":["Last extract timestamp"]},"value":{"type":"string","description":"Value stored in the key-value pair.","examples":["2020-09-29 17:14:56"]}}}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keyvalues/{namespace}/{key}":{"delete":{"summary":"Delete a key-value pair in a specific namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace."},{"schema":{"type":"string"},"example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1","in":"path","name":"key","required":true,"description":"Key to use"}],"responses":{"204":{"description":"Key-value pair successfully deleted.","content":{"application/json":{"schema":{"description":"Key-value pair successfully deleted.","type":"string"},"example":""}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/keylist/{namespace}":{"get":{"summary":"Retrieve a list of all keys present in the specified namespace.","parameters":[{"schema":{"type":"string"},"example":"Sales ETL step 2","in":"path","name":"namespace","required":true,"description":"Name of namespace whose keys should be returned."}],"responses":{"200":{"description":"Object containing namespace name + list of allkeys in the namespace.","content":{"application/json":{"schema":{"description":"Object containing namespace name + list of allkeys in the namespace.","type":"object","properties":{"namespace":{"type":"string","description":"","examples":["Sales ETL step 2"]},"keys":{"type":"array","items":{"type":"object","key":{"type":"string"}},"examples":[[{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2"}]]}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","content":{"application/json":{"schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/mqttpublishmessage":{"put":{"summary":"Publish a message to a MQTT topic.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Topic to which message should be published.","examples":["qliksense/new_data_notification/sales"]},"message":{"type":"string","description":"The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.","examples":["dt=20201028"]}},"required":["topic","message"]}}},"required":true},"responses":{"201":{"description":"MQTT message successfully published.","content":{"application/json":{"schema":{"description":"MQTT message successfully published.","type":"object","properties":{"topic":{"type":"string","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","example":"dt=20201028"}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/event":{"post":{"summary":"Post events to New Relic.","description":"This endpoint posts events to the New Relic event API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventType":{"type":"string","description":"Event type. Can be a combination of alphanumeric characters, _ underscores, and : colons.","examples":["relead-failed"],"maxLength":254},"timestamp":{"type":"number","description":"The event's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Events reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"attributes":{"type":"array","description":"Dimensions/attributs that will be associated with the event.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"],"maxLength":4096}}}}},"required":["eventType"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/newrelic/metric":{"post":{"summary":"Post metrics to New Relic.","description":"This endpoint posts metrics to the New Relic metrics API.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Metric name.","examples":["memory.heap"],"maxLength":254},"type":{"type":"string","description":"Metric type.","examples":["gauge"],"enum":["gauge"]},"value":{"type":"number","description":"Value of the metric.","examples":[2.3]},"timestamp":{"type":"number","description":"The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","examples":[1642164296053]},"interval":{"type":"number","description":"The length of the time window (millisec). Required for count and summary metric types."},"attributes":{"type":"array","description":"Dimensions that will be associated with the metric.","items":{"type":"object","properties":{"name":{"type":"string","examples":["host.name"],"maxLength":254},"value":{"type":"string","examples":["dev.server.com"]}}}}},"required":["name","type","value"]}}},"required":true},"responses":{"202":{"description":"Data accepted and sent to New Relic.","content":{"application/json":{"schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","examples":["202"]},"newRelicResultText":{"type":"string","examples":["Data accepted."]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/reload":{"put":{"summary":"Do a stand-alone reload of a Qlik Sense app, without using a task.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reloadMode":{"type":"integer","description":"Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used"},"partialReload":{"type":"boolean","description":"Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.","examples":[true]},"startQSEoWTaskOnSuccess":{"type":"array","description":"Array of task IDs that should be started when the app has successfully reloaded.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]},"startQSEoWTaskOnFailure":{"type":"array","description":"Array of task IDs that should be started if the app fails reloading.","items":{"type":"string"},"examples":[["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]]}}}}}},"parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"201":{"description":"App successfully reloaded.","content":{"application/json":{"schema":{"description":"App successfully reloaded.","type":"object","properties":{"appId":{"type":"string","description":"ID of reloaded app","examples":["210832b5-6174-4572-bd19-3e61eda675ef"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senseappdump/{appId}":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/app/:appId/dump`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/app/{appId}/dump":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/senseappdump/:appId`","parameters":[{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"appId","required":true,"description":"ID of Qlik Sense app."}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","content":{"application/json":{"schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object"},"example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"422":{"description":"App not found in  Qlik Sense.","content":{"application/json":{"schema":{"description":"App not found in  Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/senselistapps":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/apps/list`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/apps/list":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/senselistapps`","responses":{"200":{"description":"App list successfully retrieved.","content":{"application/json":{"schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","examples":["5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"]},"name":{"type":"string","description":"App name","examples":["2021 sales targets"]}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/reloadtask/{taskId}/start":{"put":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"post":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","examples":["keyvaluestore"],"enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},"description":"Optional object with extra info."},"parameters":[{"schema":{"type":"boolean"},"example":true,"in":"query","name":"allTaskIdsMustExist","required":false,"description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this."},{"schema":{"type":"string"},"example":"210832b5-6174-4572-bd19-3e61eda675ef","in":"path","name":"taskId","required":true,"description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid."}],"responses":{"200":{"description":"Task successfully started.","content":{"application/json":{"schema":{"description":"Task successfully started.","type":"object"},"example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}},"/v4/slackpostmessage":{"put":{"summary":"Send message to Slack.","description":"Sends a basic message to Slack.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}},"required":["channel","from_user","msg"]}}},"required":true},"responses":{"201":{"description":"Message successfully sent to Slack.","content":{"application/json":{"schema":{"description":"Message successfully sent to Slack.","type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","examples":["#reload-notification"]},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","examples":["Butler the Bot"]},"msg":{"type":"string","description":"Text going into the Slack message","examples":["This is a message from Qlik Sense"]},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","examples":["thumbsup"]}}}}}},"400":{"description":"Required parameter missing.","content":{"application/json":{"schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}}}},"servers":[{"url":"http://localhost:8081"}],"externalDocs":{"url":"https://github.com/ptarmiganlabs","description":"Butler family of tools on GitHub"}}
\ No newline at end of file
diff --git a/docs/api_doc/butler-api.yaml b/docs/api_doc/butler-api.yaml
index 7e60705f..0005eaa6 100644
--- a/docs/api_doc/butler-api.yaml
+++ b/docs/api_doc/butler-api.yaml
@@ -9,7 +9,7 @@ info:
 
 
     This page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com
-  version: 9.0.0
+  version: 9.1.0
 components:
   schemas: {}
 paths: