title | linktitle | url | category | description | weight | tags | |||||
---|---|---|---|---|---|---|---|---|---|---|---|
Deploy API – Version 1 |
Deploy API v1 |
/apidocs-mxsdk/apidocs/deploy-api/ |
API Documentation |
This API can be used to deploy Mendix apps to licensed nodes, manage application environments in Mendix Cloud, retrieve statuses, start and stop applications, and deploy or transport new model versions to application environments. |
40 |
|
{{% alert color="warning" %}} The Deploy API only works for apps that are deployed to Mendix Cloud. {{% /alert %}}
The Deploy API allows you to manage application environments in Mendix Cloud. You can retrieve the status of, and start and stop, applications. You can also configure new model versions and deploy them to application environments. To create and manage deployment packages, you also need the Build API. For backup-related actions, refer to the Backups API.
{{% alert color="info" %}} The v1 Deploy API only supports the endpoints listed here. For all other deployment API calls, use the v2 API or v4 API. {{% /alert %}}
{{% alert color="info" %}}
Mendix recommends using calls from the same version of the API where possible. This is because the naming varies across versions. For example, the {appId}
in the version 4 API is retrieved as the {ProjectId}
from the version 1 API.
{{% /alert %}}
You can use webhooks to trigger CI/CD pipelines that use this API. These are described in Webhooks.
This image provides a domain model representation of the concepts discussed below and how these are related:
{{< figure src="/attachments/apidocs-mxsdk/apidocs/build-api/api-model.png" class="no-border" >}}
The Deploy API requires authentication via API keys that are bound to your Mendix account.
Because APIs are designed for automated systems, the Deploy API does not require two-factor authentication, which is normally required to make changes to production environments. This is a potential security risk. Therefore, the Technical Contact of an application needs to allow API access explicitly for team members who want to use the Deploy API. This can be configured from the Node Security screen under App Settings. By default, API access is already enabled for test and acceptance environments for all team members. To perform an action via the Deploy API, such as transporting a new deployment package, both the Transport and API Access permissions need to be enabled.
{{% alert color="info" %}} Only Retrieve apps, Create Free App environment, and Retrieve app API calls are supported for Free Apps. Please note that most API calls—with the exception of Upload Package—require that the Content-Type header be set to application/json. {{% /alert %}}
Retrieves all apps to which the authenticated user has access as a regular user that have environments created on Mendix Cloud. This includes all licensed apps and any Free Apps that have been deployed.
{{% alert color="info" %}} This API call does not return the same results as you can see within the Developer Portal. It includes all licensed and free apps on Mendix Cloud. Free apps include all apps that 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.
In the Developer Portal:
-
The Nodes screen in the Developer Portal shows all the licensed apps which are returned by this request, but does not show any Free Apps.
-
The My Apps screen shows both licensed apps and Free Apps, but also includes apps that are deployed to other platforms (such as Mendix for Private Cloud or SAP BTP) and Free Apps that have not yet been deployed and therefore have no environments set up for them. {{% /alert %}}
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps
Example Request
GET /api/1/apps
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
List of objects with the following key-value pairs:
- AppId (String): Sub-domain name of the app.
- Name (String): Name of the app.
- ProjectId (String): Developer Portal Project identifier.
- Url (String): Production or Free App URL to access your app.
Example Output
[{
"Name": "Calculation App",
"Url": "https://calc.mendixcloud.com",
"ProjectId": "fae5de74-69c2-4488-a4de-abf89daac63e",
"AppId": "calc"
},{
"Name": "Tic Tac Toc",
"Url": "https://tictactoc.mendixcloud.com",
"ProjectId": "f5129445-b638-42f4-8108-5f370c85dc57",
"AppId": "tictactoc"
}]
Creates a Free App for a requested project ID.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps
Request Parameter
An object with the following key-value pair:
- ProjectId (String) : The Developer Portal project identifier that should be linked to the new Free App. This value can be found on the General tab of the Settings page of your app, and it is represented as App ID.
Example Request
POST /api/1/apps
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"ProjectId" : "f5129445-b638-42f4-8108-5f370c85dc57"
}
Response object with the following fields:
- AppId (String): Sub-domain name of the app.
- Name (String): Name of the app.
- ProjectId (String): Developer Portal Project identifier.
- Url (String): Production or Free App URL to access your app.
Error Codes
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PROJECTID | Invalid ProjectId |
400 | APPLICATION_ALREADY_EXISTS | Application already exists |
Example Output
{
"Name": "Calculation App",
"Url": "https://calc.mendixcloud.com",
"ProjectId": "fae5de74-69c2-4488-a4de-abf89daac63e",
"AppId": "calc"
}
Retrieves a specific app to which the authenticated user has access as a regular user. This app can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>
- AppId (String): Sub-domain name of an app.
GET /api/1/apps/calc
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
Object with the following key-value pairs:
- AppId (String): Sub-domain name of the app.
- ProjectId (String): Developer Portal Project identifier.
- Name (String): Name of the app.
- Url (String): Production or Free App URL to access your app.
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_APPID | Invalid AppId |
404 | APP_NOT_FOUND | App not found |
{
"AppId": "calc",
"ProjectId": "543857rfds-dfsfsd12c5e24-3224d32eg",
"Url": "https://calc.mendixcloud.com",
"Name": "Calculation App"
}
Retrieves all environments that are connected to a specific app to which the authenticated user has access as a regular user. These environments can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments
- AppId (String): Subdomain name of an app.
GET /api/1/apps/calc/environments
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
List of objects with the following key-value pairs:
- Status (String): Status of the environment. Possible values: Empty, Stopped, Running.
- EnvironmentId (String): Unique identifier of the environment.
- Url (String): URL to access your application.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a flexible environment.
- ModelVersion (String): The version number of the package deployed in your environment.
- MendixVersion (String): The Mendix version number of the package deployed in your environment.
- Production (Boolean): A flag indicating if this environment is a production environment.
[
{
"Status" : "Stopped" ,
"EnvironmentId" : "cd5fc610-edb0-43c5-a374-0439a6411ace",
"Mode" : "Acceptance",
"Url" : "https://calc-accp.mendixcloud.com",
"ModelVersion" : "1.1.0.253",
"MendixVersion" : "6.10.10",
"Production" : false
},
{
"Status" : "Stopped" ,
"EnvironmentId" : "867c9f56-84ec-438b-b1ae-9f9c50377cba",
"Mode" : "Production",
"Url" : "https://calc.mendixcloud.com",
"ModelVersion" : "175.0.0.3702",
"MendixVersion" : "6.10.12",
"Production" : false
}
]
Retrieves a specific environment that is connected to a specific app to which the authenticated user has access as a regular user. These environments can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>
- AppId (String): Subdomain name of an app.
- Mode (String): The mode of the environment of the app. An environment with this mode should exist.
GET /api/1/apps/calc/environments/Acceptance
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
An object with the following key-value pairs:
- Status (String): Status of the environment. Possible values: Empty, Stopped, Running.
- EnvironmentId (String): Unique identifier of the environment.
- Url (String): URL to access your application.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a flexible environment.
- ModelVersion (String): The version number of the package deployed in your environment.
- MendixVersion (String): The Mendix version number of the package deployed in your environment.
- Production (Boolean): A flag indicating if this environment is a production environment.
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
{
"Status" : "Stopped" ,
"EnvironmentId" : "cd5fc610-edb0-43c5-a374-0439a6411ace",
"Mode" : "Acceptance",
"Url" : "https://calc-accp.mendixcloud.com",
"ModelVersion" : "1.1.0.253",
"MendixVersion" : "6.10.10",
"Production" : false
}
Starts a specific environment that is connected to a specific app to which the authenticated user has access as a regular user. These environments can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/start
Request Parameters
- AutoSyncDb (Boolean): Define whether the database should be synchronized automatically with the model during the start phase of the app.
Example Request
POST /api/1/apps/calc/environments/Acceptance/start
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"AutoSyncDb" : true
}
An object with the following key-value pairs:
- JobId (String): The identifier that can be used to track the progress of the start action
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_APPID | Invalid AppId |
404 | APP_NOT_FOUND | App not found |
500 | NO_MDA_HAS_BEEN_DEPLOYED | Cannot start app. There is no MDA deployed. |
500 | APP_ALREADY_HAS_A_STARTING_JOB | Cannot start app. There is already a starting job id found. |
500 | ALREADY_STARTED | Cannot start app. App is already running. |
{
"JobId" : "02df2e50-0e79-11e4-9191-0800200c9a66" ,
}
Retrieve the status of the start environment action.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/start/<JobId>
GET /api/1/apps/calc/environments/Acceptance/start/02df2e50-0e79-11e4-9191-0800200c9a66
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
An object with the following key-value pair:
- Status (String): Possible values are Starting and Started
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found |
404 | NO_SUCH_STARTJOB | Job not found. |
500 | NO_PACKAGE | Cannot start app. There should be a package configured for this environment. |
500 | ALREADY_LOCKED | Cannot start app. There is already a lock on this environment. |
500 | ALREADY_STARTED | Cannot start app. App is already running. |
500 | DB_SYNC_FAILED | Cannot start app. Synchronization of database failed. |
500 | INVALID_DB_STRUCTURE | Cannot start app. The database is out-of-sync with the model. Please set AutoSyncDb parameter to true to synchronize the database automatically on startup. |
500 | MISSING_CONSTANT | Cannot start app. Missing one or more constant values. |
500 | INSECURE_ADMIN_PASSWORD | Cannot start app. There is a user with administrator role with password '1'. This is not allowed. |
500 | STARTUP_ACTION_FAILED | Cannot start app. Startup action failed. |
500 | START_FAILED | Cannot start app: result (detail status) |
{
"Status" : "Starting" ,
}
Stops a specific environment that is connected to a specific app to which the authenticated user has access as a regular user. These environments can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/stop
POST /api/1/apps/calc/environments/Acceptance/stop
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found |
500 | STOP_FAILED | Cannot stop app: reason |
Retrieves the deployed package of a specific environment that is connected to a specific app to which the authenticated user has access as a regular user. These environments can be found via the "Nodes overview" screen in the Mendix Platform.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/package?url=<Boolean>
- AppId (String): Sub-domain name of an app.
- Mode (String): The mode of the environment of the app. An environment with this mode should exist.
- url (Boolean) (default: false): Indicates whether the API should return a URL pointing to the location of the package.
GET /api/1/apps/calc/environments/Acceptance/package?url=true
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
An object with the following key-value pairs:
-
PackageId (String): Unique identification of the package.
-
Name (String): Name of the package.
-
Description (String): Description of the package.
-
Version (String): Package version. This is also the name of the tag on the project teamserver.
-
Creator (String): Uploader or creator of this package.
-
CreationDate (Date): Date that the package became available in the portal. This can be the upload date or the date that a build was created in the portal.
-
Status (String): Status of the package. A package is ready to use if the status is 'Succeeded'. Possible values: Succeeded, Queued, Building, Uploading and Failed.
-
Size (Long): Size of the package in bytes.
-
Url (object): A JSON object containing the following:
- Location: The URL pointing to the package file.
- TTL: How long the URL is valid (in seconds).
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
404 | PACKAGE_NOT_FOUND | No package found for this environment |
{
"Status" : "Succeeded",
"CreationDate" : 1404990271835,
"ExpiryDate": null,
"Description" : "Add scientific mode" ,
"Version" : "2.5.4.63" ,
"Size" : 15342295,
"PackageId" : "b3d14e53-2654-4534-b374-9179a69ef3cf" ,
"Creator" : "Richard Ford" ,
"Name" : "Main line-2.5.4.63.mda",
"Url": {
"Location": "https://url/to/download/the/package/file",
"TTL": 900
}
}
{{% alert color="info" %}} When uploading large (>300 MB) packages, this API can time out. In this case, you should switch to the v2 version of this API. {{% /alert %}}
Uploads a deployment package from the local system to a specific app. This package can then be transported to a specific environment for deployment.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/packages/upload?name=<PackageName>
- AppId (String): Subdomain name of an app
- PackageName (String): The name given to the package (MDA) when it is uploaded; if this is omitted, it will be given the name default.mda
- file (File): Deployment package as multipart/form-data (see IETF RFC 7578: Returning Values from Forms: multipart/form-data)
POST /api/1/apps/calc/packages/upload?name=calc_1.0.0.45.mda
Host: deploy.mendix.com
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
Content-Type: multipart/form-data; boundary=MultipartBoundary
--MultipartBoundary
Content-Disposition: form-data;
@%USERPROFILE%/Documents/Mendix/calc-main/releases/calc_1.0.0.45.mda
--MultipartBoundary--
Curl example:
curl -v -F "file=@%USERPROFILE%/Documents/Mendix/calc-main/releases/calc_1.0.0.45.mda" -X POST -H "Mendix-Username: richard.ford51@example.com" -H "Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6" "https://deploy.mendix.com/api/1/apps/calc/packages/upload?name=calc_1.0.0.45.mda"
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_APPID | Invalid AppId. |
404 | APP_NOT_FOUND | App not found. |
500 | UPLOAD_COPY_FAILED | Failed to store the deployment package. |
500 | INVALID_PACKAGE | Failed to process the deployment package. |
Transports a specific deployment package to a specific environment. After the deployment package has been transported, it will not replace a currently running app automatically. You will need to stop and start the environment to activate the new package.
This call is not available for Free Apps. For a Free App, the Build API can be used to trigger a deployment.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/transport
- AppId (String): Sub-domain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
- PackageId (String): ID of the deployment package
POST /api/1/apps/calc/environments/acceptance/transport
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"PackageId" : "b3d14e53-2654-4534-b374-9179a69ef3cf"
}
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
400 | INVALID_RUNTIME_VERSION | This Runtime version is not supported on this environment. |
403 | NO_ACCESS | You do not have access |
403 | TRANSPORT_NOT_ALLOWED | No access to transport to environment 'mode'. |
403 | APP_IS_RUNNING | The 'mode' environment of 'app id' must be stopped to do transport. |
403 | NOT ALLOWED | Cannot transport - MDA processing failed, try uploading again with a valid MDA. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
404 | PACKAGE_NOT_FOUND | Package not found. |
500 | PACKAGE_PARSE_FAILED | Failed to parse deployment package file. |
503 | SERVICE UNAVAILABLE | Cannot transport - MDA is still being processed, retry later |
Removes all data from a specific environment: including files and database records. This action requires the environment to be in the status NotRunning.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/clean
- AppId (String): Sub-domain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
POST /api/1/apps/calc/environments/acceptance/clean
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
403 | ENVIRONMENT_NOT_STOPPED | Environment needs to be stopped. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
422 | ENVIRONMENT_NOT_DEPLOYED | No app deployed to the environment. |
500 | ENVIRONMENT_CLEAN_FAILED | Unable to clean the environment. Please contact Support. |
[
{
"Status": "Stopped",
"Mode": "Acceptance",
"Url" : "https://calc-accp.mendixcloud.com"
}
]
Gets the current values of custom runtime settings, constants, and scheduled events used by the target environment.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/settings
- AppId (String): Sub-domain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
GET /api/1/apps/calc/environments/acceptance/settings
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
{
"Constants" : [{
"Name" : "MyFirstModule.BooleanConstant" ,
"DataType" : "_Boolean" ,
"Value" : "false" ,
"DeployedValue" : "false"
},{
"Name" : "MyFirstModule.DateTime" ,
"DataType" : "DateTime" ,
"Value" : "2013-12-20T16:02:32" ,
"DeployedValue" : "2013-12-20T16:02:32"
}],
"CustomSettings" : [],
"ScheduledEvents" : [{
"Name" : "MyFirstModule.Monitor_Scheduled_event" ,
"DeployedValue" : "Disabled" ,
"Value" : "Disabled"
}]
}
Changes the values of existing environment settings, such as custom runtime settings, constants, and scheduled events. These changes are applied after restarting the environment.
{{% alert color="info" %}} This API cannot be used to set environment variables. {{% /alert %}}
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/settings
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
- Body: JSON collection retrieved with GET method at the same URI
POST /api/1/apps/calc/environments/acceptance/settings
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"Constants" : [{
"Name" : "MyFirstModule.BooleanConstant" ,
"DataType" : "_Boolean" ,
"Value" : "true" ,
"DeployedValue" : "false"
},{
"Name" : "MyFirstModule.DateTime" ,
"DataType" : "DateTime" ,
"Value" : "2013-12-20T16:02:32" ,
"DeployedValue" : "2013-12-20T16:02:32"
}],
"CustomSettings" : [],
"ScheduledEvents" : [{
"Name" : "MyFirstModule.Monitor_Scheduled_event" ,
"DeployedValue" : "Disabled" ,
"Value" : "Enabled"
}]
}
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters. |
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment. |
400 | CONSTANT_NOT_FOUND | Constant not found: constant name. |
400 | CUSTOM_SETTING_NOT_SUPPORTED | Custom setting not supported. |
400 | SCHEDULED_EVENT_NOT_FOUND | Scheduled Event not found: scheduled event name. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
500 | INVALID_SCHEDULED_EVENT_PARAMETER | Scheduled Event parameter should be Enabled or Disabled. |
{
"Constants" : [{
"Name" : "MyFirstModule.BooleanConstant" ,
"DataType" : "_Boolean" ,
"Value" : "true" ,
"DeployedValue" : "false"
},{
"Name" : "MyFirstModule.DateTime" ,
"DataType" : "DateTime" ,
"Value" : "2013-12-20T16:02:32" ,
"DeployedValue" : "2013-12-20T16:02:32"
}],
"CustomSettings" : [],
"ScheduledEvents" : [{
"Name" : "MyFirstModule.Monitor_Scheduled_event" ,
"DeployedValue" : "Disabled" ,
"Value" : "Enabled"
}]
}
Scale memory and instances of an environment. Only those environments that run a package that uses a supported version of the Mendix Runtime can spread the total memory over multiple instances.
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/scale
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
POST /api/1/apps/calc/environments/acceptance/scale/0c982ca3-621f-40e9-9c6e-96492934170a
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
Instances: 2,
MemoryPerInstance: 2048,
}
HTTP Status | Error code | Description |
---|---|---|
400 | INVALID_REQUEST | You have allocated more memory than is available under your plan. Please contact Support to upgrade your plan. |
400 | INVALID_REQUEST | Memory per instance cannot be smaller than 1024 MB. |
400 | NOT_ALLOWED | Horizontal scaling (to multiple instances) is only available for apps built with Mendix 7.0 or above. Please upgrade to activate this functionality. |
400 | NOT_ALLOWED | Scaling is only available for licensed apps using a supported version of Mendix. |
404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
{
"Status": "Running",
"Instances": 2,
"Mode": "Acceptance",
"Production": false,
"MemoryPerInstance": 2048,
"TotalMemory": 8192,
"ModelVersion": "1.1.0.253",
"MendixVersion": "7.5.0",
"Url": "https://calc.mendixcloud.com"
}
Tags are arbitrary strings that are not interpreted by the Developer Portal. Users are able to set tags on environments. Tags serve two purposes:
- Custom tags can be added to metrics (for Datadog)
- Tags can serve as selection criteria for grouping environments into a landscape management dashboard
HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/tags
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
POST /api/1/apps/calc/environments/acceptance/tags
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"Tag": "europe"
}
HTTP Status | Error code | Description |
---|---|---|
404 | NOT_FOUND | An App or Environment is not found. |
{
"Tag": "A"
}
Gets current values of environment tags.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/tags
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
GET /api/1/apps/calc/environments/acceptance/tags
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
404 | NOT FOUND | An App or Environment is not found. |
{
"Tag": "A"
}
Deletes the current value of environment tags.
HTTP Method: DELETE
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/tags
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
DELETE /api/1/apps/calc/environments/acceptance/tags
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
{
"Tag": "A"
}
HTTP Status | Error code | Description |
---|---|---|
204 | No Content | The tag has been removed or the response is empty or Tag not found |
HTTP Status | Error code | Description |
---|---|---|
404 | NOT FOUND | An App or Environment is not found. |
[]
Downloads app logs for a specific date.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/logs/<Date>
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
- Date (String): Date of the desired log in the format
YYYY-MM-DD
.
GET /api/1/apps/calc/environments/acceptance/logs/2018-08-10
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
404 | NOT FOUND | An App or Environment is not found. |
403 | FORBIDDEN | You do not have access |
{
"Environment": "38471410-861f-47e5-8efc-2f4b16f04005",
"Date": 1536451200000,
"DownloadUrl": "https://logsapi-prod-2-eu-central-1.mendix.com/v1/logs/38471410-861f-47e5-8efc-2f4b16f04005?endDate=2021-06-12&expire=20210616105139&startDate=2021-06-12&signature=0D5D1D81153BD12634AB03DD388259A416AE55479E8A8983CB9E3BD524183A041767262B9A9355BB48407ABFC98FD42094DDAB61005E558F0DA0441F4C0DFA3DAB38D03A9CF8F713C2187040669709848795BD5B32715F6917523BF08CA1DFD79479D5B2ADD8EDC116BAFB7AE952BB6FF0F68276AF349B9FA9B7D2CE9AE7BB6BA220BF50FD6ED93BFC1073BCF641FF0FCE48B75DFD74E2FC6C856495B1285348C1EA38EF9BB04E0BFEF60DFA32C1C856446B8ED2E9BF87C4EC1C7950CC97FDB38659603431E90FCCF6F1F977C3E668784AC03395E02088FFF15ABA056C03F0262D84D1ECC9D287B3B7020F7DA68AEC74D1360BF906101F2D727C19AD0D9C77EC"
}
Downloads a log of all the end-users who have started a session in the app on the selected date.
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/access-logs/<Date>
- AppId (String): Subdomain name of an app.
- Mode (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a flexible environment.
- Date (String): Date of the desired log in the format
YYYY-MM-DD
.
GET /api/1/apps/calc/environments/acceptance/access-logs/2021-06-12
Host: deploy.mendix.com
Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
HTTP Status | Error code | Description |
---|---|---|
404 | NOT FOUND | An App or Environment is not found. |
403 | FORBIDDEN | You do not have access |
{
"Environment": "38471410-861f-47e5-8efc-2f4b16f04005",
"Date": 1536451200000,
"DownloadUrl": "https://logsapi-prod-2-eu-central-1.mendix.com/v1/rtr-logs/38471410-861f-47e5-8efc-2f4b16f04005/2021-06-12?expire=20210616105139&signature=0D5D1D81153BD12634AB03DD388259A416AE55479E8A8983CB9E3BD524183A041767262B9A9355BB48407ABFC98FD42094DDAB61005E558F0DA0441F4C0DFA3DAB38D03A9CF8F713C2187040669709848795BD5B32715F6917523BF08CA1DFD79479D5B2ADD8EDC116BAFB7AE952BB6FF0F68276AF349B9FA9B7D2CE9AE7BB6BA220BF50FD6ED93BFC1073BCF641FF0FCE48B75DFD74E2FC6C856495B1285348C1EA38EF9BB04E0BFEF60DFA32C1C856446B8ED2E9BF87C4EC1C7950CC97FDB38659603431E90FCCF6F1F977C3E668784AC03395E02088FFF15ABA056C03F0262D84D1ECC9D287B3B7020F7DA68AEC74D1360BF906101F2D727C19AD0D9C77EC"
}