diff options
| -rw-r--r-- | Action.md | 75 | ||||
| -rw-r--r-- | Application.md | 65 | ||||
| -rw-r--r-- | Channel.md | 44 | ||||
| -rw-r--r-- | Data.md | 51 | ||||
| -rw-r--r-- | Omaha_version.md | 75 | ||||
| -rw-r--r-- | Platform.md | 44 | ||||
| -rw-r--r-- | Sparkle_version.md | 74 | ||||
| -rw-r--r-- | index.html | 224 |
8 files changed, 600 insertions, 52 deletions
@@ -1,6 +1,6 @@ # Group Action -## Actions Collection [/api/action{?id,version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}] +## Actions Collection [/api/action{?id,version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}/] ### List all Actions [GET] @@ -93,14 +93,71 @@ + Response 200 (application/json) { - "id": 11, - "version": 7, - "event": 1, - "run": "", - "arguments": "--do-not-launch-chrome", - "successurl": "", - "terminateallbrowsers": false, - "successsaction": "default", + "id": 11, + "version": 7, + "event": 1, + "run": "", + "arguments": "--do-not-launch-chrome", + "successurl": "", + "terminateallbrowsers": false, + "successsaction": "default", + "other": null + } + +### Patch an Action [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "event": 0 + } + ++ Response 200 (application/json) + + { + "id": 11, + "version": 7, + "event": 0, + "run": "", + "arguments": "--do-not-launch-chrome", + "successurl": "", + "terminateallbrowsers": false, + "successsaction": "default", + "other": null + } + +### Update an Action [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "version": 7, + "event": 0 + } + ++ Response 200 (application/json) + + { + "id": 11, + "version": 7, + "event": 0, + "run": "", + "arguments": "--do-not-launch-chrome", + "successurl": "", + "terminateallbrowsers": false, + "successsaction": "default", "other": null } diff --git a/Application.md b/Application.md index a02afc2..86d7894 100644 --- a/Application.md +++ b/Application.md @@ -1,6 +1,6 @@ # Group Application -## Applications Collection [/api/app{?id,name}] +## Applications Collection [/api/app{?id,name}/] ### List all Applications [GET] @@ -66,7 +66,7 @@ + Response 200 (application/json) { - "id": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "id": "{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}", "name": "Chromium", "data_set": [ { @@ -79,6 +79,67 @@ ] } +### Patch an Application [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": "Chrome", + } + ++ Response 200 (application/json) + + { + "id": "{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}", + "name": "Chrome", + "data_set": [ + { + "id": 5, + "app": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "index": "Test", + "name": 0, + "value": "", + } + ] + } + +### Update an Application [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "id": "{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}", + "name": "Chrome", + } + ++ Response 200 (application/json) + + { + "id": "{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}", + "name": "Chrome", + "data_set": [ + { + "id": 5, + "app": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "index": "Test", + "name": 0, + "value": "", + } + ] + } + ### Remove an Application [DELETE] + Request @@ -1,6 +1,6 @@ # Group Channel -## Channel Collection [/api/channel{?name}] +## Channel Collection [/api/channel{?name}/] ### List all Channels [GET] @@ -72,6 +72,48 @@ "name": "dev", } +### Patch a Channel [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": "beta", + } + ++ Response 200 (application/json) + + { + "id": 11, + "name": "beta", + } + +### Update a Channel [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": "beta", + } + ++ Response 200 (application/json) + + { + "id": 11, + "name": "beta", + } + ### Remove a Channel [DELETE] + Request @@ -1,6 +1,6 @@ # Group Data -## Data Collection [/api/data{?id,app,index,name,value}] +## Data Collection [/api/data{?id,app,index,name,value}/] ### List all Data [GET] @@ -84,6 +84,55 @@ "value": "", } +### Patch a Data [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": 0 + } + ++ Response 200 (application/json) + + { + "id": 9, + "app": "{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}", + "index": null, + "name": 0, + "value": "", + } + +### Update a Data [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "app": {DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}, + "name": 0 + } + ++ Response 200 (application/json) + + { + "id": 9, + "app": "{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}", + "index": null, + "name": 0, + "value": "", + } + ### Remove a Data [DELETE] + Request diff --git a/Omaha_version.md b/Omaha_version.md index e875912..cd2e623 100644 --- a/Omaha_version.md +++ b/Omaha_version.md @@ -1,6 +1,6 @@ # Group Omaha Version -## Version List [/api/omaha/version{?is_enabled,app,channel,platform,release_notes,file}] +## Version List [/api/omaha/version{?is_enabled,app,channel,platform,release_notes,file}/] ### Get versions [GET] @@ -70,11 +70,7 @@ "platform": 1, "channel": 2, "version": "2.0.0.1024", - "file": "File", - "file_hash": "u8QB8baBHs45RmKNCTIGGtNHXbc=", - "file_size": 143963, - "created": "2014-11-28T11:25:37.213001Z", - "modified": "2014-12-18T09:00:00.094911Z" + "file": "File", } + Response 201 @@ -124,6 +120,73 @@ "modified": "2014-12-18T09:00:00.094911Z" } +### Patch a Version [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "is_enabled": false, + } + ++ Response 200 (application/json) + + { + "id": 38, + "is_enabled": false, + "app": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "platform": 1, + "channel": 2, + "version": "2.0.0.1024", + "release_notes": "", + "file": "https://example.com/build/UpdateTestApp/beta/win/UpdateTestAppInstaller.2.0.0.1024.beta.exe", + "file_hash": "u8QB8baBHs45RmKNCTIGGtNHXbc=", + "file_size": 143963, + "created": "2014-11-28T11:25:37.213001Z", + "modified": "2014-12-18T09:00:00.094911Z" + } + +### Update a Version [PUT] + ++ Request (multipart/form-data) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "app": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "platform": 1, + "channel": 2, + "version": "2.0.0.1024", + "file": "File", + "is_enabled": false, + } + ++ Response 200 (application/json) + + { + "id": 38, + "is_enabled": false, + "app": "{8A76FC95-0086-4BCE-9517-DC09DDB5652F}", + "platform": 1, + "channel": 2, + "version": "2.0.0.1024", + "release_notes": "", + "file": "https://example.com/build/UpdateTestApp/beta/win/UpdateTestAppInstaller.2.0.0.1024.beta.exe", + "file_hash": "u8QB8baBHs45RmKNCTIGGtNHXbc=", + "file_size": 143963, + "created": "2014-11-28T11:25:37.213001Z", + "modified": "2014-12-18T09:00:00.094911Z" + } + ### Remove a Version [DELETE] + Request diff --git a/Platform.md b/Platform.md index 5932ea5..0adef9a 100644 --- a/Platform.md +++ b/Platform.md @@ -1,6 +1,6 @@ # Group Platform -## Platform Collection [/api/platform{?name}] +## Platform Collection [/api/platform{?name}/] ### List all Platforms [GET] @@ -68,6 +68,48 @@ "name": "win", } +### Patch a Platform [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": "ios", + } + ++ Response 200 (application/json) + + { + "id": 1, + "name": "ios", + } + +### Update a Platform [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "name": "ios", + } + ++ Response 200 (application/json) + + { + "id": 1, + "name": "ios", + } + ### Remove a Platform [DELETE] + Request diff --git a/Sparkle_version.md b/Sparkle_version.md index e91318d..5a7dec5 100644 --- a/Sparkle_version.md +++ b/Sparkle_version.md @@ -1,6 +1,6 @@ # Group Sparkle Version -## Version List [/api/sparkle/version{?app,channel,release_notes,file,dsa_signature,version,short_version}] +## Version List [/api/sparkle/version{?app,channel,release_notes,file,dsa_signature,version,short_version}/] ### Get versions [GET] @@ -118,6 +118,78 @@ "modified": "2015-01-14T10:50:56.026884Z" } +### Patch a Version [PATCH] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "app": "{43C257D5-533D-462C-8166-E276519687DE}", + "channel": 5, + "version": "4444.0", + "short_version": "41.0.4444.0", + "release_notes": "<p>Version 41.0.4444.0 is out now</p>", + "file": "{FILE}", + "dsa_signature": "MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==" + } + ++ Response 200 (application/json) + + { + "id": 3, + "app": "{43C257D5-533D-462C-8166-E276519687DE}", + "channel": 5, + "version": "4444.0", + "short_version": "41.0.4444.0", + "release_notes": "<p>Version 41.0.4444.0 is out now</p>", + "file": "https://example.com/sparkle/Installer/stable/Chromium-41.0.4444.0.dmg", + "file_size": 66243223, + "dsa_signature": "MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==", + "created": "2015-01-14T10:50:56.019360Z", + "modified": "2015-01-14T10:50:56.026884Z" + } + +### Update a Version [PUT] + ++ Request (application/json) + + + Headers + + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + + + Body + + { + "app": "{43C257D5-533D-462C-8166-E276519687DE}", + "channel": 5, + "version": "4444.0", + "short_version": "41.0.4444.0", + "release_notes": "<p>Version 41.0.4444.0 is out now</p>", + "file": "{FILE}", + "dsa_signature": "MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==" + } + ++ Response 200 (application/json) + + { + "id": 3, + "app": "{43C257D5-533D-462C-8166-E276519687DE}", + "channel": 5, + "version": "4444.0", + "short_version": "41.0.4444.0", + "release_notes": "<p>Version 41.0.4444.0 is out now</p>", + "file": "https://example.com/sparkle/Installer/stable/Chromium-41.0.4444.0.dmg", + "file_size": 66243223, + "dsa_signature": "MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==", + "created": "2015-01-14T10:50:56.019360Z", + "modified": "2015-01-14T10:50:56.026884Z" + } + ### Remove a Version [DELETE] + Request @@ -1,4 +1,4 @@ -<!DOCTYPE html><html><head><meta charset="utf-8"><title>omaha-server API</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#000;background-color:#337ab7}.action h4.action-heading .method.head{color:#000;background-color:#337ab7}.action h4.action-heading .method.options{color:#000;background-color:#337ab7}.action h4.action-heading .method.put{color:#000;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#000;background-color:#ed9c28}.action h4.action-heading .method.post{color:#000;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#000;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><div id="nav-background"></div><div class="container-fluid triple"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-omaha-server-api">omaha-server API</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-simple-example">Simple example</a></li><li><a href="#header-supplying-basic-auth-headers">Supplying Basic Auth headers</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#application">Application</a></div><div class="collapse-content"><ul><li><a href="#application-applications-collection">Applications Collection</a><ul><li><a href="#application-applications-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Applications</a></li><li><a href="#application-applications-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Application</a></li></ul></li><li><a href="#application-application">Application</a><ul><li><a href="#application-application-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve an Application</a></li><li><a href="#application-application-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove an Application</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#data">Data</a></div><div class="collapse-content"><ul><li><a href="#data-data-collection">Data Collection</a><ul><li><a href="#data-data-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Data</a></li><li><a href="#data-data-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Data</a></li></ul></li><li><a href="#data-data">Data</a><ul><li><a href="#data-data-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Data</a></li><li><a href="#data-data-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Data</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#platform">Platform</a></div><div class="collapse-content"><ul><li><a href="#platform-platform-collection">Platform Collection</a><ul><li><a href="#platform-platform-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Platforms</a></li><li><a href="#platform-platform-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Platform</a></li></ul></li><li><a href="#platform-platform">Platform</a><ul><li><a href="#platform-platform-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Platform</a></li><li><a href="#platform-platform-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Platform</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#channel">Channel</a></div><div class="collapse-content"><ul><li><a href="#channel-channel-collection">Channel Collection</a><ul><li><a href="#channel-channel-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Channels</a></li><li><a href="#channel-channel-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Channel</a></li></ul></li><li><a href="#channel-channel">Channel</a><ul><li><a href="#channel-channel-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Channel</a></li><li><a href="#channel-channel-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Channel</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#omaha-version">Omaha Version</a></div><div class="collapse-content"><ul><li><a href="#omaha-version-version-list">Version List</a><ul><li><a href="#omaha-version-version-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get versions</a></li><li><a href="#omaha-version-version-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Version</a></li></ul></li><li><a href="#omaha-version-version">Version</a><ul><li><a href="#omaha-version-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Version</a></li><li><a href="#omaha-version-version-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#action">Action</a></div><div class="collapse-content"><ul><li><a href="#action-actions-collection">Actions Collection</a><ul><li><a href="#action-actions-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Actions</a></li><li><a href="#action-actions-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Action</a></li></ul></li><li><a href="#action-action">Action</a><ul><li><a href="#action-action-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve an Action</a></li><li><a href="#action-action-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove an Action</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#sparkle-version">Sparkle Version</a></div><div class="collapse-content"><ul><li><a href="#sparkle-version-version-list">Version List</a><ul><li><a href="#sparkle-version-version-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get versions</a></li><li><a href="#sparkle-version-version-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Version</a></li></ul></li><li><a href="#sparkle-version-version">Version</a><ul><li><a href="#sparkle-version-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Version</a></li><li><a href="#sparkle-version-version-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#symbols">Symbols</a></div><div class="collapse-content"><ul><li><a href="#symbols-symbols-list">Symbols List</a><ul><li><a href="#symbols-symbols-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get Symbols</a></li><li><a href="#symbols-symbols-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Symbols</a></li></ul></li><li><a href="#symbols-symbols">Symbols</a><ul><li><a href="#symbols-symbols-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Symbols</a></li><li><a href="#symbols-symbols-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Symbols</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#statistics">Statistics</a></div><div class="collapse-content"><ul><li><a href="#statistics-users-by-months-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li><li><a href="#statistics-users-by-versions-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li><li><a href="#statistics-users-by-channels-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#live-statistics">Live Statistics</a></div><div class="collapse-content"><ul><li><a href="#live-statistics-online-users-per-hour-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get live statistics</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#downloads-portal">Downloads Portal</a></div><div class="collapse-content"><ul><li><a href="#downloads-portal-latest-available-versions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get Latest Versions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#omaha-server">Omaha server</a></div><div class="collapse-content"><ul><li><a href="#omaha-server-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get version</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#crash-reports">Crash Reports</a></div><div class="collapse-content"><ul><li><a href="#crash-reports-crash-report-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Crash Reports</a></li><li><a href="#crash-reports-crash-report-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Crash Report</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#feedbacks">Feedbacks</a></div><div class="collapse-content"><ul><li><a href="#feedbacks-feedback-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Feedbacks</a></li><li><a href="#feedbacks-feedback-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Feedback</a></li></ul></div></div></nav><div class="content"><div id="right-panel-background"></div><div class="middle"><header><h1 id="top">omaha-server API</h1></header></div><div class="right"><h5>API Endpoint</h5><a></a></div><div class="middle"><h1 id="header-omaha-server-api">omaha-server API <a class="permalink" href="#header-omaha-server-api" aria-hidden="true">ΒΆ</a></h1> +<!DOCTYPE html><html><head><meta charset="utf-8"><title>omaha-server API</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#000;background-color:#337ab7}.action h4.action-heading .method.head{color:#000;background-color:#337ab7}.action h4.action-heading .method.options{color:#000;background-color:#337ab7}.action h4.action-heading .method.put{color:#000;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#000;background-color:#ed9c28}.action h4.action-heading .method.post{color:#000;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#000;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><div id="nav-background"></div><div class="container-fluid triple"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-omaha-server-api">omaha-server API</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-simple-example">Simple example</a></li><li><a href="#header-supplying-basic-auth-headers">Supplying Basic Auth headers</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#application">Application</a></div><div class="collapse-content"><ul><li><a href="#application-applications-collection">Applications Collection</a><ul><li><a href="#application-applications-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Applications</a></li><li><a href="#application-applications-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Application</a></li></ul></li><li><a href="#application-application">Application</a><ul><li><a href="#application-application-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve an Application</a></li><li><a href="#application-application-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch an Application</a></li><li><a href="#application-application-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update an Application</a></li><li><a href="#application-application-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove an Application</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#data">Data</a></div><div class="collapse-content"><ul><li><a href="#data-data-collection">Data Collection</a><ul><li><a href="#data-data-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Data</a></li><li><a href="#data-data-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Data</a></li></ul></li><li><a href="#data-data">Data</a><ul><li><a href="#data-data-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Data</a></li><li><a href="#data-data-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch a Data</a></li><li><a href="#data-data-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Data</a></li><li><a href="#data-data-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Data</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#platform">Platform</a></div><div class="collapse-content"><ul><li><a href="#platform-platform-collection">Platform Collection</a><ul><li><a href="#platform-platform-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Platforms</a></li><li><a href="#platform-platform-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Platform</a></li></ul></li><li><a href="#platform-platform">Platform</a><ul><li><a href="#platform-platform-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Platform</a></li><li><a href="#platform-platform-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch a Platform</a></li><li><a href="#platform-platform-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Platform</a></li><li><a href="#platform-platform-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Platform</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#channel">Channel</a></div><div class="collapse-content"><ul><li><a href="#channel-channel-collection">Channel Collection</a><ul><li><a href="#channel-channel-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Channels</a></li><li><a href="#channel-channel-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Channel</a></li></ul></li><li><a href="#channel-channel">Channel</a><ul><li><a href="#channel-channel-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Channel</a></li><li><a href="#channel-channel-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch a Channel</a></li><li><a href="#channel-channel-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Channel</a></li><li><a href="#channel-channel-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Channel</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#omaha-version">Omaha Version</a></div><div class="collapse-content"><ul><li><a href="#omaha-version-version-list">Version List</a><ul><li><a href="#omaha-version-version-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get versions</a></li><li><a href="#omaha-version-version-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Version</a></li></ul></li><li><a href="#omaha-version-version">Version</a><ul><li><a href="#omaha-version-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Version</a></li><li><a href="#omaha-version-version-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch a Version</a></li><li><a href="#omaha-version-version-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Version</a></li><li><a href="#omaha-version-version-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#action">Action</a></div><div class="collapse-content"><ul><li><a href="#action-actions-collection">Actions Collection</a><ul><li><a href="#action-actions-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Actions</a></li><li><a href="#action-actions-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an Action</a></li></ul></li><li><a href="#action-action">Action</a><ul><li><a href="#action-action-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve an Action</a></li><li><a href="#action-action-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch an Action</a></li><li><a href="#action-action-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update an Action</a></li><li><a href="#action-action-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove an Action</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#sparkle-version">Sparkle Version</a></div><div class="collapse-content"><ul><li><a href="#sparkle-version-version-list">Version List</a><ul><li><a href="#sparkle-version-version-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get versions</a></li><li><a href="#sparkle-version-version-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Version</a></li></ul></li><li><a href="#sparkle-version-version">Version</a><ul><li><a href="#sparkle-version-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Version</a></li><li><a href="#sparkle-version-version-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Patch a Version</a></li><li><a href="#sparkle-version-version-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Version</a></li><li><a href="#sparkle-version-version-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#symbols">Symbols</a></div><div class="collapse-content"><ul><li><a href="#symbols-symbols-list">Symbols List</a><ul><li><a href="#symbols-symbols-list-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get Symbols</a></li><li><a href="#symbols-symbols-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Symbols</a></li></ul></li><li><a href="#symbols-symbols">Symbols</a><ul><li><a href="#symbols-symbols-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Symbols</a></li><li><a href="#symbols-symbols-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove a Symbols</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#statistics">Statistics</a></div><div class="collapse-content"><ul><li><a href="#statistics-users-by-months-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li><li><a href="#statistics-users-by-versions-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li><li><a href="#statistics-users-by-channels-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get statistics</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#live-statistics">Live Statistics</a></div><div class="collapse-content"><ul><li><a href="#live-statistics-online-users-per-hour-for-app-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get live statistics</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#downloads-portal">Downloads Portal</a></div><div class="collapse-content"><ul><li><a href="#downloads-portal-latest-available-versions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get Latest Versions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#omaha-server">Omaha server</a></div><div class="collapse-content"><ul><li><a href="#omaha-server-version-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get version</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#crash-reports">Crash Reports</a></div><div class="collapse-content"><ul><li><a href="#crash-reports-crash-report-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Crash Reports</a></li><li><a href="#crash-reports-crash-report-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Crash Report</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#feedbacks">Feedbacks</a></div><div class="collapse-content"><ul><li><a href="#feedbacks-feedback-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all Feedbacks</a></li><li><a href="#feedbacks-feedback-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Feedback</a></li></ul></div></div></nav><div class="content"><div id="right-panel-background"></div><div class="middle"><header><h1 id="top">omaha-server API</h1></header></div><div class="right"><h5>API Endpoint</h5><a></a></div><div class="middle"><h1 id="header-omaha-server-api">omaha-server API <a class="permalink" href="#header-omaha-server-api" aria-hidden="true">ΒΆ</a></h1> <h1 id="header-authentication">Authentication <a class="permalink" href="#header-authentication" aria-hidden="true">ΒΆ</a></h1> <p>Omaha-server allows REST clients to authenicate themselves with a user name and password using <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">basic authentication</a>.</p> <h2 id="header-simple-example">Simple example <a class="permalink" href="#header-simple-example" aria-hidden="true">ΒΆ</a></h2> @@ -18,7 +18,7 @@ </li> </ol> <pre><code>curl -<span class="hljs-keyword">D</span>- -X GET -<span class="hljs-keyword">H</span> <span class="hljs-string">"Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ="</span> -<span class="hljs-keyword">H</span> <span class="hljs-string">"Content-Type: application/json"</span> <span class="hljs-string">"http://example.com/api/omaha/version"</span></code></pre> -</div><div class="middle"><section id="application" class="resource-group"><h2 class="group-heading">Application <a href="#application" class="permalink">¶</a></h2></section></div><div class="middle"><div id="application-applications-collection" class="resource"><h3 class="resource-heading">Applications Collection <a href="#application-applications-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/app</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +</div><div class="middle"><section id="application" class="resource-group"><h2 class="group-heading">Application <a href="#application" class="permalink">¶</a></h2></section></div><div class="middle"><div id="application-applications-collection" class="resource"><h3 class="resource-heading">Applications Collection <a href="#application-applications-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/app/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chromium"</span> @@ -27,14 +27,14 @@ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{430FD4D0-B729-4F61-AA34-91526481799D}"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Potato"</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-applications-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Applications</div><a href="#application-applications-collection-get" class="method get">GET</a><code class="uri">/api/app</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/app?<span class="hljs-attribute">id=</span><span class="hljs-literal">{8A76FC95-0086-4BCE-9517-DC09DDB5652F}</span>&<span class="hljs-attribute">name=</span><span class="hljs-literal">Chromium</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-applications-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Applications</div><a href="#application-applications-collection-get" class="method get">GET</a><code class="uri">/api/app/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/app?<span class="hljs-attribute">id=</span><span class="hljs-literal">{8A76FC95-0086-4BCE-9517-DC09DDB5652F}</span>&<span class="hljs-attribute">name=</span><span class="hljs-literal">Chromium</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chromium"</span></span>, }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chromium"</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-applications-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Application</div><a href="#application-applications-collection-post" class="method post">POST</a><code class="uri">/api/app{?id,name}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{8A76FC95-0086-4BCE-9517-DC09DDB5652F}</span></span></dd><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>Chromium</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="application-application" class="resource"><h3 class="resource-heading">Application <a href="#application-application" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ - "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-applications-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Application</div><a href="#application-applications-collection-post" class="method post">POST</a><code class="uri">/api/app{?id,name}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{8A76FC95-0086-4BCE-9517-DC09DDB5652F}</span></span></dd><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>Chromium</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="application-application" class="resource"><h3 class="resource-heading">Application <a href="#application-application" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chromium"</span></span>, "<span class="hljs-attribute">data_set</span>": <span class="hljs-value">[ { @@ -45,7 +45,36 @@ "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, } ] -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve an Application</div><a href="#application-application-get" class="method get">GET</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove an Application</div><a href="#application-application-delete" class="method delete">DELETE</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="data" class="resource-group"><h2 class="group-heading">Data <a href="#data" class="permalink">¶</a></h2></section></div><div class="middle"><div id="data-data-collection" class="resource"><h3 class="resource-heading">Data Collection <a href="#data-data-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/data</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve an Application</div><a href="#application-application-get" class="method get">GET</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chrome"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}"</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chrome"</span></span>, + "<span class="hljs-attribute">data_set</span>": <span class="hljs-value">[ + { + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, + "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-string">"Test"</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + } + ] +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch an Application</div><a href="#application-application-patch" class="method patch">PATCH</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}"</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chrome"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}"</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Chrome"</span></span>, + "<span class="hljs-attribute">data_set</span>": <span class="hljs-value">[ + { + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, + "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-string">"Test"</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + } + ] +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-put" class="action put"><h4 class="action-heading"><div class="name">Update an Application</div><a href="#application-application-put" class="method put">PUT</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/app/<span class="hljs-attribute" title="id">{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="application-application-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove an Application</div><a href="#application-application-delete" class="method delete">DELETE</a><code class="uri">/api/app/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{F84D2B10-5F37-41F0-8B1F-2566AF2723B2}</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="data" class="resource-group"><h2 class="group-heading">Data <a href="#data" class="permalink">¶</a></h2></section></div><div class="middle"><div id="data-data-collection" class="resource"><h3 class="resource-heading">Data Collection <a href="#data-data-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/data/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}"</span></span>, @@ -60,7 +89,7 @@ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, } -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Data</div><a href="#data-data-collection-get" class="method get">GET</a><code class="uri">/api/data</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/data?<span class="hljs-attribute">app=</span><span class="hljs-literal">{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}</span>&<span class="hljs-attribute">index=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">name=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">value=</span><span class="hljs-literal"></span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Data</div><a href="#data-data-collection-get" class="method get">GET</a><code class="uri">/api/data/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/data?<span class="hljs-attribute">app=</span><span class="hljs-literal">{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}</span>&<span class="hljs-attribute">index=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">name=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">value=</span><span class="hljs-literal"></span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ <span class="hljs-string">"app"</span>: {DB77BFF7-<span class="hljs-number">8</span>C02-<span class="hljs-number">4</span>D31-A103-<span class="hljs-number">5</span>FDE27CF6B3C}, <span class="hljs-string">"name"</span>: <span class="hljs-number">1</span> }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ @@ -69,7 +98,7 @@ "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Data</div><a href="#data-data-collection-post" class="method post">POST</a><code class="uri">/api/data{?app,index,name,value}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>app</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}</span></span><p>App ID</p> +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Data</div><a href="#data-data-collection-post" class="method post">POST</a><code class="uri">/api/data{?app,index,name,value}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>app</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}</span></span><p>App ID</p> </dd><dt>name</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Type of data. install=0, untrusted=1</p> </dd><dt>index</dt><dd><code>string</code> <span>(optional)</span> </dd><dt>value</dt><dd><code>string</code> <span>(optional)</span> </dd></dl></div></div></div><hr class="split"><div class="middle"><div id="data-data" class="resource"><h3 class="resource-heading">Data <a href="#data-data" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/data/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">9</span></span>, @@ -77,7 +106,24 @@ "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Data</div><a href="#data-data-get" class="method get">GET</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/data/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Data</div><a href="#data-data-delete" class="method delete">DELETE</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="platform" class="resource-group"><h2 class="group-heading">Platform <a href="#platform" class="permalink">¶</a></h2></section></div><div class="middle"><div id="platform-platform-collection" class="resource"><h3 class="resource-heading">Platform Collection <a href="#platform-platform-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/platform</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Data</div><a href="#data-data-get" class="method get">GET</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/data/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">0</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">9</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}"</span></span>, + "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch a Data</div><a href="#data-data-patch" class="method patch">PATCH</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/data/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + <span class="hljs-string">"app"</span>: {DB77BFF7-<span class="hljs-number">8</span>C02-<span class="hljs-number">4</span>D31-A103-<span class="hljs-number">5</span>FDE27CF6B3C}, + <span class="hljs-string">"name"</span>: <span class="hljs-number">0</span> +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">9</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{DB77BFF7-8C02-4D31-A103-5FDE27CF6B3C}"</span></span>, + "<span class="hljs-attribute">index</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-put" class="action put"><h4 class="action-heading"><div class="name">Update a Data</div><a href="#data-data-put" class="method put">PUT</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/data/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="data-data-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Data</div><a href="#data-data-delete" class="method delete">DELETE</a><code class="uri">/api/data/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="platform" class="resource-group"><h2 class="group-heading">Platform <a href="#platform" class="permalink">¶</a></h2></section></div><div class="middle"><div id="platform-platform-collection" class="resource"><h3 class="resource-heading">Platform Collection <a href="#platform-platform-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/platform/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"win"</span> @@ -86,15 +132,25 @@ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"mac"</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Platforms</div><a href="#platform-platform-collection-get" class="method get">GET</a><code class="uri">/api/platform</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/platform?<span class="hljs-attribute">name=</span><span class="hljs-literal">ios</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Platforms</div><a href="#platform-platform-collection-get" class="method get">GET</a><code class="uri">/api/platform/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/platform?<span class="hljs-attribute">name=</span><span class="hljs-literal">ios</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Platform</div><a href="#platform-platform-collection-post" class="method post">POST</a><code class="uri">/api/platform{?name}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>ios</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="platform-platform" class="resource"><h3 class="resource-heading">Platform <a href="#platform-platform" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Platform</div><a href="#platform-platform-collection-post" class="method post">POST</a><code class="uri">/api/platform{?name}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>ios</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="platform-platform" class="resource"><h3 class="resource-heading">Platform <a href="#platform-platform" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"win"</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Platform</div><a href="#platform-platform-get" class="method get">GET</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Platform</div><a href="#platform-platform-delete" class="method delete">DELETE</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="channel" class="resource-group"><h2 class="group-heading">Channel <a href="#channel" class="permalink">¶</a></h2></section></div><div class="middle"><div id="channel-channel-collection" class="resource"><h3 class="resource-heading">Channel Collection <a href="#channel-channel-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/channel</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Platform</div><a href="#platform-platform-get" class="method get">GET</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch a Platform</div><a href="#platform-platform-patch" class="method patch">PATCH</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ios"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-put" class="action put"><h4 class="action-heading"><div class="name">Update a Platform</div><a href="#platform-platform-put" class="method put">PUT</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/platform/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="platform-platform-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Platform</div><a href="#platform-platform-delete" class="method delete">DELETE</a><code class="uri">/api/platform/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="channel" class="resource-group"><h2 class="group-heading">Channel <a href="#channel" class="permalink">¶</a></h2></section></div><div class="middle"><div id="channel-channel-collection" class="resource"><h3 class="resource-heading">Channel Collection <a href="#channel-channel-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/channel/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"stable"</span> @@ -107,15 +163,25 @@ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"alpha"</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Channels</div><a href="#channel-channel-collection-get" class="method get">GET</a><code class="uri">/api/channel</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/channel?<span class="hljs-attribute">name=</span><span class="hljs-literal">dev</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Channels</div><a href="#channel-channel-collection-get" class="method get">GET</a><code class="uri">/api/channel/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/channel?<span class="hljs-attribute">name=</span><span class="hljs-literal">dev</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"dev"</span></span>, }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"dev"</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Channel</div><a href="#channel-channel-collection-post" class="method post">POST</a><code class="uri">/api/channel{?name}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>dev</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="channel-channel" class="resource"><h3 class="resource-heading">Channel <a href="#channel-channel" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Channel</div><a href="#channel-channel-collection-post" class="method post">POST</a><code class="uri">/api/channel{?name}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>dev</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><div id="channel-channel" class="resource"><h3 class="resource-heading">Channel <a href="#channel-channel" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"dev"</span></span>, -}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Channel</div><a href="#channel-channel-get" class="method get">GET</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Channel</div><a href="#channel-channel-delete" class="method delete">DELETE</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="omaha-version" class="resource-group"><h2 class="group-heading">Omaha Version <a href="#omaha-version" class="permalink">¶</a></h2></section></div><div class="middle"><div id="omaha-version-version-list" class="resource"><h3 class="resource-heading">Version List <a href="#omaha-version-version-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/omaha/version</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Channel</div><a href="#channel-channel-get" class="method get">GET</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"beta"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"beta"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch a Channel</div><a href="#channel-channel-patch" class="method patch">PATCH</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"beta"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, + "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"beta"</span></span>, +}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-put" class="action put"><h4 class="action-heading"><div class="name">Update a Channel</div><a href="#channel-channel-put" class="method put">PUT</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/channel/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="channel-channel-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Channel</div><a href="#channel-channel-delete" class="method delete">DELETE</a><code class="uri">/api/channel/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="omaha-version" class="resource-group"><h2 class="group-heading">Omaha Version <a href="#omaha-version" class="permalink">¶</a></h2></section></div><div class="middle"><div id="omaha-version-version-list" class="resource"><h3 class="resource-heading">Version List <a href="#omaha-version-version-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">33</span></span>, "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>, @@ -144,17 +210,29 @@ "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2014-11-28T11:25:37.213001Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2014-12-18T09:00:00.094911Z"</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-list-get" class="action get"><h4 class="action-heading"><div class="name">Get versions</div><a href="#omaha-version-version-list-get" class="method get">GET</a><code class="uri">/api/omaha/version</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/omaha/version?<span class="hljs-attribute">is_enabled=</span><span class="hljs-literal">false</span>&<span class="hljs-attribute">app=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">channel=</span><span class="hljs-literal">2</span>&<span class="hljs-attribute">platform=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">release_notes=</span><span class="hljs-literal">Release notes</span>&<span class="hljs-attribute">file=</span><span class="hljs-literal"></span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-list-get" class="action get"><h4 class="action-heading"><div class="name">Get versions</div><a href="#omaha-version-version-list-get" class="method get">GET</a><code class="uri">/api/omaha/version/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/omaha/version?<span class="hljs-attribute">is_enabled=</span><span class="hljs-literal">false</span>&<span class="hljs-attribute">app=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">channel=</span><span class="hljs-literal">2</span>&<span class="hljs-attribute">platform=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">release_notes=</span><span class="hljs-literal">Release notes</span>&<span class="hljs-attribute">file=</span><span class="hljs-literal"></span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, + "<span class="hljs-attribute">platform</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"2.0.0.1024"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"File"</span></span>, + }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">38</span></span>, + "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>, "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, "<span class="hljs-attribute">platform</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"2.0.0.1024"</span></span>, - "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"File"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"https://example.com/build/UpdateTestApp/beta/win/UpdateTestAppInstaller.2.0.0.1024.beta.exe"</span></span>, "<span class="hljs-attribute">file_hash</span>": <span class="hljs-value"><span class="hljs-string">"u8QB8baBHs45RmKNCTIGGtNHXbc="</span></span>, "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">143963</span></span>, "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2014-11-28T11:25:37.213001Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2014-12-18T09:00:00.094911Z"</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-list-post" class="action post"><h4 class="action-heading"><div class="name">Create a Version</div><a href="#omaha-version-version-list-post" class="method post">POST</a><code class="uri">/api/omaha/version{?is_enabled,app,channel,platform,release_notes,file}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>is_enabled</dt><dd><code>boolean</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>true</span></span> <span class="text-muted example"><strong>Example: </strong><span>false</span></span></dd><dt>app</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Application ID</p> +</dd><dt>platform</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Platform ID</p> +</dd><dt>channel</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>2</span></span><p>Channel ID</p> +</dd><dt>version</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>30.0.2592.123</span></span></dd><dt>release_notes</dt><dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>Release notes</span></span></dd><dt>file</dt><dd><code>file</code> <span class="required">(required)</span> </dd></dl></div></div></div><hr class="split"><div class="middle"><div id="omaha-version-version" class="resource"><h3 class="resource-heading">Version <a href="#omaha-version-version" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">38</span></span>, "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>, "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, @@ -167,12 +245,31 @@ "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">143963</span></span>, "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2014-11-28T11:25:37.213001Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2014-12-18T09:00:00.094911Z"</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-list-post" class="action post"><h4 class="action-heading"><div class="name">Create a Version</div><a href="#omaha-version-version-list-post" class="method post">POST</a><code class="uri">/api/omaha/version{?is_enabled,app,channel,platform,release_notes,file}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>is_enabled</dt><dd><code>boolean</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>true</span></span> <span class="text-muted example"><strong>Example: </strong><span>false</span></span></dd><dt>app</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Application ID</p> -</dd><dt>platform</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Platform ID</p> -</dd><dt>channel</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>2</span></span><p>Channel ID</p> -</dd><dt>version</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>30.0.2592.123</span></span></dd><dt>release_notes</dt><dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>Release notes</span></span></dd><dt>file</dt><dd><code>file</code> <span class="required">(required)</span> </dd></dl></div></div></div><hr class="split"><div class="middle"><div id="omaha-version-version" class="resource"><h3 class="resource-heading">Version <a href="#omaha-version-version" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Version</div><a href="#omaha-version-version-get" class="method get">GET</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, + }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">38</span></span>, - "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>, + "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, + "<span class="hljs-attribute">platform</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"2.0.0.1024"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"https://example.com/build/UpdateTestApp/beta/win/UpdateTestAppInstaller.2.0.0.1024.beta.exe"</span></span>, + "<span class="hljs-attribute">file_hash</span>": <span class="hljs-value"><span class="hljs-string">"u8QB8baBHs45RmKNCTIGGtNHXbc="</span></span>, + "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">143963</span></span>, + "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2014-11-28T11:25:37.213001Z"</span></span>, + "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2014-12-18T09:00:00.094911Z"</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch a Version</div><a href="#omaha-version-version-patch" class="method patch">PATCH</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, + "<span class="hljs-attribute">platform</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"2.0.0.1024"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"File"</span></span>, + "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, + }</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">38</span></span>, + "<span class="hljs-attribute">is_enabled</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{8A76FC95-0086-4BCE-9517-DC09DDB5652F}"</span></span>, "<span class="hljs-attribute">platform</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, @@ -183,7 +280,7 @@ "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">143963</span></span>, "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2014-11-28T11:25:37.213001Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2014-12-18T09:00:00.094911Z"</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Version</div><a href="#omaha-version-version-get" class="method get">GET</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Version</div><a href="#omaha-version-version-delete" class="method delete">DELETE</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="action" class="resource-group"><h2 class="group-heading">Action <a href="#action" class="permalink">¶</a></h2></section></div><div class="middle"><div id="action-actions-collection" class="resource"><h3 class="resource-heading">Actions Collection <a href="#action-actions-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/action</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-put" class="action put"><h4 class="action-heading"><div class="name">Update a Version</div><a href="#omaha-version-version-put" class="method put">PUT</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/omaha/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="omaha-version-version-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Version</div><a href="#omaha-version-version-delete" class="method delete">DELETE</a><code class="uri">/api/omaha/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="action" class="resource-group"><h2 class="group-heading">Action <a href="#action" class="permalink">¶</a></h2></section></div><div class="middle"><div id="action-actions-collection" class="resource"><h3 class="resource-heading">Actions Collection <a href="#action-actions-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/action/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">6</span></span>, @@ -206,7 +303,7 @@ "<span class="hljs-attribute">successsaction</span>": <span class="hljs-value"><span class="hljs-string">"default"</span></span>, "<span class="hljs-attribute">other</span>": <span class="hljs-value"><span class="hljs-literal">null</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-actions-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Actions</div><a href="#action-actions-collection-get" class="method get">GET</a><code class="uri">/api/action</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/action?<span class="hljs-attribute">version=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">event=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">run=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">arguments=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">successurl=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">terminateallbrowsers=</span><span class="hljs-literal">true</span>&<span class="hljs-attribute">successsaction=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">other=</span><span class="hljs-literal"></span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-actions-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all Actions</div><a href="#action-actions-collection-get" class="method get">GET</a><code class="uri">/api/action/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/action?<span class="hljs-attribute">version=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">event=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">run=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">arguments=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">successurl=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">terminateallbrowsers=</span><span class="hljs-literal">true</span>&<span class="hljs-attribute">successsaction=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">other=</span><span class="hljs-literal"></span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>, "<span class="hljs-attribute">event</span>": <span class="hljs-value"><span class="hljs-number">1</span> </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{ @@ -219,7 +316,7 @@ "<span class="hljs-attribute">terminateallbrowsers</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, "<span class="hljs-attribute">successsaction</span>": <span class="hljs-value"><span class="hljs-string">"default"</span></span>, "<span class="hljs-attribute">other</span>": <span class="hljs-value"><span class="hljs-literal">null</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-actions-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Action</div><a href="#action-actions-collection-post" class="method post">POST</a><code class="uri">/api/action{?version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>version</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Version ID</p> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-actions-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create an Action</div><a href="#action-actions-collection-post" class="method post">POST</a><code class="uri">/api/action{?version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>version</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Version ID</p> </dd><dt>event</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Contains a fixed string denoting when this action should be run. preinstall=0, install=1, postinstall=2, update=3</p> </dd><dt>run</dt><dd><code>string</code> <span>(optional)</span> <p>The name of an installer binary to run.</p> </dd><dt>arguments</dt><dd><code>string</code> <span>(optional)</span> <span class="text-info default"><strong>Default: </strong><span>--do-not-launch-chrome</span></span> <p>Arguments to be passed to that installer binary.</p> @@ -237,7 +334,32 @@ "<span class="hljs-attribute">terminateallbrowsers</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, "<span class="hljs-attribute">successsaction</span>": <span class="hljs-value"><span class="hljs-string">"default"</span></span>, "<span class="hljs-attribute">other</span>": <span class="hljs-value"><span class="hljs-literal">null</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve an Action</div><a href="#action-action-get" class="method get">GET</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/action/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove an Action</div><a href="#action-action-delete" class="method delete">DELETE</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="sparkle-version" class="resource-group"><h2 class="group-heading">Sparkle Version <a href="#sparkle-version" class="permalink">¶</a></h2></section></div><div class="middle"><div id="sparkle-version-version-list" class="resource"><h3 class="resource-heading">Version List <a href="#sparkle-version-version-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve an Action</div><a href="#action-action-get" class="method get">GET</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/action/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">event</span>": <span class="hljs-value"><span class="hljs-number">0</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>, + "<span class="hljs-attribute">event</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">run</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">arguments</span>": <span class="hljs-value"><span class="hljs-string">"--do-not-launch-chrome"</span></span>, + "<span class="hljs-attribute">successurl</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">terminateallbrowsers</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, + "<span class="hljs-attribute">successsaction</span>": <span class="hljs-value"><span class="hljs-string">"default"</span></span>, + "<span class="hljs-attribute">other</span>": <span class="hljs-value"><span class="hljs-literal">null</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch an Action</div><a href="#action-action-patch" class="method patch">PATCH</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/action/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>, + "<span class="hljs-attribute">event</span>": <span class="hljs-value"><span class="hljs-number">0</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-number">7</span></span>, + "<span class="hljs-attribute">event</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, + "<span class="hljs-attribute">run</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">arguments</span>": <span class="hljs-value"><span class="hljs-string">"--do-not-launch-chrome"</span></span>, + "<span class="hljs-attribute">successurl</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>, + "<span class="hljs-attribute">terminateallbrowsers</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, + "<span class="hljs-attribute">successsaction</span>": <span class="hljs-value"><span class="hljs-string">"default"</span></span>, + "<span class="hljs-attribute">other</span>": <span class="hljs-value"><span class="hljs-literal">null</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-put" class="action put"><h4 class="action-heading"><div class="name">Update an Action</div><a href="#action-action-put" class="method put">PUT</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/action/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="action-action-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove an Action</div><a href="#action-action-delete" class="method delete">DELETE</a><code class="uri">/api/action/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="sparkle-version" class="resource-group"><h2 class="group-heading">Sparkle Version <a href="#sparkle-version" class="permalink">¶</a></h2></section></div><div class="middle"><div id="sparkle-version-version-list" class="resource"><h3 class="resource-heading">Version List <a href="#sparkle-version-version-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, @@ -264,7 +386,7 @@ "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.019360Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.026884Z"</span> </span>} -]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-list-get" class="action get"><h4 class="action-heading"><div class="name">Get versions</div><a href="#sparkle-version-version-list-get" class="method get">GET</a><code class="uri">/api/sparkle/version</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version?<span class="hljs-attribute">app=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">channel=</span><span class="hljs-literal">2</span>&<span class="hljs-attribute">release_notes=</span><span class="hljs-literal">Release notes</span>&<span class="hljs-attribute">file=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">dsa_signature=</span><span class="hljs-literal">MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==</span>&<span class="hljs-attribute">version=</span><span class="hljs-literal">2592.123</span>&<span class="hljs-attribute">short_version=</span><span class="hljs-literal">30.0.2592.123</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ +]</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-list-get" class="action get"><h4 class="action-heading"><div class="name">Get versions</div><a href="#sparkle-version-version-list-get" class="method get">GET</a><code class="uri">/api/sparkle/version/</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version?<span class="hljs-attribute">app=</span><span class="hljs-literal">12</span>&<span class="hljs-attribute">channel=</span><span class="hljs-literal">2</span>&<span class="hljs-attribute">release_notes=</span><span class="hljs-literal">Release notes</span>&<span class="hljs-attribute">file=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">dsa_signature=</span><span class="hljs-literal">MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==</span>&<span class="hljs-attribute">version=</span><span class="hljs-literal">2592.123</span>&<span class="hljs-attribute">short_version=</span><span class="hljs-literal">30.0.2592.123</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">multipart/form-data</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"4444.0"</span></span>, @@ -284,7 +406,7 @@ "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span></span>, "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.019360Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.026884Z"</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-list-post" class="action post"><h4 class="action-heading"><div class="name">Create a Version</div><a href="#sparkle-version-version-list-post" class="method post">POST</a><code class="uri">/api/sparkle/version{?app,channel,release_notes,file,dsa_signature,version,short_version}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>app</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Application ID</p> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-list-post" class="action post"><h4 class="action-heading"><div class="name">Create a Version</div><a href="#sparkle-version-version-list-post" class="method post">POST</a><code class="uri">/api/sparkle/version{?app,channel,release_notes,file,dsa_signature,version,short_version}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>app</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>12</span></span><p>Application ID</p> </dd><dt>channel</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>2</span></span><p>Channel ID</p> </dd><dt>version</dt><dd><code>string</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>2592.123</span></span></dd><dt>short_version</dt><dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>30.0.2592.123</span></span></dd><dt>dsa_signature</dt><dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ==</span></span></dd><dt>release_notes</dt><dd><code>string</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>Release notes</span></span></dd><dt>file</dt><dd><code>file</code> <span class="required">(required)</span> </dd></dl></div></div></div><hr class="split"><div class="middle"><div id="sparkle-version-version" class="resource"><h3 class="resource-heading">Version <a href="#sparkle-version-version" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>, @@ -298,7 +420,47 @@ "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span></span>, "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.019360Z"</span></span>, "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.026884Z"</span> -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Version</div><a href="#sparkle-version-version-get" class="method get">GET</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Version</div><a href="#sparkle-version-version-delete" class="method delete">DELETE</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="symbols" class="resource-group"><h2 class="group-heading">Symbols <a href="#symbols" class="permalink">¶</a></h2></section></div><div class="middle"><div id="symbols-symbols-list" class="resource"><h3 class="resource-heading">Symbols List <a href="#symbols-symbols-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/symbols</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Version</div><a href="#sparkle-version-version-get" class="method get">GET</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method patch">PATCH</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"4444.0"</span></span>, + "<span class="hljs-attribute">short_version</span>": <span class="hljs-value"><span class="hljs-string">"41.0.4444.0"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">"<p>Version 41.0.4444.0 is out now</p>"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"{FILE}"</span></span>, + "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"4444.0"</span></span>, + "<span class="hljs-attribute">short_version</span>": <span class="hljs-value"><span class="hljs-string">"41.0.4444.0"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">"<p>Version 41.0.4444.0 is out now</p>"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"https://example.com/sparkle/Installer/stable/Chromium-41.0.4444.0.dmg"</span></span>, + "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">66243223</span></span>, + "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span></span>, + "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.019360Z"</span></span>, + "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.026884Z"</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-patch" class="action patch"><h4 class="action-heading"><div class="name">Patch a Version</div><a href="#sparkle-version-version-patch" class="method patch">PATCH</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"4444.0"</span></span>, + "<span class="hljs-attribute">short_version</span>": <span class="hljs-value"><span class="hljs-string">"41.0.4444.0"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">"<p>Version 41.0.4444.0 is out now</p>"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"{FILE}"</span></span>, + "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>, + "<span class="hljs-attribute">app</span>": <span class="hljs-value"><span class="hljs-string">"{43C257D5-533D-462C-8166-E276519687DE}"</span></span>, + "<span class="hljs-attribute">channel</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>, + "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"4444.0"</span></span>, + "<span class="hljs-attribute">short_version</span>": <span class="hljs-value"><span class="hljs-string">"41.0.4444.0"</span></span>, + "<span class="hljs-attribute">release_notes</span>": <span class="hljs-value"><span class="hljs-string">"<p>Version 41.0.4444.0 is out now</p>"</span></span>, + "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"https://example.com/sparkle/Installer/stable/Chromium-41.0.4444.0.dmg"</span></span>, + "<span class="hljs-attribute">file_size</span>": <span class="hljs-value"><span class="hljs-number">66243223</span></span>, + "<span class="hljs-attribute">dsa_signature</span>": <span class="hljs-value"><span class="hljs-string">"MCwCFFjHuSSd/QKCuIJsl7T2GDQd1NeZAhRqnZqXoFdpbfzyaE772N0TISwFzQ=="</span></span>, + "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.019360Z"</span></span>, + "<span class="hljs-attribute">modified</span>": <span class="hljs-value"><span class="hljs-string">"2015-01-14T10:50:56.026884Z"</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-put" class="action put"><h4 class="action-heading"><div class="name">Update a Version</div><a href="#sparkle-version-version-put" class="method put">PUT</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname"></span>/api/sparkle/version/<span class="hljs-attribute" title="id">42</span>/</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="sparkle-version-version-delete" class="action delete"><h4 class="action-heading"><div class="name">Remove a Version</div><a href="#sparkle-version-version-delete" class="method delete">DELETE</a><code class="uri">/api/sparkle/version/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><section id="symbols" class="resource-group"><h2 class="group-heading">Symbols <a href="#symbols" class="permalink">¶</a></h2></section></div><div class="middle"><div id="symbols-symbols-list" class="resource"><h3 class="resource-heading">Symbols List <a href="#symbols-symbols-list" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname"></span>/api/symbols</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</span></code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[ { "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">file</span>": <span class="hljs-value"><span class="hljs-string">"https://example.com/symbols/BreakpadTestApp.pdb/C1C0FA629EAA4B4D9DD2ADE270A231CC1/BreakpadTestApp.sym"</span></span>, @@ -1251,7 +1413,7 @@ "<span class="hljs-attribute">user_email</span>": <span class="hljs-value"><span class="hljs-string">""</span> </span>} </span>} -</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="feedbacks-feedback-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Feedback</div><a href="#feedbacks-feedback-get" class="method get">GET</a><code class="uri">/api/feedback/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><p style="text-align: center;" class="text-muted">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 10 Jun 2016</p></div></div></div></div><script>/* eslint-env browser */ +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="feedbacks-feedback-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Feedback</div><a href="#feedbacks-feedback-get" class="method get">GET</a><code class="uri">/api/feedback/{id}/</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>42</span></span></dd></dl></div></div></div><hr class="split"><div class="middle"><p style="text-align: center;" class="text-muted">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 11 Oct 2016</p></div></div></div></div><script>/* eslint-env browser */ /* eslint quotes: [2, "single"] */ 'use strict'; |