MEmendix
apps

Get an app

Get information about a single app. This API call does not return the same results as you can see within the Mendix Portal. It includes all licensed and free apps on the Mendix Cloud. Free apps include all apps which have been created or edited in Studio Pro, even if they have then been deployed to a different cloud such as Mendix for Private Cloud.

get/apps/{appId}

Request

  • Base URL
    https://cloud.home.mendix.com/api/v4
  • Auth
    API key in header Authorization

Response

OK

idstring uuid required

The unique App ID of the app. This can be seen on the General page of the app in the Mendix Portal. It is a UUID format.

namestring required

The name of the app.

licenseType'free' | 'licensed' required

The type of license. Free apps are created directly from Studio (Pro).

subdomainstring required

The environment URLs are based on this value. It is set when the app is created and cannot be changed. The value is unique in the Mendix Cloud.

regionstring required

The region or cluster where the app's environments are running.

Example response

{
  "id": "c533ee0b-f7db-4e62-868b-1192d392ccec",
  "name": "My fabulous app",
  "subdomain": "myfabulousapp",
  "technicalContact": {
    "userId": "jane.doe@domain.tld",
    "name": "Jane Doe"
  },
  "region": "prod2-eu-central-1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.