Application

APIs for application management

List apps in enterprise

Returns Application list

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
application_name
string

filter by application name

package_name
string

filter by package name

package_name_exact
string

filter by package name (exact match)

has_uploaded_version
boolean

Returns applications having atleast one version uploaded

category
string

filter by category

supported_sdk
integer

filter by supported sdk versions

is_active
boolean

filter by active applications

is_hidden
boolean
Default: false

filter default esper apps

created_on_gt
string <datetime>

filter applications created after a given timestamp

created_on_lt
string <datetime>

filter applications created before a given timestamp

updated_on_gt
string <datetime>

filter applications updated after a given timestamp

updated_on_lt
string <datetime>

filter applications updated before a given timestamp

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

500

Internal server error

get/enterprise/{enterprise_id}/application/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get application information

Returns Application instance

Request
Security:
path Parameters
application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/enterprise/{enterprise_id}/application/{application_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "versions": [
    ],
  • "application_name": "string",
  • "package_name": "string",
  • "developer": "string",
  • "category": "string",
  • "content_rating": "string",
  • "compatibility": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "is_hidden": true,
  • "enterprise": "string"
}

Delete an application

Empty response

Request
Security:
path Parameters
application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

Responses
204

The resource was deleted successfully.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/enterprise/{enterprise_id}/application/{application_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

List App versions

Returns AppVersion list

Request
Security:
path Parameters
application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

query Parameters
version_code
string

filter by version code

build_number
string

filter by build number

is_g_play
boolean

filter google play applications

approval_status
string

filter by approval status

Enum: "AVAILABLE" "ACCEPTED" "APPROVED" "REJECTED"
is_enabled
boolean

filter by enabled versions

is_default
boolean

filter by default versions

created_on_gt
string <datetime>

filter applications created after a given timestamp

created_on_lt
string <datetime>

filter applications created before a given timestamp

updated_on_gt
string <datetime>

filter applications updated after a given timestamp

updated_on_lt
string <datetime>

filter applications updated before a given timestamp

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

ordering
string

Order result set by field name.

  • installed_count: order by asc
  • -installed_count: order by desc
Responses
200

successful operation

401

Authorization information is missing or invalid.

500

Internal server error

get/enterprise/{enterprise_id}/application/{application_id}/version/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get app version information

Returns AppVersion instance

Request
Security:
path Parameters
version_id
required
string <uuid>

A UUID string identifying this app version.

application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

query Parameters
request_id
string

If this value exists in cache, delete the application and cache entry.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "installed_count": 0,
  • "permissions": [
    ],
  • "app_file": "string",
  • "app_icon": "string",
  • "version_code": "string",
  • "build_number": "string",
  • "size_in_mb": 0,
  • "hash_string": "string",
  • "release_name": "string",
  • "release_comments": "string",
  • "release_track": "Alpha",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "min_sdk_version": "string",
  • "target_sdk_version": "string",
  • "is_enabled": true,
  • "is_default": true,
  • "enterprise": "string",
  • "application": "string",
  • "approval_status": "AVAILABLE"
}

Delete app version

Empty response

Request
Security:
path Parameters
version_id
required
string <uuid>

A UUID string identifying this app version.

application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

Responses
200

No request id is provided and the application is linked to one or more templates. Returns a request_id. Call with this request id to delete the resource.

204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/
Response samples
application/json
{
  • "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  • "templates": [
    ]
}

Patch an App version instance

Request
Security:
path Parameters
version_id
required
string <uuid>

A UUID string identifying this app version.

application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

Request Body schema: */*
release_name
string (Release name)

Name of the Release

release_comments
string (Release comments)

Additional comments about the release

release_track
string (Release track)

Description of the content

Enum: "Alpha" "Beta" "Production"
is_enabled
boolean (Is Enabled)

Is the app version enabled

min_sdk_version
string (Minimum SDK version)

Version number of minimum SDK version that supports this app version

target_sdk_version
string (Target SDK version)

Target SDK version that supports this app version

build_number
string (Build Number)

Build number of this app version

version_code
string (Version Code)

Verion code of this app version

approval_status
string (Approval Status)

Approval status of this app version

Enum: "AVAILABLE" "ACCEPTED" "APPROVED" "REJECTED"
is_default
boolean (Is default)

Is the app version default

Responses
200

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

patch/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "installed_count": 0,
  • "permissions": [
    ],
  • "app_file": "string",
  • "app_icon": "string",
  • "version_code": "string",
  • "build_number": "string",
  • "size_in_mb": 0,
  • "hash_string": "string",
  • "release_name": "string",
  • "release_comments": "string",
  • "release_track": "Alpha",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "min_sdk_version": "string",
  • "target_sdk_version": "string",
  • "is_enabled": true,
  • "is_default": true,
  • "enterprise": "string",
  • "application": "string",
  • "approval_status": "AVAILABLE"
}

List install devices

Returns list of devices with the specified app version installed

Request
Security:
path Parameters
version_id
required
string <uuid>

A UUID string identifying this app version.

application_id
required
string <uuid>

A UUID string identifying this application.

enterprise_id
required
string

A UUID string identifying enterprise.

query Parameters
search
string

A search term, search based on device name, device alias_name, group name

limit
integer

Number of results to return per page

offset
integer

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

get/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Upload an application to enterprise

Returns application

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema:
app_file
required
string <binary>

Valid APK file

Responses
201

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

415

Unsupported media type.

500

Internal server error

post/enterprise/{enterprise_id}/application/upload/
Response samples
application/json
{
  • "application": {
    }
}