IBM logoEnterprise Cloud Management SupportContact Us
ArticlesArticles Most Popular ArticlesMost Popular Articles Most Helpful ArticlesMost Helpful Articles Submit A QuestionSubmit A Question
RSS Feeds
Skip Navigation
DrillDown Icon Table of Contents
DrillDown Icon Enterprise Cloud
DrillDown Icon Release Notes
DrillDown Icon Known Issues
DrillDown Icon Policies
DrillDown Icon Legal Notice
DrillDown Icon Security Model
DrillDown Icon Lifecycle Management Policy - Deployment Templates
DrillDown Icon Enterprise Cloud API Support Policy
DrillDown Icon Registration and Login
DrillDown Icon Infinicenter Console
DrillDown Icon Enterprise Cloud API
DrillDown Icon Best Practices
DrillDown Icon FAQs
DrillDown Icon Troubleshooting
DrillDown Icon Enterprise Cloud Managed Edition
DrillDown Icon Sales and Support
DrillDown Icon Proprietary Statement
  Email This ArticlePrint PreviewPrint Current Article and All Sub-Articles
 
Enterprise Cloud API Support Policy

Enterprise Cloud
Application Programming Interface
Support Policy

API Support Policy Applicability

This support policy applies to the Enterprise Cloud Application Programming Interface beginning with version 2011-07-01, first offered November 2011 with release 2.10 of the Enterprise Cloud, and subsequent versions.

API Support Policy

IBM defines three stages of support: active, deprecated, and retired. Active versions are current and fully supported. Deprecated versions remain fully supported but for which retirement is imminent. The period during which the version is deprecated permits organizations to plan, prepare, and migrate to a newer version. Retired versions have passed the end of their deprecation period and are no longer supported.

Active Versions

API versions remain active for one year. With the first Enterprise Cloud release after that year, the version is deprecated.

Deprecated Versions

API versions remain deprecated for six months. With the first Enterprise Cloud release after those six months, the version is retired.

The period during which the version is deprecated permits organizations to plan, prepare, and migrate to a newer version. The Enterprise Cloud API identifies deprecated versions in the Get Versions call and in the header field, x-tmrk-deprecated.

The Get Versions call returns the versions available for use. The call returns a repeating group with the <Version> and conditionally a <Deprecated> flag. The <Version> is returned in the format as described in the section Version under Call Constructs in the document Enterprise Cloud Application Programming Interface. In advance of the release of new versions of the API, the version to be displaced will be marked as deprecated. <Deprecated> is set to true on deprecated versions. <Deprecated> is generally not included if set to false.

Responses to all requests in a deprecated version have the x-tmrk-deprecated header field set to true. The section Deprecated under Call Constructs in the document Enterprise Cloud Application Programming Interface describes the x-tmrk-deprecated header field. This field is conditional and used only in API service responses. When requests are made in versions that have been deprecated, the response header will include x-tmrk-deprecated: true.

Retired Versions

API versions retire after not less than eighteen months. Calls made with retired versions will return 412 Invalid Version Specified errors.

Expected Deprecation and Retirement Dates

The table below summarizes the expected dates of deprecation and retirement for current API versions. The actual dates may vary depending upon the actual implementation date of future Enterprise Cloud releases.

Infinicenter Release API Version Expected
Deprecation
Expected
Retirement
Actual
Deprecation
Actual
Retirement
Update 2018-05-24 no new API
Update 2018-04-07 no new API
Update 2018-01-27 no new API
Update 2017-10-28 no new API
Update 2017-10-07 2017-08-01 2018/10/13 2019/04/13
Update 2017-07-15 no new API
Update 2017-06-17 2017-06-01 2018/06/23 2018/12/23
Update 2017-05-20 no new API
Update 2017-04-22 no new API
Update 2017-03-18 no new API
Update 2017-02-18 no new API
Update 2017-01-21 no new API
Update 2016-12-17 2016-12-01 2017/12/23 2018/06/23 2018/01/27
Update 2016-11-19 2016-11-01 2017/11/25 2018/05/26 2018/01/27
Update 2016-10-22 no new API
Update 2016-09-24 2016-09-01 2017/09/30 2018/03/31 2017/10/07 2018/04/07
Update 2016-08-27 no new API
Update 2016-07-30 2016-07-01 2017/08/05 2018/02/10 2017/10/07 2018/04/07