{"_id":"56d1f33f00a2a70b00b365ec","user":"5526ca4cf69851170038b496","__v":2,"category":{"_id":"56d1f33900a2a70b00b36598","pages":["56d1f33f00a2a70b00b365e9","56d1f33f00a2a70b00b365ea","56d1f33f00a2a70b00b365eb","56d1f33f00a2a70b00b365ec","56d1f33f00a2a70b00b365ed"],"project":"5526c95cf69851170038b48f","__v":1,"version":"56d1f33700a2a70b00b3658e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-20T16:08:19.335Z","from_sync":false,"order":7,"slug":"rest-api","title":"API"},"project":"5526c95cf69851170038b48f","parentDoc":null,"version":{"_id":"56d1f33700a2a70b00b3658e","project":"5526c95cf69851170038b48f","__v":2,"createdAt":"2016-02-27T19:04:23.946Z","releaseDate":"2016-02-27T19:04:23.946Z","categories":["56d1f33900a2a70b00b3658f","56d1f33900a2a70b00b36590","56d1f33900a2a70b00b36591","56d1f33900a2a70b00b36592","56d1f33900a2a70b00b36593","56d1f33900a2a70b00b36594","56d1f33900a2a70b00b36595","56d1f33900a2a70b00b36596","56d1f33900a2a70b00b36597","56d1f33900a2a70b00b36598","56d1f33900a2a70b00b36599","56d1f33900a2a70b00b3659a","571f9497ada30c34003b7cee"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta","version_clean":"2.0.0-beta","version":"2.0.0-beta"},"updates":["571402cf45e2090e001e5ca5"],"next":{"pages":[],"description":""},"createdAt":"2016-02-24T16:21:32.861Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"[block:html]\n{\n  \"html\": \"<style>\\n  .endpoint-spacer {\\n     height: 20px;\\n  }\\n  \\n  .endpoint {\\n    position: relative;\\n    padding: 10px 20px;\\n    color: #555;\\n    font-weight: bold;\\n    margin-bottom: 10px;\\n  }\\n  \\n  .endpoint.get {\\n    background-color: #E4FFDD;\\n  }\\n  \\n  .endpoint.put {\\n    background-color: #FFEFFA;\\n  }\\n  \\n  .endpoint.post {\\n    background-color: #EDF5FF;\\n  }\\n  \\n  .endpoint.patch {\\n    background-color: #FFEEC7;\\n  }\\n  \\n  .endpoint.delete {\\n    background-color: #FFE4E0;\\n  }\\n  \\n  .docs-content hr {\\n    border-top: 1px solid #eee;\\n    border-color: #eee;\\n    margin-bottom: 1px;\\n  }\\n  \\n  .docs-content p {\\n    margin-left: 20px;\\n  }\\n  \\n  .blocks-parent > div {\\n    margin-bottom: 0px;\\n  }\\n</style>\"\n}\n[/block]\n## Endpoints:\n\n**Channels:**\n\n* [List](#channels-list) channels\n* [Get](#channels-get) channel info\n* [Post](#channels-post) a new channel\n* [Edit](#channels-edit) a channel's data\n* [Delete](#channels-delete) a channel\n\n**Snapshots:**\n\n* [List](#snapshots-list) your recent snapshots (uploads)\n* [Get](#snapshots-get) snapshot info\n* [Edit](#snapshots-edit) a snapshot\n\n**Deploys:**\n\n* [List](#deploys-list) recent deploys and rollbacks\n* [Create](#deploys-post) a new deploy or rollback\n* [Delete](#deploys-delete) a deploy\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Channels\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-list\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/channels\\n</div>\"\n}\n[/block]\n**List the recent notifications you've sent**\n\n**Authentication Required:** Yes\n\n**Response:** A list of recent notifications.\n\n**Parameters:** None\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-get\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/channels/{uuid}\\n</div>\"\n}\n[/block]\n**Get information about a specific channel:**\n\n**Authentication Required:** Yes\n\n**Response:** Information about the channel.\n\n**Parameters:** \n\n* **uuid:** The notification's ID.\n\nSimilar: See the [get by tag](#channels-get-tag) endpoint.\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-get-tag\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/channels/{tag}\\n</div>\"\n}\n[/block]\n**Get information about a specific channel:**\n\n**Authentication Required:** Yes\n\n**Response:** Basic information about the channel.\n\n**Parameters:** \n\n* **tag:** The channel tag\n\nSimilar: See the [get by channel uuid](#channels-get) endpoint.\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-post\\\"></a>\\n<div class=\\\"endpoint post\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-post\\\">post</span> https://api.ionic.io/deploy/channels\\n</div>\"\n}\n[/block]\n**Create a new deploy channel:**\n\n**Authorization Required:** Yes\n\n**Response:** Channel\n\n**Parameters:**\n\n* **label:** The channel label\n* **tag:** (optional) The channel tag (attempts to create a tag from the label automatically if not passed)\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-edit\\\"></a>\\n<div class=\\\"endpoint patch\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-patch\\\">patch</span> https://api.ionic.io/deploy/channels/{uuid}\\n</div>\"\n}\n[/block]\n**Edit channel data:**\n\n**Authorization Required:** Yes\n\n**Response:** Channel\n\n**Parameters:**\n\n* **uuid:** The channel id\n* **label:** (optional) The channel label\n* **tag:** (optional) The channel tag\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"channels-delete\\\"></a>\\n<div class=\\\"endpoint delete\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-delete\\\">delete</span> https://api.ionic.io/deploy/channels/{uuid}\\n</div>\"\n}\n[/block]\n**Delete a deploy channel:**\n\n**Authorization Required:** Yes\n\n**Response:** Empty\n\n**Parameters:** None\n\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Snapshots\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"snapshots-list\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/snapshots\\n</div>\"\n}\n[/block]\n**List deploy snapshots**\n\n**Authentication Required:** Yes\n\n**Response:** A list of recent snapshots.\n\n**Parameters:** None\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"snapshots-get\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/snapshots/{uuid}\\n</div>\"\n}\n[/block]\n**Get information about a specific snapshot:**\n\n**Authentication Required:** Yes\n\n**Response:** Snapshot data\n\n**Parameters:** \n\n* **uuid:** The snapshot's ID.\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"snapshots-edit\\\"></a>\\n<div class=\\\"endpoint patch\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-patch\\\">patch</span> https://api.ionic.io/deploy/snapshots/{uuid}\\n</div>\"\n}\n[/block]\n**Edit snapshot data**\n\n**Authentication Required:** Yes\n\n**Response:** Snapshot data\n\n**Parameters:** \n\n* **note:** (optional) The snapshot note\n* **user_metadata** (JSON) (optional) Custom snapshot metadata\n* **android_version** (JSON) (optional) Android binary version data\n* **ios_version** (JSON) (optional) iOS binary version data\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Deploys\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"deploys-list\\\"></a>\\n<div class=\\\"endpoint get\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-get\\\">get</span> https://api.ionic.io/deploy/deploys\\n</div>\"\n}\n[/block]\n**List the recent deploy / rollback events**\n\n**Authentication Required:** Yes\n\n**Response:** A list of recent deploy and rollback events.\n\n**Parameters:**\n\n* **channel_id** Events are tied to channels, so a channel uuid must be passed.\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"deploys-post\\\"></a>\\n<div class=\\\"endpoint post\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-post\\\">post</span> https://api.ionic.io/deploy/deploys\\n</div>\"\n}\n[/block]\n**Deploy/rollback a snapshot to a deploy channel**\n\n**Authentication Required:** Yes\n\n**Response:** Deploy/rollback event\n\n**Parameters:** \n\n* **channel** The channel uuid to deploy to\n* **snapshot:** The snapshot uuid to set as the current deploy for the channel\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"deploys-delete\\\"></a>\\n<div class=\\\"endpoint delete\\\">\\n\\t<span class=\\\"pg-type-big pg-type type-delete\\\">delete</span> https://api.ionic.io/deploy/deploys/{uuid}\\n</div>\"\n}\n[/block]\n**Delete a deploy/rollback event. Removing the latest deploy/rollback event for a channel will not reset deploy to a state before anything was deployed, but rather, allow the previous event to become the new deploy.**\n\n**Authentication Required:** Yes\n\n**Response:** Confirmation\n\n**Parameters:** \n\n* **uuid:** The deploy/rollback event uuid","excerpt":"","slug":"api-deploy","type":"basic","title":"Deploy Endpoints"}
[block:html] { "html": "<style>\n .endpoint-spacer {\n height: 20px;\n }\n \n .endpoint {\n position: relative;\n padding: 10px 20px;\n color: #555;\n font-weight: bold;\n margin-bottom: 10px;\n }\n \n .endpoint.get {\n background-color: #E4FFDD;\n }\n \n .endpoint.put {\n background-color: #FFEFFA;\n }\n \n .endpoint.post {\n background-color: #EDF5FF;\n }\n \n .endpoint.patch {\n background-color: #FFEEC7;\n }\n \n .endpoint.delete {\n background-color: #FFE4E0;\n }\n \n .docs-content hr {\n border-top: 1px solid #eee;\n border-color: #eee;\n margin-bottom: 1px;\n }\n \n .docs-content p {\n margin-left: 20px;\n }\n \n .blocks-parent > div {\n margin-bottom: 0px;\n }\n</style>" } [/block] ## Endpoints: **Channels:** * [List](#channels-list) channels * [Get](#channels-get) channel info * [Post](#channels-post) a new channel * [Edit](#channels-edit) a channel's data * [Delete](#channels-delete) a channel **Snapshots:** * [List](#snapshots-list) your recent snapshots (uploads) * [Get](#snapshots-get) snapshot info * [Edit](#snapshots-edit) a snapshot **Deploys:** * [List](#deploys-list) recent deploys and rollbacks * [Create](#deploys-post) a new deploy or rollback * [Delete](#deploys-delete) a deploy [block:api-header] { "type": "basic", "title": "Channels" } [/block] [block:html] { "html": "<a name=\"channels-list\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/channels\n</div>" } [/block] **List the recent notifications you've sent** **Authentication Required:** Yes **Response:** A list of recent notifications. **Parameters:** None [block:html] { "html": "<a name=\"channels-get\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/channels/{uuid}\n</div>" } [/block] **Get information about a specific channel:** **Authentication Required:** Yes **Response:** Information about the channel. **Parameters:** * **uuid:** The notification's ID. Similar: See the [get by tag](#channels-get-tag) endpoint. [block:html] { "html": "<a name=\"channels-get-tag\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/channels/{tag}\n</div>" } [/block] **Get information about a specific channel:** **Authentication Required:** Yes **Response:** Basic information about the channel. **Parameters:** * **tag:** The channel tag Similar: See the [get by channel uuid](#channels-get) endpoint. [block:html] { "html": "<a name=\"channels-post\"></a>\n<div class=\"endpoint post\">\n\t<span class=\"pg-type-big pg-type type-post\">post</span> https://api.ionic.io/deploy/channels\n</div>" } [/block] **Create a new deploy channel:** **Authorization Required:** Yes **Response:** Channel **Parameters:** * **label:** The channel label * **tag:** (optional) The channel tag (attempts to create a tag from the label automatically if not passed) [block:html] { "html": "<a name=\"channels-edit\"></a>\n<div class=\"endpoint patch\">\n\t<span class=\"pg-type-big pg-type type-patch\">patch</span> https://api.ionic.io/deploy/channels/{uuid}\n</div>" } [/block] **Edit channel data:** **Authorization Required:** Yes **Response:** Channel **Parameters:** * **uuid:** The channel id * **label:** (optional) The channel label * **tag:** (optional) The channel tag [block:html] { "html": "<a name=\"channels-delete\"></a>\n<div class=\"endpoint delete\">\n\t<span class=\"pg-type-big pg-type type-delete\">delete</span> https://api.ionic.io/deploy/channels/{uuid}\n</div>" } [/block] **Delete a deploy channel:** **Authorization Required:** Yes **Response:** Empty **Parameters:** None [block:api-header] { "type": "basic", "title": "Snapshots" } [/block] [block:html] { "html": "<a name=\"snapshots-list\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/snapshots\n</div>" } [/block] **List deploy snapshots** **Authentication Required:** Yes **Response:** A list of recent snapshots. **Parameters:** None [block:html] { "html": "<a name=\"snapshots-get\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/snapshots/{uuid}\n</div>" } [/block] **Get information about a specific snapshot:** **Authentication Required:** Yes **Response:** Snapshot data **Parameters:** * **uuid:** The snapshot's ID. [block:html] { "html": "<a name=\"snapshots-edit\"></a>\n<div class=\"endpoint patch\">\n\t<span class=\"pg-type-big pg-type type-patch\">patch</span> https://api.ionic.io/deploy/snapshots/{uuid}\n</div>" } [/block] **Edit snapshot data** **Authentication Required:** Yes **Response:** Snapshot data **Parameters:** * **note:** (optional) The snapshot note * **user_metadata** (JSON) (optional) Custom snapshot metadata * **android_version** (JSON) (optional) Android binary version data * **ios_version** (JSON) (optional) iOS binary version data [block:api-header] { "type": "basic", "title": "Deploys" } [/block] [block:html] { "html": "<a name=\"deploys-list\"></a>\n<div class=\"endpoint get\">\n\t<span class=\"pg-type-big pg-type type-get\">get</span> https://api.ionic.io/deploy/deploys\n</div>" } [/block] **List the recent deploy / rollback events** **Authentication Required:** Yes **Response:** A list of recent deploy and rollback events. **Parameters:** * **channel_id** Events are tied to channels, so a channel uuid must be passed. [block:html] { "html": "<a name=\"deploys-post\"></a>\n<div class=\"endpoint post\">\n\t<span class=\"pg-type-big pg-type type-post\">post</span> https://api.ionic.io/deploy/deploys\n</div>" } [/block] **Deploy/rollback a snapshot to a deploy channel** **Authentication Required:** Yes **Response:** Deploy/rollback event **Parameters:** * **channel** The channel uuid to deploy to * **snapshot:** The snapshot uuid to set as the current deploy for the channel [block:html] { "html": "<a name=\"deploys-delete\"></a>\n<div class=\"endpoint delete\">\n\t<span class=\"pg-type-big pg-type type-delete\">delete</span> https://api.ionic.io/deploy/deploys/{uuid}\n</div>" } [/block] **Delete a deploy/rollback event. Removing the latest deploy/rollback event for a channel will not reset deploy to a state before anything was deployed, but rather, allow the previous event to become the new deploy.** **Authentication Required:** Yes **Response:** Confirmation **Parameters:** * **uuid:** The deploy/rollback event uuid