How to deploy an API

To utilize the API, it needs to be deployed. For this purpose, you must have information about the Agent Group where the API and its related Processes will be deployed.

In the first step of the API Deploy View, you can verify the information and provide any relevant notes related to the deployment. The second step involves selecting the target Agent Group for the deployment and choosing the Process versions that will be deployed.

After the API is deployed, it will be visible in the Agent Group's API List View, and the Trigger will be activated.

A development version of an API is a version where the linked Processes do not have locked-down versions. This means that the user can update any Process that is part of the API without taking any additional actions. Additionally, the development version can have its Swagger specification modified. Once an API is ready for deployment, the next step is to create a published version.

A published version includes everything a development version does, but changes are not allowed. The API Swagger specification and the Processes API uses are frozen. A published version can be deployed as a unit, and it can also be used as a version to roll back the development version.

When deploying, the user can choose to deploy a previously published version or create a new published version from the current development version. The Deployment dialog allows the user to view the Processes that will be deployed and the Swagger specification. If a published version is no longer valid, for example, due to a deleted Process, it cannot be deployed.

The next article is Introduction to How to configure an authentication method for an API