Deprecation Policy

Understand RMS deprecation policies

Overview

RMS periodically deprecates and retires operations exposed by the Risk Modeler, Data Bridge, and Location Intelligence APIs.

The Risk Modeler, Data Bridge, and Location Intelligence APIs are managed independently and maintain their own security, versioning, and deprecation policies.

Risk Modeler

An Risk Modeler API operation is marked deprecated whenever an updated version of that operation is released.

The deprecated operation is accessible for at least one year after it has been deprecated, but returns a Warning HTTP header in the response. The Warning header identifies the updated endpoint and the date the current endpoint will be retired. For example,

This API endpoint is deprecated, please switch to riskmodeler/v2/accounts/{id}/analyses. 
Support for this endpoint will end on Wednesday, 26 Jan 2022 00:00:00 GMT.

Although deprecated operations are accessible for a one year period, RMS encourages you to transition to the updated operation as soon as possible to take advantage of greater functionality and improved workflows.

Multiple versions of a operation may exist at the same time. For example, both /riskmodeler/v1/accounts/{id}/analyses and /riskmodeler/v2/accounts/{id}/analyses may be accessible for a one year period. Each version of the operation is distinct, provides different functionality, and is documented separately in the API Reference documentation.

Data Bridge

A Data Bridge API operation is marked deprecated whenever an updated version of that operation is released.

The deprecated operation is accessible for at least one year after it has been deprecated, but returns a Warning HTTP header in the response. The Warning header identifies the updated endpoint and the date the current endpoint will be retired. For example,

This API endpoint is deprecated, please switch to /v2/accounts/{id}/analyses. Support for this endpoint will end on Wednesday, 26 Jan 2022 00:00:00 GMT.

Although deprecated operations are accessible for a one year period, RMS encourages you to transition to the updated operation as soon as possible to take advantage of greater functionality and improved workflows.

Multiple versions of a operation may exist at the same time. For example, both the /v1/sql-operation and /v2/sql-operation endpoints may be supported for a one year period. Each operation has a distinct endpoint, provides different functionality, and is documented separately in the API Reference documentation.

Location Intelligence

Periodic updates to models trigger changes to downstream data, and the Location Intelligence API makes this updated data available through versioned data products.

For purposes of business continuity, Location Intelligence may support multiple versions of a data product simultaneously. For example, US Severe Convective Storm Loss Cost data product may be simultaneously available in versions 18.0 and 18.1. Each version of this data product is is exposed through a unique operation endpoint that returns distinct data. These operation endpoints are distinguished from one another by version numbers that identify the corresponding data product version, e.g. /li/us_cs_loss_cost/18.0 and /li/us_cs_loss_cost/21.0.

In general, Location Intelligence deprecates endpoints that are older than one update and retires Location Intelligence endpoints that have deprecated for at least one year. Neither deprecated or retired endpoints are displayed in the Location Intelligence reference documentation.

  • Deprecated endpoints return response headers that notify the client that the endpoint has been deprecated.
  • Retired endpoints return 410 Gone HTTP status codes.

Location Intelligence may also deprecate endpoints based on the following considerations:

  • Simplicity for RMS to implement and communicate
  • Ease for developers to understand
  • Predictability with appropriate lead times