Rest API

This is the documentation for the Updraft REST API.

About

This API allows the developer to access and interact with Updraft data remotely.

Getting started

Getting started with the REST API of Updraft is easy, and can be done via the command line interface.

The user authentication token is required for all requests below.

get
Get list of Apps

https://mydomain.getupdraft.com/api/applications/?title=&org=13
This endpoint allows you to get a list of apps within your organization.
Request
Response
Request
Path Parameters
Org
required
string
Organisation id
Headers
Authentication
required
string
Authentication token
Response
200: OK
Cake successfully retrieved.
{
"id": 1687,
"project_title": "title",
"ipa_app": 1716,
"apk_app": 1705,
"first_app_id": 1705,
"env_details": [{
"id": 1705,
"environment": "Staging",
"app_type": 0,
"title": "title"
}, {
"id": 1706,
"environment": "Production",
"app_type": 0,
"title": "title"
}, {
"id": 1707,
"environment": "Store",
"app_type": 0,
"title": "title"
}, {
"id": 1716,
"environment": "Staging",
"app_type": 1,
"title": "title"
}, {
"id": 1743,
"environment": "Production",
"app_type": 1,
"title": "title"
}],
"icon": "/media/icon/2020-01-14%2009%3A52%3A20.781544__ic_launcher.png",
"user_detail": [{
"user_id": 602,
"username": "email",
"first_name": "test",
"last_name": "test"
}],
"users": [602]

get
Get list of Users

https://mydomain.getupdraft.com/api/profiles/
This endpoint allows you to get a list of users within your organization.
Request
Response
Request
Headers
Authentication
required
string
Authentication token
Response
200: OK
{
"user_id": 4,
"username": "username,
"first_name": "Max",
"last_name": "Cake",
"email": "email",
"profile": {
"is_subscribe": true,
"is_firstlogin": false,
"is_show_demotour": true,
"gender": null,
"sending_emails": false,
"enable_instruction": false,
"last_mobile": 1,
"last_whatsnew": 5
}

delete
Delete an app version (build)

https://mydomain.getupdraft.com/api/versions/{id}
User can delete an already uploaded build from an application.
Request
Response
Request
Path Parameters
id
optional
integer
A unique integer value identifying your app version
Authentication
required
string
Authentication token
Response
200: OK