1. 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

1.1. Enterprise Cloud Application Programming Interface Documentation Version 2017-08-01

Enterprise Cloud
Application Programming Interface

Version 2017-08-01

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

IBM strives to produce the best documentation possible and welcomes comments and corrections, no matter how trivial, from readers. We frequently update the documents as we incorporate corrections of errors or suggestions for improvements. The last update date in the table below indicates when new versions are available. If you have a comment or correction, please submit it to docfeedback@us.ibm.com, also shown at the bottom of page 2 of the documentation.

Get Started

For organizations just starting with the Enterprise Cloud Application Programming Interface, this section will get you started.

Become Familiar with Key Concepts

Users new to the application programming interface should download the Enterprise Cloud Application Programming Interface, available below.

The reader is encouraged to carefully review the introductory sections, sections 1 through 5, before delving into the references. Many important requirements and restrictions are described only in these sections. A thorough understanding of these topics will avert many potential implementation issues.

After reviewing the introductory sections, a brief review of the use cases in section 6 Application Programming Interface Programmer’s Guide may be helpful in associating API calls to the Infinicenter Console operations. The structure of the Programmer's Guide follows the layout of the Infinicenter Console.

Begin a New API Session

After reading section 3 Security Model, the reader will appreciate the importance of beginning each session with the preparatory calls of Get Time and Get Versions as described in 6.2 Preparation.

Enter the API

As discussed in 4 Call Concepts, the Enterprise Cloud Application Programming Interface uses Links and Actions, each with an opaque hypertext reference or href, to guide the user through the API. The Get Organizations call is the entry point for the API. The call returns links and references, directly or indirectly, to all other branches of the API as described in 6.2 Preparation.

Safely Develop with the Live Specification

As a convenience to Application Programming Interface users, IBM offers the Live Specification to assist in creating applications with the API. The complete implementation of the API, every call, is available. While the data is static, the responses are accurately constructed. In many cases, such as for edits and creates, responses are tailored to important input values.

For further information, see section 5.3 Live Specification of the Enterprise Cloud Application Programming Interface available below.

Explore the API with the Cloud API Explorer

The Cloud API Explorer is a development tool and companion to the Application Programming Interface. The API Explorer enables easy interaction with the API from a browser. The Cloud API Explorer should be used in conjunction with the Enterprise Cloud Application Programming Interface and the Enterprise Cloud Application Programming Interface Cloud API Explorer, available below.

The Cloud API Explorer is available at https://services.enterprisecloud.mgapp.ibm.com/cloudapi/explorer.

Note: The Cloud API Explorer supports only the Enterprise Cloud API; other APIs are not supported.

Download the Documentation

Download the API documentation and the Cloud API Explorer documentation by clicking on the links below Attachments.

Filename Last Update
Cloud API Explorer Update 2017-09-09.pdf08 April 2019 12:53Z
eCloud API Update 2017-09-09.pdf08 April 2019 13:34Z

Schemas are in section 10 Schema of the Enterprise Cloud Application Programming Interface Version 2014-01-01 available above. Download the schemas for all API messages by clicking on the links below:

Filename Description
CloudAPI-2017-08-01.xsd Main Message Schema
proxy_v20170801_Terremark.CloudApi.xsd Alert Status and Type Enumerations
schemas.microsoft.com.2003.10.Serialization.xsd Microsoft Serialization Schema
1.2. Enterprise Cloud Application Programming Interface Documentation Version 2017-06-01

Enterprise Cloud
Application Programming Interface

Version 2017-06-01

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

IBM strives to produce the best documentation possible and welcomes comments and corrections, no matter how trivial, from readers. We frequently update the documents as we incorporate corrections of errors or suggestions for improvements. The last update date in the table below indicates when new versions are available. If you have a comment or correction, please submit it to docfeedback@us.ibm.com, also shown at the bottom of page 2 of the documentation.

Get Started

For organizations just starting with the Enterprise Cloud Application Programming Interface, this section will get you started.

Become Familiar with Key Concepts

Users new to the application programming interface should download the Enterprise Cloud Application Programming Interface, available below.

The reader is encouraged to carefully review the introductory sections, sections 1 through 5, before delving into the references. Many important requirements and restrictions are described only in these sections. A thorough understanding of these topics will avert many potential implementation issues.

After reviewing the introductory sections, a brief review of the use cases in section 6 Application Programming Interface Programmer’s Guide may be helpful in associating API calls to the Infinicenter Console operations. The structure of the Programmer's Guide follows the layout of the Infinicenter Console.

Begin a New API Session

After reading section 3 Security Model, the reader will appreciate the importance of beginning each session with the preparatory calls of Get Time and Get Versions as described in 6.2 Preparation.

Enter the API

As discussed in 4 Call Concepts, the Enterprise Cloud Application Programming Interface uses Links and Actions, each with an opaque hypertext reference or href, to guide the user through the API. The Get Organizations call is the entry point for the API. The call returns links and references, directly or indirectly, to all other branches of the API as described in 6.2 Preparation.

Safely Develop with the Live Specification

As a convenience to Application Programming Interface users, IBM offers the Live Specification to assist in creating applications with the API. The complete implementation of the API, every call, is available. While the data is static, the responses are accurately constructed. In many cases, such as for edits and creates, responses are tailored to important input values.

For further information, see section 5.3 Live Specification of the Enterprise Cloud Application Programming Interface available below.

Explore the API with the Cloud API Explorer

The Cloud API Explorer is a development tool and companion to the Application Programming Interface. The API Explorer enables easy interaction with the API from a browser. The Cloud API Explorer should be used in conjunction with the Enterprise Cloud Application Programming Interface and the Enterprise Cloud Application Programming Interface Cloud API Explorer, available below.

The Cloud API Explorer is available at https://services.enterprisecloud.mgapp.ibm.com/cloudapi/explorer.

Note: The Cloud API Explorer supports only the Enterprise Cloud API; other APIs are not supported.

Download the Documentation

Download the API documentation and the Cloud API Explorer documentation by clicking on the links below Attachments.

Filename Last Update
Cloud API Explorer Update 2017-06-17.pdf08 April 2019 12:52Z
eCloud API Update 2017-06-17.pdf08 April 2019 13:37Z

Schemas are in section 10 Schema of the Enterprise Cloud Application Programming Interface Version 2014-01-01 available above. Download the schemas for all API messages by clicking on the links below:

Filename Description
CloudAPI-2017-06-01.xsd Main Message Schema
proxy_v20170601_Terremark.CloudApi.xsd Alert Status and Type Enumerations
schemas.microsoft.com.2003.10.Serialization.xsd Microsoft Serialization Schema
1.3. Enterprise Cloud Application Programming Interface Documentation Version 2016-12-01

Enterprise Cloud
Application Programming Interface

Version 2016-12-01

IBM is pleased to announce, with Update 2016-12-17 of the Enterprise Cloud, the availability of version 2016-12-01 of the Enterprise Cloud Application Programming Interface.

Note: Version 2016-12-01 deprecated effective 27 January 2018 in accordance with Enterprise Cloud API Support Policy.

IBM strives to produce the best documentation possible and welcomes comments and corrections, no matter how trivial, from readers. We frequently update the documents as we incorporate corrections of errors or suggestions for improvements. The last update date in the table below indicates when new versions are available. If you have a comment or correction, please submit it to docfeedback@us.ibm.com, also shown at the bottom of page 2 of the documentation.

Get Started

For organizations just starting with the Enterprise Cloud Application Programming Interface, this section will get you started.

Become Familiar with Key Concepts

Users new to the application programming interface should download the Enterprise Cloud Application Programming Interface, available below.

The reader is encouraged to carefully review the introductory sections, sections 1 through 5, before delving into the references. Many important requirements and restrictions are described only in these sections. A thorough understanding of these topics will avert many potential implementation issues.

After reviewing the introductory sections, a brief review of the use cases in section 6 Application Programming Interface Programmer’s Guide may be helpful in associating API calls to the Infinicenter Console operations. The structure of the Programmer's Guide follows the layout of the Infinicenter Console.

Begin a New API Session

After reading section 3 Security Model, the reader will appreciate the importance of beginning each session with the preparatory calls of Get Time and Get Versions as described in 6.2 Preparation.

Enter the API

As discussed in 4 Call Concepts, the Enterprise Cloud Application Programming Interface uses Links and Actions, each with an opaque hypertext reference or href, to guide the user through the API. The Get Organizations call is the entry point for the API. The call returns links and references, directly or indirectly, to all other branches of the API as described in 6.2 Preparation.

Safely Develop with the Live Specification

As a convenience to Application Programming Interface users, IBM offers the Live Specification to assist in creating applications with the API. The complete implementation of the API, every call, is available. While the data is static, the responses are accurately constructed. In many cases, such as for edits and creates, responses are tailored to important input values.

For further information, see section 5.3 Live Specification of the Enterprise Cloud Application Programming Interface available below.

Explore the API with the Cloud API Explorer

The Cloud API Explorer is a development tool and companion to the Application Programming Interface. The API Explorer enables easy interaction with the API from a browser. The Cloud API Explorer should be used in conjunction with the Enterprise Cloud Application Programming Interface and the Enterprise Cloud Application Programming Interface Cloud API Explorer, available below.

The Cloud API Explorer is available at https://services.enterprisecloud.mgapp.ibm.com/cloudapi/explorer.

Note: The Cloud API Explorer supports only the Enterprise Cloud API; other APIs are not supported.

Download the Documentation

Download the API documentation and the Cloud API Explorer documentation by clicking on the links below Attachments.

Filename Last Update
Cloud API Explorer Update 2016-12-17.pdf08 April 2019 12:52Z
eCloud API Update 2016-12-17.pdf08 April 2019 13:40Z

Schemas are in section 10 Schema of the Enterprise Cloud Application Programming Interface Version 2014-01-01 available above. Download the schemas for all API messages by clicking on the links below:

Filename Description
CloudAPI-2016-12-01.xsd Main Message Schema
proxy_v20161201_Terremark.CloudApi.xsd Alert Status and Type Enumerations
schemas.microsoft.com.2003.10.Serialization.xsd Microsoft Serialization Schema
1.4. Enterprise Cloud Application Programming Interface Documentation Version 2016-11-01

Enterprise Cloud
Application Programming Interface

Version 2016-11-01

IBM is pleased to announce, with Update 2106-11-19 of the Enterprise Cloud, the availability of version 2016-11-01 of the Enterprise Cloud Application Programming Interface.

Note: Version 2016-11-01 deprecated effective 27 January 2018 in accordance with Enterprise Cloud API Support Policy.

IBM strives to produce the best documentation possible and welcomes comments and corrections, no matter how trivial, from readers. We frequently update the documents as we incorporate corrections of errors or suggestions for improvements. The last update date in the table below indicates when new versions are available. If you have a comment or correction, please submit it to docfeedback@us.ibm.com, also shown at the bottom of page 2 of the documentation.

Get Started

For organizations just starting with the Enterprise Cloud Application Programming Interface, this section will get you started.

Become Familiar with Key Concepts

Users new to the application programming interface should download the Enterprise Cloud Application Programming Interface, available below.

The reader is encouraged to carefully review the introductory sections, sections 1 through 5, before delving into the references. Many important requirements and restrictions are described only in these sections. A thorough understanding of these topics will avert many potential implementation issues.

After reviewing the introductory sections, a brief review of the use cases in section 6 Application Programming Interface Programmer’s Guide may be helpful in associating API calls to the Infinicenter Console operations. The structure of the Programmer's Guide follows the layout of the Infinicenter Console.

Begin a New API Session

After reading section 3 Security Model, the reader will appreciate the importance of beginning each session with the preparatory calls of Get Time and Get Versions as described in 6.2 Preparation.

Enter the API

As discussed in 4 Call Concepts, the Enterprise Cloud Application Programming Interface uses Links and Actions, each with an opaque hypertext reference or href, to guide the user through the API. The Get Organizations call is the entry point for the API. The call returns links and references, directly or indirectly, to all other branches of the API as described in 6.2 Preparation.

Safely Develop with the Live Specification

As a convenience to Application Programming Interface users, IBM offers the Live Specification to assist in creating applications with the API. The complete implementation of the API, every call, is available. While the data is static, the responses are accurately constructed. In many cases, such as for edits and creates, responses are tailored to important input values.

For further information, see section 5.3 Live Specification of the Enterprise Cloud Application Programming Interface available below.

Explore the API with the Cloud API Explorer

The Cloud API Explorer is a development tool and companion to the Application Programming Interface. The API Explorer enables easy interaction with the API from a browser. The Cloud API Explorer should be used in conjunction with the Enterprise Cloud Application Programming Interface and the Enterprise Cloud Application Programming Interface Cloud API Explorer, available below.

The Cloud API Explorer is available at https://services.enterprisecloud.mgapp.ibm.com/cloudapi/explorer.

Note: The Cloud API Explorer supports only the Enterprise Cloud API; other APIs are not supported.

Download the Documentation

Download the API documentation and the Cloud API Explorer documentation or by clicking on the links below Attachments.

Filename Last Update
Cloud API Explorer Update 2016-11-19.pdf08 April 2019 12:51Z
eCloud API Update 2016-11-19.pdf08 April 2019 13:37Z

Schemas are in section 10 Schema of the Enterprise Cloud Application Programming Interface Version 2014-01-01 available above. Download the schemas for all API messages by clicking on the links below:

Filename Description
CloudAPI-2016-11-01.xsd Main Message Schema
proxy_v20161101_Terremark.CloudApi.xsd Alert Status and Type Enumerations
schemas.microsoft.com.2003.10.Serialization.xsd Microsoft Serialization Schema
1.5. Enterprise Cloud Application Programming Interface Documentation Version 2016-09-01

Enterprise Cloud
Application Programming Interface

Version 2016-09-01

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

Note: Version 2016-09-01 retired effective 7 April 2018 in accordance with Enterprise Cloud API Support Policy.

1.6. Enterprise Cloud Application Programming Interface Documentation Version 2016-07-01

Enterprise Cloud
Application Programming Interface

Version 2016-07-01

IBM is pleased to announce, with Update 2016-07-30 of the Enterprise Cloud, the availability of version 2016-07-01 of the Enterprise Cloud Application Programming Interface.

Note: Version 2016-07-01 retired effective 7 April 2018 in accordance with Enterprise Cloud API Support Policy.