Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The Private Mendix Platform Build API allows you to manage app packages in Priva
* Download a specified package in SBOM format.
* Lock or unlock a specified package.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-build-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The Private Mendix Platform Deploy API allows you to manage environments in Priv
* Deploy a package or apply changes for a specified environment.
* Get a dashboard with all environments created for the application.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-deploy-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ The Private Mendix Platform Group API version 2 allows you to manage user groups
* Update the deployment purpose of cluster namespace.
* Remove cluster namespaces from the group.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform 2.7 and newer.

{{% alert color="info" %}}
For information about Group API version 1, see [Group API - Version 1](/apidocs-mxsdk/apidocs/private-platform-group-api/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The Private Mendix Platform Group API version 1 allows you to manage user groups
* Update group member roles.
* Add or remove members from a group.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

{{% alert color="info" %}}
For information about Group API version 2, see [Group API - Version 2](/apidocs-mxsdk/apidocs/private-platform-group-api-v2/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ The Private Mendix Platform Marketplace API allows you to manage the Marketplace
* Get a single subcategory by ID.
* Create, update, or delete a subcategory.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-marketplace-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The Private Mendix Platform Pipeline API version 2 allows you to manage pipeline
* Create and run a pipeline for build or deployment.
* Approve or reject a manual step of a waiting pipeline.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform 2.7 and newer.

{{% alert color="info" %}}
For information about Pipeline API version 1, see [Pipeline API - Version 1](/apidocs-mxsdk/apidocs/private-platform-pipeline-api/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The Private Mendix Platform Pipeline API version 1 allows you to manage pipeline
* Create a pipeline for build or deployment.
* Approve or reject a manual step of a waiting pipeline.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

{{% alert color="info" %}}
For information about Pipeline API version 2, see [Pipeline API - Version 2](/apidocs-mxsdk/apidocs/private-platform-pipeline-api-v2/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ The Private Mendix Platform Project API version 2 allows you to manage projects
* Get the groups or users with which the project is shared.
* Add or remove members and groups from a project.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform 2.7 and newer.

{{% alert color="info" %}}
For information about Project API version 1, see [Project API - Version 1](/apidocs-mxsdk/apidocs/private-platform-project-api/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ The Private Mendix Platform Project API version 1 allows you to manage projects
* Get all project team members.
* Add or remove members and groups from a project.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

{{% alert color="info" %}}
For information about Project API version 2, see [Project API - Version 2](/apidocs-mxsdk/apidocs/private-platform-project-api-v2/).
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ The Private Mendix Platform User API allows you to manage users in Private Mendi
* Create, update, or delete a user.
* Change the password of a user with a specific ID.

## Supported Private Mendix Platform Version

This API is available in Private Mendix Platform [VERSION] and newer.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-user-v1.yaml" >}}