Epics API
Last modified: May 29, 2024
Epics is the default tool for you to manage the development process of new apps. It is a replacement of Stories, which has been deprecated on October 1, 2023.
1 Introduction
The Mendix Epics API allows you to retrieve, create, and update stories as well as get all the statuses that can be possibly assigned to stories.
2 Authentication
Authentication for the Epics API uses a personal access token (PAT).
2.1 Generating a PAT
To generate a PAT, see the Personal Access Tokens section in User Settings.
Select the following as Epics scopes:
mx:epics:read
– to performGET
operationsmx:epics:write
– to perform all operations (GET
,POST
,PUT
, andDELETE
)
Store the generated value {GENERATED_PAT}
somewhere safe so you can use it to authorize your Mendix Cloud Deploy API calls.
2.2 Using the PAT
Each request must contain an Authorization
header with the value MxToken {GENERATED_PAT}
. For example:
GET /projects/d92064a5-b1fd-4be4-97db-53fc90201d1c/epics HTTP/1.1
Authorization: MxToken 7LJE…vk
To authenticate calls when using the Open API specification below, click Authorize and use the value MxToken {GENERATED_PAT}
.