Deploy API – Version 2
1 Introduction
The Deploy API allows you to manage application environments in Mendix Cloud. Version 2 introduces improved APIs for some actions.
2 Authentication
The Deploy API requires authentication via API keys, as discussed in the Authentication section of Deploy API v1.
3 API Calls
3.1 Upload Package
3.1.1 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.
|
|
3.1.2 Request
3.1.2.1 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)
3.1.2.2 Example Request
|
|
Curl example:
|
|
3.1.3 Output
The API call returns the following JSON:
|
|
Where:
<packageID>
is the ID of the package which will be created by the API<JobID>
is the ID of the job that is creating the package — the status of the job can be interrogated with the Job Status API
3.2 Job Status
3.2.1 Description
Find the status of a job using the JobID
returned from an API call.
|
|
3.2.2 Request
3.2.2.1 Request Parameters
- AppId (String): Subdomain name of an app
- JobID (String): the ID of a job that was triggered by a previous API call
3.2.2.2 Example Request
|
|
3.2.3 Output
The API call returns the following JSON:
|
|
Where <status>
is one of the following:
- Queued
- Running
- Completed
- Failed
Feedback
Was this page helpful?
Glad to hear it! Thank you for your response.
Sorry to hear that. Please tell us how we can improve.