Skip to content
Merged
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
@@ -0,0 +1,31 @@
---
title: "Private Mendix Platform Build API"
url: /apidocs-mxsdk/apidocs/private-platform-build-api/
type: swagger
description: "This API allows you to manage packages in Private Mendix Platform."
restapi: true
weight: 60
linktitle: "Build API"
---

{{% alert color="info" %}}
This document is about [Private Mendix Platform](/private-mendix-platform/) API. This API is only available on instances of Private Mendix Platform. For [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) API, see [Mendix on Kubernetes Build API](/apidocs-mxsdk/apidocs/private-cloud-build-api/) and [Mendix on Kubernetes Deploy API](/apidocs-mxsdk/apidocs/private-cloud-deploy-api/).
{{% /alert %}}

## Introduction

The Private Mendix Platform Build API allows you to manage app packages in Private Mendix Platform. You can use the API to do the following:

* Start the build pipeline to create an app package.
* Retrieve all packages for the application.
* Retrieve a specified package for the application.
* Delete a specified package for the application.
* Download a specified package in MDA format.
* Download a specified package in SBOM format.
* Lock or unlock a specified package.

## API Reference

### Version 1

{{< swaggerui src="/openapi-spec/openapi-build-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,18 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

## Introduction

The Private Mendix Platform Group API allows you to manage environments in Private Mendix Platform. You can use the API to do the following:
The Private Mendix Platform Deploy API allows you to manage environments in Private Mendix Platform. You can use the API to do the following:

* Create a new environment for the application
* Retrieve all environments for the application
* Retrieve a specified environment for the application
* Update a specified environment for the application
* Delete a specified environment for the application
* Create a new environment for the application.
* Retrieve all environments for the application.
* Retrieve a specified environment for the application.
* Update the configuration of a specified environment.
* Delete the configuration and settings of a specified environment.
* Deploy a package or apply changes for a specified environment.
* Get a dashboard with all environments created for the application.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-deploy.yaml" >}}
### Version 1

{{< swaggerui src="/openapi-spec/openapi-deploy-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,23 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

The Private Mendix Platform Group API allows you to manage user groups in Private Mendix Platform. You can use the API to do the following:

* Get a group by ID
* Get a list of all groups for the current user
* Create, update, or delete a group
* Retrieve a list of all users in a group
* Update group member roles
* Add or remove members from a group
* Get a group by ID.
* Get a list of all groups for the current user.
* Create, update, or delete a group.
* Retrieve a list of all users in a group.
* Update group member roles.
* Add or remove members from a group.
* Retrieve all cluster namespaces assigned to a group.
* Assign a cluster namespace to a group.
* Update the deployment purpose of cluster namespace.
* Remove cluster namespaces from the group.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-group.yaml" >}}
### Version 2

{{< swaggerui src="/openapi-spec/openapi-group-v2.yaml" >}}

### Version 1

{{< swaggerui src="/openapi-spec/openapi-group-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,24 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

The Private Mendix Platform Marketplace API allows you to manage the Marketplace in Private Mendix Platform. You can use the API to do the following:

* Retrieve all Marketplace content items
* Create a new Marketplace content item
* Get versions of an existing Marketplace content item
* Create a new version of an existing content item
* Get a single Marketplace content item by ID
* Update a content item
* Delete a Marketplace content that is not published
* Download a specific published content item
* Get a specific version of a Marketplace content item
* Change the owning user and group of a content item
* Get, add, delete, or input the groups of a content item
* Update, publish, retire, activate, or delete a specific version of a Marketplace content item
* Get all Marketplace categories
* Get a single subcategory by ID
* Create, update, or delete a subcategory
* Retrieve all Marketplace content items.
* Create a new Marketplace content item.
* Get versions of an existing Marketplace content item.
* Create a new version of an existing content item.
* Get a single Marketplace content item by ID.
* Update a content item.
* Delete a Marketplace content that is not published.
* Download a specific published content item.
* Get a specific version of a Marketplace content item.
* Change the owning user and group of a content item.
* Get, add, delete, or input the groups of a content item.
* Update, publish, retire, activate, or delete a specific version of a Marketplace content item.
* Get all Marketplace categories.
* Get a single subcategory by ID.
* Create, update, or delete a subcategory.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-marketplace.yaml" >}}
### Version 1

{{< swaggerui src="/openapi-spec/openapi-marketplace-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,16 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

The Private Mendix Platform Project API allows you to manage pipelines in Private Mendix Platform. You can use the API to do the following:

* Get pipeline running information.
* Set the current step status of the pipeline.
* Create a pipeline for build or deployment.
* Create and run a pipeline for build or deployment.
* Approve or reject a manual step of a waiting pipeline.

## API Reference

{{< swaggerui src="/openapi-spec/pmp-pipeline.yaml" >}}
### Version 2

{{< swaggerui src="/openapi-spec/openapi-pipeline-v2.yaml >}}

### Version 1

{{< swaggerui src="/openapi-spec/openapi-pipeline-v1.yaml >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,22 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

The Private Mendix Platform Project API allows you to manage projects in Private Mendix Platform. You can use the API to do the following:

* Get a project by ID
* Get a list of all projects for the current user
* Create or delete a project
* Retrieve the project creation status
* Change the project name, description, or status
* Change the owning user and group of a project
* Get all project team members
* Add or remove members and groups from a project
* Get a project by ID.
* Get a list of all projects for the current user.
* Create or delete a project.
* Retrieve the project creation status.
* Change the project name, description, or status.
* Change the owning user and group of a project.
* Get all project team members.
* Get the groups or users with which the project is shared.
* Add or remove members and groups from a project.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-project.yaml" >}}
### Version 2

{{< swaggerui src="/openapi-spec/openapi-project-v2.yaml" >}}

### Version 1

{{< swaggerui src="/openapi-spec/openapi-project-v1.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ This document is about [Private Mendix Platform](/private-mendix-platform/) API.

The Private Mendix Platform User API allows you to manage users in Private Mendix Platform. You can use the API to do the following:

* Get a user by ID
* Get a list of all users for the current organization
* Create, update, or delete a user
* Change the password of a user with a specific ID
* Get a user by ID.
* Get a list of all users for the current organization.
* Create, update, or delete a user.
* Change the password of a user with a specific ID.

## API Reference

{{< swaggerui src="/openapi-spec/openapi-user.yaml" >}}
### Version 1

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