Cisco CloudCenter REST API Guide, Release 4.5.x

Cisco CloudCenter REST API Guide, Release 4.5.x First Published: July 15, 2016

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000 800 553-NETS (6387)Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITEDWARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain versionof the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.

NOTWITHSTANDINGANYOTHERWARRANTYHEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS"WITH ALL FAULTS.CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OFMERCHANTABILITY, FITNESS FORA PARTICULAR PURPOSEANDNONINFRINGEMENTORARISING FROMACOURSEOFDEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, networktopology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnershiprelationship between Cisco and any other company. (1110R)

2016 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarkshttp://www.cisco.com/go/trademarks

1. About CloudCenter APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1 CloudCenter API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.2 Synchronous and Asynchronous APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3 API Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.4 API Management Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.5 Base URI Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141.6 HTTPS Request Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.7 Response Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.8 API Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.9 Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

2. About Enterprise Service Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462.1 Enterprise Service Bus (ESB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

3. ACL Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513.1 View ACL Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513.2 View ACL Resource Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563.3 Update ACL Resource Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4. Activation Profiles Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614.1 Create Activation Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614.2 View Activation Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654.3 Update Activation Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684.4 Delete Activation Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

5. Application Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715.1 Delete Application Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725.2 Export Application Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725.3 Get All Versions of an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735.4 Get Application Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755.5 Get Supported Cloud Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915.6 Import Application Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965.7 List Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965.8 List Applications by Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995.9 List Application Profile Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015.10 Update an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025.11 Validate Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

6. Bundle Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056.1 Create Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056.2 View Bundles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096.3 Update Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136.4 Delete Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

7. CCO Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177.1 Update CCO Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177.2 View CCO Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

8. Certificate Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218.1 Upload Link Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218.2 Download Self Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

9. Cloud Account Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249.1 Create Cloud Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249.2 View Cloud Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1289.3 Update Cloud Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1379.4 Delete Cloud Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449.5 Perform Cloud Account Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

10. Cloud Family Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14610.1 View Cloud Families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11. Cloud Image Mapping Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15111.1 Create Cloud Image Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15211.2 View Cloud Image Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15611.3 Update Cloud Image Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18911.4 Delete Cloud Image Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19311.5 Sync Cloud Region Image Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

12. Cloud Instance Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19912.1 Create Cloud Instance Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19912.2 View Cloud Instance Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20312.3 Update Cloud Instance Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21512.4 Delete Cloud Instance Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21812.5 Sync Cloud Instance Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21912.6 Create Cloud Instance Type Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22512.7 View Tenant Cloud Instance Type Overrides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22712.8 Update Cloud Instance Type Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

13. Cloud Properties Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23313.1 View Cloud Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

14. Cloud Region Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23814.1 Create Cloud Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23814.2 View Cloud Regions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

14.3 Update Cloud Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25214.4 Delete Cloud Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

15. Cloud Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26315.1 Create Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26315.2 View Clouds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26515.3 Update Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27115.4 Delete Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

16. Contract Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27416.1 Create Contract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27416.2 View Contracts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27716.3 Update Contract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28016.4 Delete Contract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

17. Custom Action Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28317.1 Create Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28317.2 View Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29117.3 Update Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29917.4 Delete Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

18. Deployment Environment Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30618.1 Create Deployment Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30618.2 View Deployment Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31618.3 Update Deployment Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32218.4 Delete Deployment Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

19. Federated Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32919.1 Initiate Federated Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32919.2 Approve Link Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33519.3 Accept Link Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34219.4 View Established Link Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35019.5 View Child CCM Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35519.6 View Parent CCM Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36019.7 Update Link Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36519.8 Update Access to Child CCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37219.9 Propagate Changes to Child CCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37719.10 View Propagated Link Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38019.11 Delete Established Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

20. Group Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38420.1 Create Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38420.2 View Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38920.3 Update Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39720.4 Delete Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

21. Image Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40621.1 Create Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40621.2 View Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41021.3 Update Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42321.4 Delete Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

22. Job Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42822.1 Delete Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42822.2 Deployment VM Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42922.3 Fetch Job-Associated VM Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43022.4 Get Job Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43422.5 Get Windows VM(s) Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44722.6 List Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44822.7 Migrate Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46022.8 Reconfigure Running Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46422.9 Restart Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46522.10 Resume Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46622.11 Stop Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46722.12 Submit Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46822.13 Suspend Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48722.14 Synchronize VM Cloud Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48922.15 Upgrade Running Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

23. Key Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49223.1 Create API Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49223.2 View Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49323.3 View User's Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

24. Log Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49724.1 View Log Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49724.2 Update Log Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

25. Logo Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50425.1 Upload Logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

26. Marketplace Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50526.1 Export Marketplace Application Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50526.2 Import Marketplace Application Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

26.3 Delete Marketplace Application Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50727. Operations Status APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

27.1 Get Operation Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50728. Phase Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

28.1 Create Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50828.2 View Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51128.3 Update Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51728.4 Delete Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

29. Plan Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52429.1 Create Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52429.2 View Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53629.3 Update Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54329.4 Delete Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

30. Policy Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54930.1 View Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54930.2 Create Action Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55230.3 Enable Action Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56130.4 View Action Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56230.5 Update Action Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57030.6 Delete Action Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576

31. Project Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57731.1 Create Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57731.2 View Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58231.3 Update Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58931.4 Delete Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59431.5 Publish Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

32. Report Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60232.1 View Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

33. Role Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60633.1 Create Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60633.2 View Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61033.3 Update Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62633.4 Delete Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633

34. Service Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63334.1 Create Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63334.2 View Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64734.3 Update Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66534.4 Delete Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678

35. Tenant Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67835.1 Create Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67835.2 View Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68735.3 Update Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70035.4 Delete Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70835.5 Perform Tenant Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709

36. VM Inventory Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71436.1 List VMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71436.2 Power On/Off or Reboot/Terminate VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722

37. User Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72437.1 Create User without Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72437.2 Create User with Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72637.3 View Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73037.4 Update User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73737.5 Perform User Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74337.6 Delete User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748

38. API Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75038.1 User Activation and Tenant Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75038.2 Cloud Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75738.3 Application Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766

Cisco CloudCenter User Documentation

Cisco CloudCenter REST API Guide 4

About CloudCenter APIsCloudCenter API OverviewSynchronous and Asynchronous APIsAPI AuthenticationAPI Management KeyBase URI FormatHTTPS Request MethodsResponse SchemaAPI Error CodesAttribute Types

CloudCenter API OverviewCliQr uses the REST API conventions provided in this section.

CliQr API VersionDocumentation ConventionsDate FormatResource URL and IDPagination

Pagination Request AttributesPagination Response Attributes

SortingSorting Examples Property Name Validation

HTTP Location URLHTTP Status Codes

Sample Error ResponsesWho Can Use CloudCenter APIs?Tenant Admins and Co-Admins

CliQr API Version 1.0 provides APIs (except as identified for deprecated APIs/attributes) to support the following CloudCenter releases:

CloudCenter 4.xCloudCenter 3.x

CliQr documentation uses the following conventions:

Base URI for additional context.Format

Name Identifies a required CloudCenter attribute name required for each API call. For example, tenant.Value Identifies a generated CloudCenter value required for each API call. For example, , is the actual value for the attributetenantIdand will be replaced by the ID ( will indicated a tenant with the ID of 1).tenants/1

CloudCenter 3.x APIs are available for 4.x. However, the documentation style differs for each release.CloudCenter

CloudCenter 4.x: A nested attributes structure allows for consistent documentation for each attribute down to the level.API ElementsIf multiple APIs (or attributes) use the same element, the same description and details are visible in the APIs using this element.Exceptions are documented within the same element description.

CloudCenter 3.x:A flat structure with attributes specific to each API.If multiple APIs use the same element, the description and details may differ for each occurrence.

CliQr API date and time values are formatted in to the millisecond level. The APIs are agnostic to dates and time zones.Unix time

For each API request, you see two common attributes displayed in the API response:

The URL: A unique URL that provides access to the requested resource CloudCenter Resource.The POST and PUT (see ) API calls additionally provide an attribute for each new .HTTPS Request Methods id CloudCenter Resource

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/Attribute+Typeshttp://docs.cliqr.com/display/40API/API+Elementshttp://en.wikipedia.org/wiki/Unix_timehttp://docs.cliqr.com/display/40API/resourcehttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResourcehttp://docs.cliqr.com/display/40API/idhttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResource



See for additional contextResponse Schema

The GET (view or list) APIs support pagination by default. CloudCenter APIs use the following attributes to provide paginated results:

Pagination Request Attributes

page

Description: The total number of pages in for the API listing.Default = 0If , then the value is ignored.=0size pageIf not specified ( ), the default (default = 20) value displays the first 20 elements, which is equal to one pagepage=0&size=20 sizeIf you specify both the page and the size values, the following applies:

If you specify... ...then

=21size Elements numbered 21 - 40 entities are displayed, which is equal to 2 pages

page=0 (or not specified)

The first set of 20 elements in the list, elements 1 to 20 are displayed

page=1 The second set of 20 elements in the list, elements 21 to 40 are displayed

page=2 The third set of 20 elements in the list (the third page).

page=1&& =10size A set of 10 elements, Elements 11 to 20 are displayed



Type: Integer

size

: Total number of elements that any list page should contain.DescriptionThe default is 20.If the size is 0 (zero), then all elements are returned and the value is ignored.page: IntegerType

Pagination Response Attributes

pageResource

Description: Identifies the pagination information for each resourceType: Sequence of attributes

if the page does not have more than 10 elements, then only those 10 elements are displayed.

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/sizehttp://docs.cliqr.com/display/40API/page



size

: Total number of elements that any list page should contain.DescriptionThe default is 20.If the size is 0 (zero), then all elements are returned and the value is ignored.page: IntegerType

pageNumber

Description: The page number that the client wants to fetch. Page numbers start with 0 (default).Type: Integer

totalElements

Description: The number resources that an API call returnsType: Long

totalPages

Description: The number of pages in a response Type: Integer

All list APIs support sorting by default. CliQr APIs use the query-string parameters to provide sorted results with a comma-separated set ofproperty names.

Ascending order: Default when you specify the property.

Descending order: Append a dash to the property.

The following example displays the use of sorting and pagination attributes in the same API request.

Sorting Examples

sort=id,name: Sort by ID property in ascending order and then sort by name property in ascending order. sort=id,name-,description: Sort by ID property in ascending order, then sort by name property in descending order, and finally sort bydescription in ascending order.

Property Name Validation

Property names in sort parameters are validated. For example, APIs that return a list of users can sort only on properties exposed by the userobject as sortable.

The HTTP Status code and the Location URL (highlighted in blue in the following example) is provided in the Response Header when Create res API calls are successful:ource

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/pagehttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResourcehttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResource



HTTP Status Code: See the next section ( )) for additional details.HTTP Response Codes (StatusHTTP Location URL: Also referred to as the location URL, the location header displays the status tracking URL for each API operation.Federated Management: All published APIs can be made to target the Child CCM by hitting the Parent CCM using the x-ccid header. See

, , and for additional context.Federated CCM Management Resource Propagation Federated Management APIs

CliQr APIs return one or more of the following HTTPS status codes for all (synchronous and asynchronous) API requests:

HTTPResponseCode

Status Description

200 Success

Successful GET and PUT

201 Successful POST (when a resource is created)

202 Request accepted for a time-consuming task (asynchronous update and created requests). If a request is pending,CliQr provides a URL for this request's end status.

You can issue GET calls until the request completes.

204 Successful DELETE

30x Redirection Only displays if a client calls an API using HTTP instead of HTTPS

400 Clientfailure

Validation error. This category has additional error codes in the response body for each API (as applicable). CliQrdocumentation tries to identify these codes where available. See the multiple problematic attributes example below.

401 Not authenticated

403 Forbidden. You do not have the required level to access the Permission Control CloudCenter Resource

404 Resource not found

500 Serverfailure

Server error: The server failed to respond to this request due to an internal error

Sample Error Responses

See .API Error Codes

Both CloudCenter admins and users can use CloudCenter REST APIs.

http://docs.cliqr.comhttp://docs.cliqr.com/display/CCD42/Federated+CCM+Managementhttp://docs.cliqr.com/display/CCD42/Resource+Propagationhttp://docs.cliqr.com/display/CCD42/Permission+Controlhttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResource



1. 2.

3.

Your login credentials determine if you are an admin (platform (root), tenant admin, or co-admin) or a user. If you do not have the required Permis level to access any you receive the HTTP 403 status error mentioned in the sectionsion Control CloudCenter Resource, HTTP Status Codes

above.

See the glossary, and for additional context. People Manage Admin Users Create Standard Users

When viewing the responses for user-related APIs, the attributes mentioned in this section help you differentiate the original tenant admin (owner)from a promoted co-admin.

View the and attributes in the API response:type coAdmin View Users

type coAdmin Description

Tenant false This is a tenant admin (owner).

Tenant true This is a promoted co-admin.

Synchronous and Asynchronous APIs

CloudCenter APIs supports both synchronous and asynchronous calls. Some APIs return data in the response body and others will only return aHTTP status. For example, CloudCenter DELETE calls return a after deleting the in theStatus 204 No Content CloudCenter Resourcebackground.

Synchronous APIs indicate that the program execution waits for a response to be returned by the API. The execution does not proceed until thecall is completed. The real state of the API request is available in the response.

Asynchronous APIs do not wait for the API call to complete. Program execution continues, and until the call completes, you can issue GETrequests to review the state after the submission, during the execution, and after the call completion.

As asynchronous calls may take some time to complete, they return responses containing information with a HTTP Status Code HTTP Location, which allows you to retrieve the progress, status, response, and other information for the call.URL

After submitting an asynchronous API call:

Retrieve the resource URL from the .HTTP Location URLUse this location URL and query the system using GET calls. While the call is in progress and you issue the GET request, you getadditional details of the operation being performed. These details are only available while the operation is in various states of execution(RUNNING, SUCCESS, FAILED).When the asynchronous API call completes successfully, issue a GET request to view the SUCCESS state and the URL for thisresourceoperation. For an example of an asynchronous call, see is an asynchronous call. See Create User with Activation Resource URL and IDfor additional context.

Call States

In the following example of a API:Create Cloud Account

The various states of execution (RUNNING, SUCCESS, FAILED) are highlighted in corresponding colorsThe first and last GET requests are in bold to show the sequence of events

Each tenant can only have one tenant admin (owner) but multiple tenant co-admins. See forPromote User to Sub-tenant Owneradditional context.

http://docs.cliqr.comhttp://docs.cliqr.com/display/CCD42/Permission+Controlhttp://docs.cliqr.com/display/CCD42/Permission+Controlhttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResourcehttp://docs.cliqr.com/display/CCD42/Overview#Overview-CloudCenterResourcehttp://docs.cliqr.com/display/CCD42/Peoplehttp://docs.cliqr.com/display/CCD42/Manage+Admin+Usershttp://docs.cliqr.com/display/CCD42/Create+Standard+Usershttp://104.197.90.78/display/GS/Overview#Overview-CloudCenterResourcehttp://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-HTTPStatusCodeshttp://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-HTTPLocationURLhttp://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-HTTPLocationURLhttp://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-HTTPLocationURLhttp://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-ResourceURLandIDhttp://docs.cliqr.com/display/CCD42/Manage+Admin+Users#ManageAdminUsers-PromoteUsertoSub-TenantOwner



Example :Create User with ActivationSample response for an asynchronous operation

{ "operationId": "888210d0-bde9-44d8-a9a5-a273d000c427", "status": "SUCCESS", "msg": "Finished", "progress": 100, "timestamp": 1464909251317, "additionalParameters": null, "operationHistory": [ "", "", "Starting task: activateUserAccount", "Validating user and applying default cloud settings", "Validated user and applied default cloud settings successfully", "Finished task: activateUserAccount", "Starting task: activateCloudAccounts", "Activating user account on cloud 'Amazon US East (Virginia)'", "Activation of user account on cloud 'Amazon US East (Virginia)'completed successfully", "Finished task: activateCloudAccounts", "Starting task: initializeCredit", "Initializing Singup/Bundle credit for the user", "Applied Signup/Bundle credit successfully", "Finished task: initializeCredit", "Starting task: addDefaultPolicy", "Applied default policies successfully", "Finished task: addDefaultPolicy", "Starting task: importApps", "No apps found for import", "Finished task: importApps", "Finished" ], "subtaskResults": { "activateUserAccount": { "operationId": "38b0d915-44c8-49ff-a58c-06ae7a1f72f5", "status": "SUCCESS", "msg": "Finished task: activateUserAccount", "progress": 100,

http://docs.cliqr.com



"timestamp": 1464909251130, "additionalParameters": null, "operationHistory": [ "Starting task: activateUserAccount", "Validating user and applying default cloud settings", "Validated user and applied default cloud settingssuccessfully", "Finished task: activateUserAccount" ], "subtaskResults": null, "resourceUrl": null }, "activateCloudAccounts": { "operationId": "79d9d83a-8eb2-4764-9884-8afbcc669f5e", "status": "SUCCESS", "msg": "Finished task: activateCloudAccounts", "progress": 100, "timestamp": 1464909251229, "additionalParameters": null, "operationHistory": [ "Starting task: activateCloudAccounts", "Activating user account on cloud 'Amazon US East(Virginia)'", "Activation of user account on cloud 'Amazon US East(Virginia)' completed successfully", "Finished task: activateCloudAccounts" ], "subtaskResults": null, "resourceUrl": null }, "initializeCredit": { "operationId": "94d281d7-a85e-4784-855b-f8a52a45e535", "status": "SUCCESS", "msg": "Finished task: initializeCredit", "progress": 100, "timestamp": 1464909251255, "additionalParameters": null, "operationHistory": [ "Starting task: initializeCredit", "Initializing Singup/Bundle credit for the user", "Applied Signup/Bundle credit successfully", "Finished task: initializeCredit" ], "subtaskResults": null, "resourceUrl": null }, "addDefaultPolicy": { "operationId": "a5af132b-2554-4a36-95be-18bf77549622", "status": "SUCCESS", "msg": "Finished task: addDefaultPolicy", "progress": 100, "timestamp": 1464909251287, "additionalParameters": null, "operationHistory": [ "Starting task: addDefaultPolicy", "Applied default policies successfully", "Finished task: addDefaultPolicy" ], "subtaskResults": null,




"resourceUrl": null }, "importApps": { "operationId": "43dacfe5-0a4b-497f-b8eb-8a6702381711", "status": "SUCCESS", "msg": "Finished task: importApps", "progress": 100, "timestamp": 1464909251290, "additionalParameters": null, "operationHistory": [ "Starting task: importApps", "No apps found for import", "Finished task: importApps" ], "subtaskResults": null, "resourceUrl": null }




}, "resourceUrl": "/v1/users/5"}

Operation ID Availability

Operation IDs (displayed below the Location URL in the above image) allow you to to query the status of asynchronous APIs and are onlyavailable for a brief period as identified in the following table:

Operation ID Availability Description

5 minutes The Operation ID is available for five minutes if the operation completes (regardless of success or failure).

1 hour The Operation ID is available for one hour if the operation times out and does not complete.

API AuthenticationOverviewAuthentication Format in CURL RequestsCloudCenter Users Making API callsSuccessful AuthenticationSession Length

CliQr APIs require the following authentication details for each API call:

UsernameAPI access key

Standalone CURL Request Example:

curl -H "Accept:application/json" -H "Content-Type:application/json" -u writer:BED74F4D9BFE0DA0 -X GEThttps://:/v1/users/27

In this CURL request example:

writer1 is the usernameBED74F4D9BFE0DA0 is the API accessKey

Your can retrieve the username and API access key from the UI. See for additional details.tenant administrator API Management Key

For a CloudCenter user to make API calls, the must first . Once activated, the for this usertenant administrator Activate this User (user)statusdisplays ENABLED in response to the call:View Users

The CliQr authentication HTTP header ( ) is no longer required when making standalone REST API callsX-CLIQR-API-KEY-AUTH:trueusing the username/API Key credentials.

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/usernamehttp://docs.cliqr.com/display/40API/accessKeyshttp://docs.cliqr.com/display/CCD42/Create+Standard+Usershttp://docs.cliqr.com/display/40API/%28user%29status



1. 2. 3.

4.

{ "id": "27", "resource": null, "perms": [], "username": "writer", "password": "== red-acted ==", "enabled": false, "type": "TENANT", "firstName": "CliQr", "lastName": "Docs", "companyName": "Cliqr", "tenantId": "1", "emailAddr": "writer@ ",cliqr.com "emailVerified": true, "phoneNumber": "", "externalId": "", "accessKeys": "https://:/v1/users/27/keys", "disableReason": "TrialCreditExhausted", "accountSource": "AdminCreated", "status": "ENABLED", "detail": null, "activationData": null, "created": 1434579231000, "lastUpdated": 1434579231000, "coAdmin": true}

On successful authentication, CliQr sends a browser cookie to maintain the authentication session. The cookie forwards the information to theserver for each API call so you do not need to authenticate each time you make an API call. If you do not want to maintain cookies in yourbrowser, you can send the authentication information for each API request. Once authenticated, you can begin making API calls.

The CCM UI's authentication session times out after 15 minutes. If you use a REST client to make API calls by authenticating through the CCMUI's, this session timeout applies to the REST client as well.

However, if you add and save the REST client authentication headers or if you issue CURL commands with the authentication details, you cancircumvent the session timeout restriction.

Manage API KeyYou need an to use CloudCenter APIs. This key is also referred to as the or in the API attributes andAPI management key API key access keyresponses. Users can generate/regenerate an API management key (or the tenant administrator can generate/regenerate the API managementkey for any user within their tenant) by using the CCM UI or the API. CliQr validates the user name and password of API clientsCreate API Keymaking HTTPS Request.

To generate the management key from the UI, follow this procedure:

Use your tenant administrator credentials to login the CCM UI.Click the > link in the left pane and access the Users page.Admin UsersSearch for the required user and select from the Actions dropdown list to access the Manage API Key page for thisManage API Keyuser.Click the button to generate a new API access key for this user.generate new key

This user can now make REST API calls using this user name and key.

http://docs.cliqr.comhttp://cliqr.com



1. 2.

3.

To generate the management key using API, follow this procedure:

Issue the call to retrieve the URL issued by CliQr.View UsersRetrieve the URL to retrieve the for this user.accessKeys

Use the accessKeys URL (see Step 1 above) to retrieve the API access key. The following image depicts a REST Client call to retrievethe API access key..

API AuthenticationaccessKeys

Base URI FormatThe base URI format is https:// :/v1/

The host is generally represented as in all CloudCenter APIs. It represents the IP address or the DNS name.

The host differs based on your :Deployment Model

CliQr-Hosted Deployments: CliQr provides the host name.Customer-Hosted Deployments: The client provides the host name based on CliQr's URI format.

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/accessKeyshttp://docs.cliqr.com/display/CCD42/Deployment+Models



The port is generally represented at in all CloudCenter APIs. It represents the port used to connect to the CCO server for the APIconnection. The in the REST endpoint is . You can decide if you want to use the port for each API call. All CloudCenter APIoptionalrequests and responses display in all examples.

curl -H "Accept:application/json" -H "Content-Type:application/json" -u \cliqradmin:40E45DBE57E35ECB -X GET https://:/v1/users

The current CliQr API version is v1.

Attributes used to make the API call are displayed after the API requests and responses and called out as Request Attributes or ResponseAttributes depending on where they appear. Each attribute (or group of attributes) are identified by the blue header text. For example:

This is single attribute:

emailAddr

Description: Unique (in the system) email address for this resource and must match the regular expressionType: String

This is group of attributes:

contractId

Description: a contract belonging to this tenant.Unique, system-generated identifier forType: String

bundleId

Description: for the bundleUnique, system-generated identifier belonging to this tenant.Type: String

planId

Description: the plan belonging to this tenant. The default is .Unique, system-generated identifier for NullType: String

activateRegions

Description: Cannot be an empty array, needs to have at least one entry in the array with a valid cloud region's value.regionIdType: Array of key-value pairs (of type map)

regionId

Description: the cloud regionUnique, system-generated identifier for Type: String

Required.

agreeToContract

Description: Indicates whether the user has agreed to the tenant organization contract.true = The user has agreed to the tenant organization contract false = Default. The user has not agreed to the tenant organization contract

Type: Boolean

http://docs.cliqr.comhttp://docs.cliqr.com/display/40API/regionId



importApps

Description: Array of unique identifiers for applications from the tenant Marketplace that will be made available to this user on activation.The default is an empty array.Type: String (array)

sendActivationEmail

Description: Indicates whether the system sends an email message to the activated user. = The system sends an email message on user activationtrue = Default. The system does not send an email message on user activationfalse

Type: Boolean

HTTPS Request MethodsCloudCenter APIs use HTTPS Version 1 to support the following request methods:

GET: To query or view the server information based on a CloudCenter deploymentPUT: To replace the entire object for update operationsPOST: To perform a CloudCenter platform task or creating the resourceDELETE: To remove specific aspects of the CloudCenter deployment

GET APIs

View Users

View User's Keys

View Tenants

View Tenant Cloud Instance Type Overrides

View Services

View Roles

View Reports

View Propagated Link Details

View Projects

View Policies

View Plans

View Phases

View Parent CCM Details

View Log Elements

View Keys

View Image

View Groups

View Deployment Environments

View Custom Actions

View Contracts

View Clouds

View Cloud Regions

View Cloud Properties

View Cloud Instance Types

View Cloud Image Mapping

View Cloud Families

View Cloud Accounts

View Child CCM Details




View CCO Configuration

View Bundles

View Activation Profiles

View Action Policies

View ACL Resource Details

View ACL Entities

List VMs

List Jobs

List Applications by Category

List Applications

List Application Profile Categories

Get Supported Cloud Details

Get Operation Status

Get Job Details

Get Application Details

Get All Versions of an Application

Fetch Job-Associated VM Details

Export Marketplace Application Profiles

Export Application Profiles

Download Self Certificate

PUT APIs

Upgrade Running Deployment

Update User

Update Tenant

Update Service

Update Role

Update Project

Update Plan

Update Phase

Update Log Elements

Update Link Permissions

Update Image

Update Group

Update Deployment Environment

Update Custom Action

Update Contract

Update Cloud Region

Update Cloud Instance Type Override

Update Cloud Instance Type

Update Cloud Image Mapping

Update Cloud Accounts

Update Cloud

Update CCO Configuration

Update Bundle

Update an Application

Update Activation Profile




Update Action Policy

Update ACL Resource Details

Update Access to Child CCM

Synchronize VM Cloud Information

Suspend Job

Stop Job

Resume Job

Reconfigure Running Job

Power On/Off or Reboot/Terminate VM

Deployment VM Operations

Create API Key

Create Action Policy

Approve Link Request

Accept Link Confirmation

POST APIs

Validate Workflow

Upload Logo

Upload Link Certificate

Sync Cloud Region Image Mappings

Sync Cloud Instance Types

Submit Job

Restart Deployment

Publish Project

Propagate Changes to Child CCM

Perform User Actions

Perform Tenant Actions

Perform Cloud Account Actions

Initiate Federated Link

Import Marketplace Application Profiles

Import Application Profiles

Enable Action Policy

Create User without Activation

Create User with Activation

Create Tenant

Create Service

Create Role

Create Project

Create Plan

Create Phase

Create Image

Create Group

Create Deployment Environment

Create Custom Action

Create Contract

Create Cloud Region

Create Cloud Instance Type Override




Create Cloud Instance Type

Create Cloud Image Mapping

Create Cloud Account

Create Cloud

Create Bundle

Create Activation Profile

DELETE APIs

Delete User

Delete Tenant

Delete Service

Delete Role

Delete Project

Delete Plan

Delete Phase

Delete Marketplace Application Profile

Delete Image

Delete Group

Delete Established Link

Delete Deployment Environment

Delete Deployment

Delete Custom Action

Delete Contract

Delete Cloud Region

Delete Cloud Instance Type

Delete Cloud Image Mapping

Delete Cloud Account

Delete Cloud

Delete Bundle

Delete Application Profile

Delete Activation Profile

Delete Action Policy

Response SchemaCliQr APIs issue responses using both JSON and XML formats.

You can set the response format by sending the appropriate Content-Type request headers:

JSON (Default)

Content-Type: application/json Accept: application/json

XML

Content-Type: application/xml Accept: application/xml

CSV (Only for Reports)

Content-Type: application/csv Accept: text/csv

The CSV format only applies to the .Report Management APIs




API Error CodesOverviewHTTP Status CodesSample Error MessagesCloudCenter 4.x Error DescriptionCloudCenter 3.x Error Description

This section provides details for all CloudCenter API error messages. Each CliQr error message provides two major attributes:

Code: Generally upper case words separated by underscores. This message is generally the essence of the problem. For example:ID_SHOULD_NOT_BE_SET_FOR_CREATING_RESOURCEMessage: Additional details about the problem. For example:The id should not be set for creating resource.

See the CloudCenter 4.x Error Description section later in this page.

See > HTTP Status Codes.CloudCenter API Overview

The following is a sample error response to a CloudCenter 4.x API request:

{ "errors": [ { "code": "FIELD_VALUE_SHOULD_BE_PROVIDED", "message": "startDate is a mandatory field and a value should be provided.", "detail": null, "moreInfo": null } ]}

The following error message indicates that multiple attributes are problematic and you will need to address each item for this API call to work.

Most CloudCenter 3.x APIs issue a numeric error code instead of a upper case words separated by underscores. For example:

ERROR-50002=Format of date is incorrect.




{ "errors": [ { "code": "FIELD_VALUE_MISMATCH_BETWEEN_URL_AND_BODY", "message": "tenantId value does not match between resource URL andresource (3 != null).", "detail": null, "moreInfo": null }, { "code": "FIELD_NOT_A_NUMBER", "message": "tenantId (= \"null\") should be a number.", "detail": null, "moreInfo": null }, { "code": "FIELD_LESS_THAN_ZERO", "message": "tenantId (= \"null\") should be greater than zero.", "detail": null, "moreInfo": null } ]}

The following is a sample response to a 3.x API request

{ "status": 400, "code": 40014, "err": "Cloud Amazon-eu-west-2 is not a member of Deployment Environment with Id2."}

The following is another sample response to a 3x API request:

{ "status": 400, "code": 400, "err": "InvalidCloudType:OpenStack-regionOne", "devMessage": "InvalidCloudType:OpenStack-regionOne"}

Error Type Code and Message

Frameworkerrors

BAD_DATA

Failed to parse the request body

INTERNAL_SERVER_ERROR

Internal Server Error




UNAUTHORIZED

User does not have access to this resource

Common errors

ID_NOT_A_NUMBER

{1}{0} (= " ) should be a number."

ID_SHOULD_BE_GREATER_THAN_ZERO

{1}{0} (= " ) should be greater than zero"

ID_SHOULD_NOT_BE_SET_FOR_CREATING_RESOURCE

id should not be set for creating resource

VALUE_MISMATCH_BETWEEN_URL_AND_BODY

value does not match between resource URL and resource ({1} != {2})

VALUE_MISMATCH

Value of {0} field should not be changed ({1} != {2} )

FIELD_VALUE_SHOULD_BE_PROVIDED

{0} is a mandatory field and a value should be provided

FIELD_VALUE_SHOULD_NOT_BE_PROVIDED

{0} has default value and should not be provided for create.

FIELD_VALUE_SHOULD_NOT_BE_PROVIDED_FOR_UPDATE

{0} should not be provided for update

OBJECT_SHOULD_NOT_HAVE_DEPENDENT_OBJECTS

Object should not have dependent objects {0}

READ_ONLY_FIELD

{0} is a read only field and should not be set when creating or updating {1} resource

USER_IS_NOT_TENANT_ADMIN

Only tenant admin can perform this operation

LOGGEDIN_USER_IS_NOT_PARENT_OR_TENANT

Logged-In user is not admin of tenant {0}

PAGINATION_PAGE_SHOULD_NOT_BE_LESS_THAN_ZERO

page number should not be less than zero

PAGINATION_SIZE_SHOULD_NOT_BE_LESS_THAN_ZERO

page size should not be less than zero

PAGINATION_SORT_HAS_UNKNOWN_FIELDS

sort has unknown fields [{0}]

SEARCH_HAS_UNKNOWN_FIELDS

search has unknown fields [{0}]

SEARCH_HAS_TOO_FEW_FIELDS

Search has too few parameters. Please give all parameters - searchField,searchString and searchOper

SEARCH_OP_NOT_CORRECT

Search operation is not correct. Accepted values are - {0}




SEARCH_FIELD_NOT_CORRECT

Search field is not correct. Accepted values are - {0}

RESOURCE_NOT_FOUND

Requested resource[{0}] does not exist or is not accessible

RESOURCE_ALREADY_EXISTS

The {0} already exists

RESOURCE_WRONG_TYPEWrong plan type provided: [{0}]

METHOD_NOT_ALLOWED

Unsupported HTTP method used

ONLY_FORCE_CHANGE_PASSWORD_ACCESSIBLE

Only change password functionality is allowed. Please do not access other actions.

Input validation INVALID_INPUT_CHARACTERS

Invalid input characters detected in field {0}

Validation forcomponents

INVALID_CCM_ADDRESS

Invalid input: CCM address: {0}. Check CCM configuration.

INVALID_CCO_ADDRESS

Invalid input: Orchestrator address: {0}.

INVALID_GUA_ADDRESS

Invalid input: Remote Desktop Gateway address {0}.

User resource

CANNOT_ACCESS_ANOTHER_USER

Wrong permissions for user [{0}]

INVALID_EMAIL

Invalid email address

ACTIVATION_PROFILE_NOT_FOUND

Unable to find activationProfile[id={0}]

USER_IS_NOT_VENDOR_ADMIN

User is not vendor admin

USER_ACTION_IS_NOT_FOUND

User action is incorrect or not found

USER_IS_NOT_DISABLED

Enabled user can only be disabled. A disabled user can be deleted.

USER_ACTIVATE_ATLEAST_ONE_CLOUD_SHOULD_BE_ENABLED

At least one cloud region should be selected for activating user

USER_ACTIVATE_REGION_DOES_NOT_EXIST

Failed to find region[id={0}] for activate. Either region does not exist or user does not have access to the region

USER_ACTIVATE_REGION_NOT_ACCESSIBLE

Failed to find region[id={0}] for activate. Either region does not exist or user does not have access to the region




USER_ACTIVATE_CLOUD_REGION_NOT_RUNNING

User cannot be activated as selected cloudRegion[id={0}] is in STOPPED status

USER_ACTIVATE_FAILED_TO_FIND_CONTRACT

Cannot find contract[id={0}] for activating user

USER_ACTIVATE_FAILED_TO_FIND_BUNDLE

Cannot find bundle[id={0}] for activating user

USER_ACTIVATE_FAILED_TO_FIND_PLAN

Cannot find plan[id={0}] for activating user

USER_ACTIVATE_APPS_DOES_NOT_EXIST_OR_NOT_ACCESSIBLE

Cannot imports appIds{0} as they do not exist or user does not have access to the apps

USER_MANAGE_CLOUDS_REGIONS_ALREADY_ENABLED

Regions {0} are already setup for user

USER_IMPORT_APPS_ATLEAST_ONE_APP_SHOUD_BE_IMPORTED

At least one app should be imported

USER_IMPORT_APPS_ALREADY_IMPORTED

AppIds {0} are already imported

USER_ONLY_ACTIVE_USERS_CAN_RESET_PASSWORD

For resetting password user should be active

USER_PAYMENT_PROFILE_NOT_FOUND

Payment profile is not set for this user

USER_SELF_PASSWORD_RESET_DISABLED

Password self reset is disabled for this vendor

USER_ADD_USER_CREDIT_AMOUNT_SHOULD_BE_MORE_THAN_ZERO

Credit amount should be more than zero

USER_ADD_USER_CREDIT_VALID_FOR_DAYS_SHOULD_BE_MORE_THAN_ZERO

validForDays should be more than zero

USER_ADD_BUNDLE_CREDIT_BUNDLE_NOT_ACCESSIBLE

Bundle not accessible

USER_ADD_BUNDLE_CREDIT_ONLY_ONE_BUNDLE_ALLOWED_IN_TRIAL_MODE

User[id={0}] already has a bundle. In trial mode, the user you create can only have one bundle

USER_ADD_BUNDLE_CREDIT_ONLY_ONE_BUNDLE_ALLOWED_WITHOUT_PAYMENT_PROFILE

User[id={0}] already has a bundle. Without an active payment profile, the user you create can only have one bundle.

USER_CHANGE_PASSWORD_UNAUTHORIZED

User can only change password of his own account

USER_OLD_PASSWORD_INVALID

Old password should be valid

USER_NEW_PASSWORD_IS_EMPTY

New password should not be null or empty




USER_PASSWORD_MIN_LENGTH

Password should have minimum length of {0} characters

USER_PASSWORD_UPPERCASE

Password should have an uppercase character

USER_PASSWORD_LOWERCASE

Password should have a lowercase character.

USER_PASSWORD_DIGIT

Password should have a lowercase character

USER_PASSWORD_SPECIAL_CHARACTER

Password should have a special character

USER_ONLY_STANDARD_USERS_CAN_BE_CONVERTED_TO_CO_ADMIN

Only STANDARD users can be converted to VENDOR user

USER_ONLY_CO_ADMIN_USERS_CAN_BE_CONVERTED_TO_STANDARD

Only VENDOR users can be converted to STANDARD user

USER_VENDOR_OWNER_USER_CANNOT_BE_CONVERTED_TO_STANDARD

Vendor owner user cannot be converted to STANDARD user

USER_CANNOT_CONVERT_SELF_TO_STANDARD

User cannot convert self to standard user

Sub-tenantResource

SEARCH_SUBTENANTS

User is not authorized to search sub tenants

SEARCH_SUBTENANTS_AND_USERS

User is not authorized to search sub tenants and users.

Contractresource

CONTRACT_LENGTH_SHOULD_BE_GREATER_THAN_ZERO

length fields should be greater than zero

CONTRACT_SHOULD_NOT_HAVE_ACTIVE_USERS

Contract with active users cannot be deleted

CONTRACT_GET_SHOULD_HAVE_VALID_CONTRACT_ID

contractId should be valid

CONTRACT_TERMS_SHOULD_BE_PROVIDED

Contract terms should be provided

CONTRACT_SHOULD_NOT_BE_LINKED_TO_ACTIVATION_PROFILE

Contract [{0}] cannot be deleted as it is associated with the Activation Profile [{1}].

Logs LOG4J_INVALID_NODE_TYPE

Please provide a valid nodeType as query parameter. Valid nodeTypes are [{0}].

LOG4J_NULL_NODE_TYPE

The nodeType is or empty. Please provide a valid nodeType by 'nodeType' as query parameter. Valid nodeTypes are{0}.

LOG4J_NULL_CLOUD_REGION

The cloudRegion is or empty. Please provide valid cloud region identifier by 'regionId' as query parameter.




LOG4J_NULL_NODE_ID

The worker node is or empty. Please provide valid nodeId by 'nodeId' as query parameter.

LOG4J_CCO_ONLY_FOR_TENANT_ADMIN

Log4j packages can be read or updated only by tenant admin for CCO.

LOG4J_CCO_NO_USER_CLOUD_ACCOUNT

The tenant admin does not have any cloud account configured with the CCO.

LOG4J_NODE_NOT_RUNNING

The node [{0}] is in state [{1}]. Hence, log4j requests cannot be sent as it expects 'NodeReady' state.

LOG4J_JOB_NOT_RUNNING

The Job [{0}] that launched the node [{1}] is in state [{2}]. Hence, log4j requests cannot be sent as it expects 'JobRunning'state.

LOG4J_NO_ACCESS_FOR_USER

User [{0}] cannot do any log4j operations on node [{1}] as there is no manage (or) authorize privilege for the job [{1}] thatlaunched the node.

LOG4J_NODE_STATUS_NOT_EXIST

Status for node [{0}] does not exist.

LOG4J_JOB_NOT_EXIST

Job [{0}] does not exist.

LOG4J_JOB_STATUS_NOT_EXIST

Status for job [{0}] does not exist.

LOG4J_UNKNOWN_ERROR

Unknown exception got during validation of log4j requests for worker - [{0}].

LOG4J_INVALID_REGION_NAME

Not able to find a valid cloud. Region name could be invalid. Please check region identifier given as query parameter'regionId'.

LOG4J_REGION_NOT_ACCESSIBLE

Not able to access cloud. User [{0}] may not have proper access permission to the region name [{1}].

LOG4J_CLOUD_TYPE_NOT_SUPPORTED

The region [{0}] is neither supported nor activated.

LOG4J_PACKAGES_NOT_AVAILABLE

Package(s) [{0}] requested for update is not available in log4j configuration. Only update of existing packages are allowed.

LOG4J_PACKAGES_DISABLED_NO_LEVEL_UPDATE

Package(s) [{0}] are disabled in log4j configuration. Please enable it first using [{1}].

LOG4J_PACKAGES_ENABLE_UPDATE_NOT_POSSIBLE

Package(s) [{0}] cannot be enabled and updated for levels in one single request.

LOG4J_PACKAGES_READ_ERROR

Not able to read log4j package(s) - [{0}].

LOG4J_PACKAGES_NOT_FOUND

No log4j package(s) are defined in the log4j configuration file.




LOG4J_PACKAGES_NO_INPUT

Log4j package(s) [{0}] does not have any input to enable [{1}] or update log level [{2}].

Tenantresource

TENANT_USER_IS_NOT_TENANT_ADMIN_OR_PARENT

Only tenant admin or direct parent can perform this operation

USER_WITH_EMAIL_DOESNT_EXIST

User does not exist. Please create the user before creating the tenant

USER_IS_ALREADY_VENDOR_ADMIN

User [{0}] is already vendor admin

TENANT_DOMAIN_NAME_NOT_UNIQUE

Vendor Domain Name [{0}] is already in use. Please select another Vendor Domain Name

TENANT_DOMAIN_NAME_IS_INVALID

Vendor Domain Name [{0}] is invalid. Please select another Vendor Domain Name

TENANT_WITH_SAME_SHORT_NAME_ALREADY_EXISTS

A tenant with the same short name [{0}] already exists

DOMAIN_NAME_IS_SYNTACTICALLY_INVALID

Vendor Domain Name [{0}] is syntactically invalid. Please select another Vendor Domain Name.

ONLY_ACTIVE_USERS_CAN_BE_PROMOTED_TO_TENANT

Only active users can be converted to tenant

ACTIVATION_CODES_CANNOT_BE_CONFIGURED_WHILE_CREATING_TENANT

Activation codes cannot be configured while creating tenant. Add activation rules after creating tenant using update request.

FIREWALL_RULES_CANNOT_BE_CONFIGURED_WHILE_CREATING_TENANT

Fire wall rules cannot be configured while creating tenant. Add activation rules after creating tenant using update request.

ACTIVATION_CODE_TENANT_ID_MANDATORY

TenantId is mandatory field in activation code and a value should be provided

ACTIVATION_CODE_BAD_VALUE

User does not have access to {0} set in activation code

ACTIVATION_CODE_ACTIVATION_PROFILE_NOT_FOUND

Unable to find activationProfile[id={0}]

ACTIVATION_CODE_DUPLICATE_FOUND

ActivationCode names should be unique but found duplicate activation code names {0}

ACTIVATION_PROFILE_NAME_EXISTS

Activation profile with name {0} already exists. Please use different name.

ASSOCIATED_ACTIVATION_RULE_FOUND

The profile is used by one or m

Documents

Cisco CloudCenter REST API Guide, Release 4.5.x