Frends Platform API

Manage and operate your Frends Tenant using API.

The Frends Platform API allows Frends to be managed via an API interface. This can be used to automate actions, such as editing Environment Variables or deploying Processes, or accessing Process Instances for monitoring them.

Platform management over API

Frends Platform API is a RESTful API that allows you to perform tasks and actions, and receive data from your Frends Tenant. The API thus allows automating management and monitoring tasks that otherwise would have to be done single piece at a time manually.

Accessing the API description and reference is done through your Frends Control Panel, using URL such as yourtenant.frendsapp.com/swagger. You can also find the latest Platform API reference from here.

API endpoints are visible in the API description, and can be tested from here as well.

Because it is an API and it's accessible within Frends as well, what better way to create your automation to your Frends Tenant than using Frends Processes to implement them. This way you can create Processes that will perform actions to other Frends Processes, as well as collect monitoring data and adjust values in your environment as needed.

The API is designed to be used in a RESTful manner specifying Frends elements to be accessed by their identifiers. Some responses provide links, which help with further requests for the elements contained in the response. Lists use paging or continuation tokens if the data is rapidly changing, e.g. Process Instances. In these cases you need to use the continuation token to have a consistent experience enumerating the list.