Deprecation Policy

Understand RMS deprecation policies

An RMS API service is marked deprecated whenever an updated version of that service is released.

Risk Modeler

The deprecated service 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 services are accessible for a one year period, RMS encourages you to transition to the updated service as soon as possible to take advantage of greater functionality and improved workflows.

Risk Modeler distinguishes between deprecated APIs and retired APIs:

  • A deprecated API is remains accessible and responds to customer requests, but returns a Warning header that specifies the updated endpoint and the date that the current service will be retired.
  • A retired API no longer responds to customer requests. Retired APIs return a 410 Gone HTTP response status code. An API version can only be retired once it has been in a deprecated state for at least one year.

Multiple versions of a service 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 service is distinct, provides different functionality, and is documented separately in the API Reference documentation.

Data Bridge

An RMS API service is marked deprecated whenever an updated version of that service is released.

The deprecated service 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 services are accessible for a one year period, RMS encourages you to transition to the updated service as soon as possible to take advantage of greater functionality and improved workflows.

Data Bridge distinguishes between deprecated APIs and retired APIs:

  • A deprecated API is remains accessible and responds to customer requests, but returns a Warning header that specifies the updated endpoint and the date that the current service will be retired.
  • A retired API no longer responds to customer requests. Retired APIs return a 410 Gone HTTP response status code. An API version can only be retired once it has been in a deprecated state for at least one year.

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

Location Intelligence

RMS deprecates APIs based on the following considerations:

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

Location Intelligence distinguishes between deprecated APIs and retired APIs.

  • A deprecated API is still accessible and responds to customer requests, but returns a 299 Deprecated HTTP response status code.
  • A retired API no longer responds to customer requests. Retired APIs return a 410 Gone HTTP response status code.

An API version can only be retired once it has been in a deprecated state for at least one year.


Did this page help you?