Versioning Policy

Understand RMS versioning policies

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

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

Risk Modeler

RMS may release a new version whenever the following changes are made to a Risk Modeler API service:

  • Changes to the endpoint path
  • Changes to default or optional parameters
  • Changes to the attributes that must be specified in a request
  • Changes to the attributes returned in a response

The version number of an API service is indicated by a version number, which defines 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 service.

When a new version of an API service 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 service.

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

Data Bridge

RMS may release a new version whenever the following changes are made to Data Bridge service:

  • Changes to the endpoint path
  • Changes to default or optional parameters
  • Changes to the attributes that must be specified in a request
  • Changes to the attributes returned in a response

The version number of an API service is indicated by a version number, which defines 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 service.

When a new version of an API service 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 service.

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 sets available through the Location Intelligence API.

The version number of an API is not updated for the following changes:

  • Additions of new 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

Did this page help you?