The Swagger UI interface allows viewing and trying out API operations. Viewing the Swagger UI is allowed to all users with access to the UI but access to the API methods in Swagger UI is allowed to only users with a role that has the AllowAction ManagementApi.Admin rule in the role configuration.
ApiAccessManagement, ApiSpecifications and EnvironmentVariables API operations are so-called CRUD operations where you can do create, read, update and delete operations through API.
As an example, when you create an API ruleset you can use example value for message body and edit values like you want before creating an API ruleset.
For example if you create an API Key with API rulesets, you should fill in the API ruleset Ids and Environment Id in the Request message.
Environments API operations are for getting Environment and Agent group related information like Environment Ids / Agent group ids. This information is needed for example when create API keys, deploying / undeploying processes.
For example when running List all Environments API call, it returns agent groups each containing environment id and agent group id.
Processes, ProcessDeployments and ProcessInstances API operations are for importing / exporting Processes, listing Processes / Process Instances / Process deployments, deploying / undeploying Processes, activating / deactivating Triggers and running Processes in the specified Agent group.
With Process import you can import one or more Processes from JSON and with Process export you get JSON. You can export one or more processes.
Swagger UI view and operations at the main level.
You can try out different requests on Swagger UI, this will use the account you're logged into Frends automatically for the authorization.