components

Uploads or updates the source file for a release.

Uploads or updates the source file for a specific release. This allows Marketplace component publishers to provide the component package and to transition the release from Draft or Declined to InReview or Published.

Authorization: The user must have access to manage the component. The user is a developer of the component and meets user group rules.

Validation:

  • A release with the given releaseId must exist in Marketplace.
  • The release must be in Draft or Declined. Cannot update the source file if it is already in InReview or Published.
  • The source file is validated (for example, widget validation, file name extension validation).

State Transition: After a successful upload, the release transitions to one of the following states:

  • Draft
    • If the publishManually field was set to true when the release was created.
  • InReview
    • Mendix Admin approval is required (for private components) or
    • A security scan is required (for public components).
  • Published
    • Mendix Admin approval is not required (for private components) and
    • A security scan is not required.

A release in the InReview state is automatically published to Marketplace and transitions to Published once all required review conditions have been satisfied.

Supported File Types:

  • For platform-supported components and private components, any file type.
  • For non-platform-supported components and public components, only the following file types are supported:
    • .mpk - Mendix Package file
    • .mxmodule - Mendix Module file
    • .mxsolution - Mendix Solution file
put/releases/{releaseId}/source-file

Request

  • Base URL
    https://marketplace-api.mendix.com/v1
  • Auth
    API key in header Authorization

Path parameters

releaseIdstring uuid required

This is the UUID of the release.

Headers

file-namestring required
Example:MyComponent.mpk

The name of the source file being uploaded, including the file extension (for example, 'MyWidget.mpk', 'MyModule.mxmodule'). Supported extensions are .mpk, .mxmodule, .mxsolution.

Request body application/octet-stream

string binary required

Response

The source file was successfully uploaded and the release is now in InReview or Published.

Changes

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