Skip to content

Modify an API product

Currently you can modify an API Product to:

  • Modify product information.

  • Add or remove API proxies

  • Publish or edit documentation

To modify an API product

  1. From the Trimble Developer Console left menu, select API Products. The API Products page displays.
  2. Select the API Product to edit. The page displays with API Product details.

Only Product Info, Proxies and Publish sections are editable. 3. In the Product section you can edit: Display Name, Description, API Type, Visibility and Compliance. 4. In the Proxy section you can perform the following actions:

* Select +ADD PROXY to add proxies (or)
* Select the Delete icon next to a proxy to remove it from the product.

5. In the Publish - Documentation section, you can perform the following actions:

* Select ADD DOCUMENT to add a new document.
* Select the Delete icon next to an uploaded document to delete it permanently.
* Select VISIBILITY to publish or unpublish documentation in specific environments. The Visbility Configuration dialog box displays with the following options:
| Field | Description |
| --- | --- |
| Pre-prod Environment | Toggle the button to Amber to publish the uploaded document in Pre-prod environment. |
| Prod Environment | Toggle the button to Amber to publish the uploaded document in Pre-prod Environment. |

6. In the Publish section, you can also publish the API Product to Prod-Environment.

Currently the Trimble Cloud Console does not allow you to unpublish API Products once deployed.