Enterprise Cloud Application Programming Interface Documentation

Enterprise Cloud
Application Programming Interface

Version 2017-08-01

IBM is pleased to announce, with Update 2017-09-09 of the Enterprise Cloud, the availability of version 2017-08-01 of the Enterprise Cloud Application Programming Interface.

Introduction to the Application Programming Interface

The Enterprise Cloud Application Programming Interface version 2017-08-01 is the latest extension of the new Enterprise Cloud API begun with version 2011-07-01.

The relationship between Infinicenter releases and API versions is in the table below.

Infinicenter Release API Version Expected
Deprecation
Expected
Retirement
Actual
Deprecation
Actual
Retirement
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
Update 2016-11-19 2016-11-01 2017/11/25 2018/05/26
Update 2016-10-22 no new API
Update 2016-09-24 2016-09-01 2017/09/30 2018/03/31 2017/09/30
Update 2016-08-27 no new API
Update 2016-07-30 2016-07-01 2017/08/05 2018/02/10 2017/09/30
Update 2016-06-25 no new API
Update 2016-06-04 2016-05-01 2017/06/01 2017/12/16 2017/06/17
Update 2016-05-07 2016-04-01 2017/05/13 2017/11/18 2017/05/20
Update 2016-04-02 no new API
Update 2016-03-05 no new API
Update 2016-02-13 no new API
Update 2016-01-09 2015-12-01 2017/01/14 2017/07/15 2017/01/21 2017/10/07
Update 2015-12-05 2015-11-01 2016/12/10 2017/06/10 2016/12/17 2017/06/17

Access the Application Programming Interface with a Uniform Resource Locator

The IBM Enterprise Cloud architecture uses a URI/URL to identify an Enterprise Cloud provider and the entities owned by that provider. This URI is unique to each provider or entity within the provider. Every call or any hypertext reference (href) in a response is always relative to a base URL. To obtain a desired resource, you append the resource identifier, typically obtained from the href attribute, to the base URL.

Base URL

https://services.enterprisecloud.mgapp.ibm.com

Resource

Entities are prefaced with a path. The value of the path differs between accessing the Live Data and the Live Specification.

Live Data

/cloudapi/ecloud

Live Specification

/cloudapi/spec

Example

Live Data

https://services.enterprisecloud.mgapp.ibm.com/cloudapi/ecloud/versions

Live Specification

https://services.enterprisecloud.mgapp.ibm.com/cloudapi/spec/versions

API Support Policy

API versions are not supported indefinitely. As new versions release, older versions deprecate and retire. The schedule for deprecation and retirement is listed in the table above. Read and download the policy at Enterprise Cloud API Support Policy