forked from mendix/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request mendix#7689 from loket4/development
Sprintr release 2024.05.05
- Loading branch information
Showing
7 changed files
with
743 additions
and
165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: "Projects API" | ||
url: /apidocs-mxsdk/apidocs/projects-api/ | ||
category: "API Documentation" | ||
type: swagger | ||
description: "This API allows you to manage your projects and their teams." | ||
weight: 100 | ||
beta: true | ||
--- | ||
|
||
{{% alert color="info" %}} This feature is currently in beta. For more information, see [Beta Releases](/releasenotes/beta-features/). {{% /alert %}} | ||
|
||
## 1 Introduction | ||
|
||
The Mendix Projects API allows you to create, edit or delete your projects. | ||
|
||
## 2 Authentication {#authentication} | ||
|
||
Authentication for the API uses a personal access token (PAT). | ||
|
||
### 2.1 Generating a PAT {#generate} | ||
|
||
To generate a PAT, see the [Personal Access Tokens](/community-tools/mendix-profile/user-settings/#pat) section in *User Settings*. | ||
|
||
Select the appropriate scopes, depending on the endpoints that need to be invoked. Refer to the API Reference for more information on which scopes to use in which endpoints. | ||
|
||
### 2.2 Using the PAT | ||
|
||
Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. For example: | ||
|
||
```http {linenos=false} | ||
GET /projects HTTP/1.1 | ||
Authorization: MxToken 7LJE…vk | ||
``` | ||
|
||
## 3 API Reference | ||
|
||
{{< swaggerui src="/openapi-spec/projects-v2.yaml" >}} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.