OneTrust API Sunsetting & Deprecation Guidelines

As the market-defining leader for Trust Intelligence, OneTrust understands the importance of providing reliable and consistent services to our customers and partners. Therefore, OneTrust has established REST API Sunsetting and Deprecation Guidelines to ensure that our customers have ample time to migrate to newer versions of our APIs while maintaining the quality of our services.

Sunsetting and Deprecation Guidelines

OneTrust's REST API Sunsetting and Deprecation Guidelines consist of two periods: Sunsetting Period and Deprecation Period. During both the Sunsetting and Deprecation periods, OneTrust will provide regular updates to customers to ensure they are aware of any changes and have ample time to migrate to newer versions of the APIs. Exceptions to these periods will be handled on a case-by-case basis.

Sunsetting Period

The Sunsetting Period will typically last for 3-6 months after announcing the deprecation of an API. This period may vary and will be communicated in the initial deprecation notice.

During this period:

  • OneTrust will continue supporting the API but will no longer add new features or fix non-critical issues.
  • OneTrust strongly encourages customers to migrate to the newer versions of our APIs and will provide resources and support to assist with the transition.
  • OneTrust will continue monitoring the deprecated API usage during the sunsetting period and will proactively notify customers who are leveraging a deprecated API.

Deprecation Period

The Deprecation Period will typically last 12 months after the end of the sunsetting period. OneTrust will provide a clear timeline for the complete end of support of the deprecated API.

During this period:

  • OneTrust will only provide critical support to the API.
  • OneTrust encourages customers to migrate to the newer versions of our APIs and will provide resources and support to assist with the transition.
  • OneTrust will implement a 299 warning for the APIs on the backend.

FAQ

The following responses are supported solutions to frequently asked questions (FAQ). The OneTrust team continuously monitors these inquiries and will make additional FAQ available as they are identified.

  1. What is API deprecation?
    1. API deprecation is the process of discontinuing the use of an older version of an API in favor of a newer version. This ensures continued quality of services and provides customers access to new features and functionality.
  2. Why is OneTrust deprecating APIs?
    1. OneTrust deprecates APIs to ensure that our services are of the highest quality and to provide our customers with access to new features and functionality. Deprecating older APIs allows us to focus on improving and maintaining our newer ones.
  3. What happens if I don’t migrate to the newer API version?
    1. If you don’t migrate to the newer API version before the deprecated API's complete retirement, your service may be disrupted, and you may experience compatibility issues. We encourage our customers to migrate as soon as possible to avoid disruptions.
  4. How do I migrate to the newer version of the API?
    1. OneTrust provides resources and support to assist with the migration process. Please review the corresponding API Reference documentation for more information and contact our support team if you need additional assistance.
  5. Will there be any downtime during the migration process?
    1. OneTrust strives to minimize disruptions during the migration process, but there may be brief periods of downtime. OneTrust will communicate any downtime in advance to ensure our customers are prepared.