Deploy API – Version 1

Introduction

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.

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:

Authentication

The Deploy API v1 requires authentication via API keys that are bound to your Mendix account.

Obtaining an API Key

To obtain a Mendix API key, follow the instructions in the API Keys section of Mendix Profile.

Using Authentication Headers

Use the following request headers to authenticate an API call:

• Mendix-Username – the login name of the requesting user with the required privileges in the Mendix Platform
• Mendix-ApiKey – the API key of this user

Configuring Permissions

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, API access must be explicitly allowed for team members who want to use the Deploy API.

To perform an action via the Deploy API, such as transporting a new deployment package, you need API Rights and Transport Rights permissions. This can be configured from the Permissions tab of your app's Environments page.

API Calls

Retrieve Apps

Description

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.

HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps

Request

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

Output

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): Mendix 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"
}]

Create Free App Environment

Description

Creates a Free App for a requested project ID.

HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps

Request

Request Parameter

An object with the following key-value pair:

• ProjectId (String) : The Mendix Portal project identifier that should be linked to the new Free App. You can find this on the General tab of the Settings page of your app.

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"
}

Output

Response object with the following fields:

• AppId (String): Sub-domain name of the app.
• Name (String): Name of the app.
• ProjectId (String): Mendix Portal Project identifier.
• Url (String): Production or Free App URL to access your app.

Error Codes

Example Output

{
    "Name": "Calculation App",
    "Url": "https://calc.mendixcloud.com",
    "ProjectId": "fae5de74-69c2-4488-a4de-abf89daac63e",
    "AppId": "calc"
}

Retrieve App

Description

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>

Request

Request Parameter

• AppId (String): Sub-domain name of an app.

Example Request

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

Output

Object with the following key-value pairs:

• AppId (String): Sub-domain name of the app.
• ProjectId (String): Mendix Portal Project identifier.
• Name (String): Name of the app.
• Url (String): Production or Free App URL to access your app.

Error Codes

Example Output

{
    "AppId": "calc",
    "ProjectId": "543857rfds-dfsfsd12c5e24-3224d32eg",
    "Url": "https://calc.mendixcloud.com",
    "Name": "Calculation App"
}

Retrieve Environments

Description

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

Request

Request Parameter

• AppId (String): Subdomain name of an app.

Example Request

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

Output

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.

Example Output

[
    {
        "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
    }
]

Retrieve Environment

Description

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>

Request

Request Parameters

• AppId (String): Subdomain name of an app.
• Mode (String): The mode of the environment of the app. An environment with this mode should exist.

Example Request

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

Output

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.

Error Codes

Example Output

{
     "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
}

Start Environment

Description

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

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
}

Output

An object with the following key-value pairs:

• JobId (String): The identifier that can be used to track the progress of the start action

Error Codes

Example Output

{
     "JobId" :  "02df2e50-0e79-11e4-9191-0800200c9a66" ,
}

Get Start Environment Status

Description

Retrieve the status of the start environment action.

HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/start/<JobId>

Request

Example Request

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

Output

An object with the following key-value pair:

• Status (String): Possible values are Starting and Started

Error Codes

Example Output

{
     "Status" :  "Starting" ,
}

Stop Environment

Description

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

Request

Example Request

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

Output

Error Codes

Retrieve Environment Package

Description

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>

Request

Request Parameters

• 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.

Example Request

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

Output

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).

Error Codes

Example Output

{
    "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
    }
}

Upload Package

Description

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>

Request

Request Parameters

• 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)

Example Request

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"

Output

Error Codes

Transport a Deployment Package to an Environment

Description

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

Request

Request Parameters

• 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

Example Request

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"
}

Output

Error Codes

Clean environment

Description

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

Request

Request Parameters

• 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.

Example Request

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

Output

Error Codes

Example Output

[
    {
        "Status": "Stopped",
        "Mode": "Acceptance",
        "Url" : "https://calc-accp.mendixcloud.com"
    }
]

Retrieve Environment Settings

Description

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

Request

Request Parameters

• 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.

Example Request

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

Output

Error Codes

Example Output

{
     "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"
     }]
}

Set Environment Settings

Description

Changes the values of existing environment settings, such as custom runtime settings, constants, and scheduled events. These changes are applied after restarting the environment.

HTTP Method: POST
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/settings

Request

Request Parameters

• 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

Example Request

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"
     }]
}

Output

Error Codes

Example Output

{
     "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 Environments

Description

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

Request

Request Parameters

• 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.

Example Request

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,
}

Output

Error Codes

Example Output

{
    "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"
}

Create Environment Tags

Description

Tags are arbitrary strings that are not interpreted by the Mendix 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

Request

Request Parameters

• 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.

Example Request

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"
}

Output

Error Codes

Example Output

{
    "Tag": "A"
}

Retrieve Environment Tags

Description

Gets current values of environment tags.

HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/tags

Request

Request Parameters

• 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.

Example Request

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

Output

Error Codes

Example Output

{
    "Tag": "A"
}

Delete Environment Tags

Description

Deletes the current value of environment tags.

HTTP Method: DELETE
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/tags

Request

Request Parameters

• 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.

Example Request

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"
}

Output

Response Code

Error Code

Example Output

[]

Download App Logs for a Specific Date

Description

Downloads app logs for a specific date.

HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/logs/<Date>

Request

Request Parameters

• 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.

Example Request

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

Output

Error Codes

Example Output

{
    "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"
}

Download Access Logs

Description

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>

Request

Request Parameters

• 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.

Example Request

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

Output

Error Codes

Example Output

{
    "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"
}

Read More

• How To Implement a Simple CI/CD Pipeline with Mendix APIs