API Version Deployments

API Version Deployments

This document outlines the process for deploying and managing specific versions of your API.

Adding a New Deployment

Once a new version is created, an “Add a deployment” section will appear on the page with a + Add New Deployment button.

Clicking this button opens the ‘Add New Deployment’ window, where user can configure the deployment settings based on the Permission Matrix.

• Region: Select the desired deployment region from the dropdown menu.
  • Staging Environment: Only the ‘Global’ region is supported.
  • Production Environment: Both ‘Global’ and ‘EU-West’ (Ireland) regions are supported.
  • Future support for any new regions added in Azure or other gateways will be included here.
• Target Endpoint: This field requires the backend URL of the application.
• Connection Timeout: The connection timeout is set to 30 seconds by default but can be adjusted to any value between 1 and 55 seconds.
• Consumption Endpoint: This field provides a preview of how the final deployed URL will look.

Region Information:

• Global: Deploying target endpoint in a ‘Global’ Azure region leverages Azure’s worldwide network of data centers.
• EU-West (Ireland): Deploying target endpoint in the ‘EU-West’ (Ireland) Azure region leverages Azure’s European network of data centers.

Deployment Status and Completion

After you click ‘Create’, the deployment process begins.

• Deployment Time: The deployment typically takes between 3 to 4 minutes to complete.
• Status: During this time, the Deployment Status will be displayed as DEPLOYING.
• Completion: Once the deployment is complete, the status will turn green and read DEPLOYED. The full consumption URL will then be displayed.

Consumption URL Format

The final consumption URL follows this structure: <domain>/<Base Path>/<version>.

• Example: For a base path of /cloud/accounts and version v1, the deployed endpoint would be https://cloud.stage.api.trimblecloud.com/cloud/accounts/v1.

Editing an Existing Deployment

To edit a deployed region, click the pencil icon next to its details. This will open a window titled ‘Edit Deployment’. This can be actioned based on the Permission Matrix

• Redeployment Conditions: A redeployment can be initiated to reflect changes in the backend (target) URL or the connection timeout.
• Update Process: After making the necessary changes, click ‘Update’ to start the redeployment process. The status will again show as DEPLOYING until the update is complete.
• Functionality During Redeployment: Until the redeployment is complete, the previously existing deployed URL will still be functioning.