Versioning a Web Service

A Web Service may have multiple Endpoints, each describing a version of the Web Service. This enables the user to make significant changes to an API without breaking existing client applications or integrations. The following steps outline the process of versioning a Web Service with a new Endpoint.

  1. Open the Web Service.
  2. Click Edit.
  3. In the Endpoints grid, select the Endpoint that will be the basis of the new version.
  4. Click the Create New Version button in the grid toolbar.
  5. Click Save in the Web Service toolbar.
  6. In the Endpoints grid, select the Endpoint with the new version.
  7. Click Configure Endpoint in the grid toolbar.
  8. Edit the Endpoint as needed. Then Save the Web Service and publish the newest Endpoint version.
Note
A Web Service may have more than one published or “active” Endpoint, each with a unique url.