Versioning Policy

Understand RMS versioning policies

RMS periodically makes updates the Risk Modeler, Data Bridge, and Location Intelligence APIs to introduce new operations, update existing operations, or deprecate outdated operations.

Updates to Risk Modeler, Data Bridge, and Location Intelligence API operations are recorded in the Changelog.

Risk Modeler

The Risk Modeler API may release a new version of an operation whenever the following changes are made:

  • A change is made to the endpoint path
  • A change is made to the parameters specified in an operation request
  • A change is made to the resource attributes returned by an operation response

The operation version is indicated by the base path in every Risk Modeler endpoint. For example, /riskmodeler/v1/accounts/{id}/analyses. The v1 base path indicates that this is the endpoint for the first version of this operation.

When a new version of an API operation is released the version number is incremented and appended to the endpoint path. For example, /riskmodeler/v2/accounts/{id}/analyses. The v2 base path indicates that this is the second version of this operation.

As soon as the new version of the service is released, the previous version of the service is immediately deprecated. Deprecated operations remain accessible for at least one year after they are deprecated. For details, see our Deprecation Policy.

Data Bridge

The Data Bridge API may release a new version of an operation whenever the following changes are made:

  • A change is made to the endpoint path
  • A change is made to the parameters specified in an operation request
  • A change is made to the resource attributes returned by an operation response

The operation version is indicated by the base path in every Data Bridge endpoint. For example, /v1/sql-instances. The v1 base path indicates that this is the endpoint for the first version of this operation.

When a new version of an API operation is released the version number is incremented and appended to the endpoint path. For example, /v2/sql-instances. The v2 base path indicates that this is the second version of this operation.

Location Intelligence

RMS makes periodic updates to its models as needed based on new science, changing scientific consensus, or a better understanding of perils. Changes to models may trigger updates to downstream data and updates to the data products made available through Location Intelligence API endpoints.

For purposes of business continuity, Location Intelligence may support multiple versions of the same data product simultaneously. Each data product is represented by a unique operation endpoint that includes the version number of the data product, e.g. /li/us_cs_loss_cost/18.0 and /li/us_cs_loss_cost/18.1.

In addition to versioned operations, Location Intelligence exposes for each data product an endpoint that leverages the most recent version of the data product. This endpoint substitutes the string latest in place of data product version, e.g. the endpoint /li/us_cs_loss_cost/latest is an alias for /li/us_cs_loss_cost/18.1 when the most recent version of the US Severe Convection Storm Loss Cost data product is version 18.1.

The Location Intelligence API does not update version numbers for the following changes:

  • Additions of new operation endpoints
  • Changes to the default or optional request parameters
  • Changes to the attributes that must be specified in a request
  • Changes to the attributes returned in a response