DATPROF Runtime contains the powerfull REST API.
This API can be used in your scripts or other tooling to manage Runtime projects, environments and/or applications.
This API system comes along with generated online documentation using Redoc(1).
It shows the syntax, respons examples and required parameters.
You can access the documentation at the right corner of the Bottom status bar in the Runtime application.
The DATPROF Runtime API syntax is always case sensitive !
As of this version 3.12.0 all dashes are removed from the API URL, the parameters and the Request Body. (i.e.: project-id has become projectId}
In addition to the syntax description in the generated documentation the following applies.:
To test your API calls you may use a graphical tool like Postman(3).
Api calls without parameters
Some API Calls do not require any parameter and can be used as is:
To obtain a list of projects using curl:
Api calls using Path parameters
Some API calls require PATH Parameters. Path parameters are part of the URL.
To obtain the run.log of the run with run id 100 using curl:
Api calls using Query parameters
Some API calls require QUERY Parameters. Query parameters are appended to the url using a questionmark "?" as separator.
To get a list of parameters of the environment with id 1 using curl:
Api calls using a Request Body
Some API Calls require a Request Body. A request body is of the type json. You should add the content-type in the request. Using curl this implies the additional header: -H "Content-Type:application/json"
To create a parameter SEASON with value SUMMER in environment with id 1 using curl:
Valid Parameter TYPES are "STRING" and "BOOLEAN"
The output of an API v2 call is mostly a Json object which can be parsed whith tools like jq(4).
First get all the environments for project 1 using project id 1 using curl:
Now the same call with the additional parsing using jq:
Now to get the ID of environment 2
Another example, get the ID of project name Project1: