In Frends version 5.6 the Management API is in beta as we want to gather data on how it is used. We will look to release it officially in Frends 5.7 current state of the Management API will be the final one.

The Management API will let you control Frends without using the Control Panel. This lets you e.g. connect Frends to the CI/CD pipeline or analyse logs elsewhere. Currently, everything that is possible in the Control Panel is not Possible in Management API, but getting there is our goal.

You can find the swagger UI of management API by going to the URL https://TENANTNAME.frendsapp.com/swagger/ui/

Or raw JSON specification at URL https://TENANTNAME.frendsapp.com/v0.9/swagger Rough overview of management API is

ApiAccessManagement lets you get, delete, and create or modify, API Keys and API Rulesets.

ApiSpecifications endpoints let you create, modify, delete, publish (i.e. save), and deploy Open Api Specifications, get process templates of linked processes, and deploy linked processes.

Environments endpoints let you get and list environments and Agent Groups.

EnvironmentVariables endpoints let you create, modify, and delete environment variables.

ProcessDeployments endpoints let you get, list, and do process deployments, and activate and deactivate triggers.

Processes endpoints are used to list, import, export, and delete Processes. If you want to get Processes in certain Agent Groups you should use ProcessDeployments endpoints.

ProcessInstances endpoint is used to get Process instances (i.e. log data). Only the process level data is returned, so step data (i.e. Task results) are not returned.