Create mobile app

A successful request to this endpoint creates a mobile app with the specified metadata.

Request

This request uses the GET method, which is used to retrieve detailed information about a specific mobile app.

For basic authorization, replace this with your username and password (or API key) in the header request in the username:password or username:api_key format. Your user credentials are combined to form a Base64 encoded string.

You need to provide the following required query parameters:

  • id: The unique identifier of the mobile app. This can be found in your system or provided by the app's management interface.

Response

The response returns detailed information about a specific mobile app, including metadata, upload status, size, and more.

See the following example:

{
  "id": "b3f3c0a0-0f5a-4f4a-8f4a-0b9e4b0f4a0f",
  "organizationId": "1234",
  "name": "Katalon Demo App",
  "platform": "ANDROID",
  "universalAppId": "com.katalon.app.ios, com.katalon.app.android",
  "status": "NEW",
  "size": 123456,
  "description": "This is a demo app",
  "storagePath": "string",
  "reason": "App size is too big",
  "uploadedDate": "2022-03-10T16:15:50.000Z",
  "metadata": {
    "appId": "com.katalon.app",
    "identifier": "com.katalon.app",
    "name": "Katalon Demo App",
    "version": "1.0.0",
    "versionCode": "1",
    "minSdk": 11,
    "targetSdk": 15
  },
  "createdDate": "2022-03-10T12:15:50.000Z",
  "updatedDate": "2022-03-10T12:15:50.000Z",
  "fileName": "KatalonDemoApp.apk"
}

Refer to the following table about the response body properties:

PropertyTypeDescription
idStringThe unique identifier for the mobile app.
organizationIdStringThe identifier for the organization that owns the app.
nameStringThe name of the mobile app.
platformStringThe platform of the mobile app (e.g., ANDROID, IOS).
universalAppIdStringA comma-separated list of identifiers for the app on different platforms (e.g., Android and iOS).
statusStringThe current status of the app (e.g., NEW, UPLOADED).
sizeIntegerThe size of the mobile app file in bytes.
descriptionStringA description of the app.
storagePathStringThe path where the app file is stored.
reasonStringThe reason for the app's current status (e.g., App size is too big).
uploadedDateStringThe date and time when the app was uploaded.
metadataObjectMetadata for the app, containing detailed version and SDK information.
createdDateStringThe date and time when the app was created in the system.
updatedDateStringThe date and time when the app was last updated in the system.
fileNameStringThe name of the app file (e.g., KatalonDemoApp.apk).

Try it!

  1. Enter the required (and optional, if applicable) fields below.
  2. Select the language in Language.
  3. Enter your user name or API credentials.
  4. Review your API call and click Try it!
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!