OpenShift Online

REST API Guide

Using the OpenShift Online Representational State Transfer Application Programming Interface (REST API)

Edition 1.0

Legal Notice

Copyright © 2013 Red Hat, Inc.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, OpenShift, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
All other trademarks are the property of their respective owners.

Abstract

This document describes the Representational State Transfer (REST) API for OpenShift Online .
Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help
2.1. Do You Need Help?
2.2. We Need Feedback!
1. Introduction
1.1. Representational State Transfer
2. General API Information
2.1. Authentication
2.2. Version
2.3. Response Type
2.4. Link Navigation
2.5. API Status Codes
3. API Entry Point
4. Domains
4.1. List Domains
4.2. Create a Domain
4.3. Get Domain Information
4.4. Update Domain Name
4.5. Delete a Domain
5. Applications
5.1. List Applications
5.2. List Applications and Cartridges
5.3. Check DNS Availability
5.4. Create an Application
5.5. Get Application Information
5.6. Get Application and Cartridge Information
5.7. Start Application
5.8. Stop Application
5.9. Force Stop Application
5.10. Restart Application
5.11. Delete Application
5.12. Scale Up Application
5.13. Scale Down Application
6. Application Aliases and SSL Certificates
6.1. List Application Aliases
6.2. Add Application Alias
6.3. Update Application Alias
6.4. Remove Application Alias
7. Cartridges
7.1. List Cartridges
7.2. Embedded Cartridges
7.2.1. List Embedded Cartridges
7.2.2. Add Cartridge
7.2.3. Get Cartridge Information
7.2.4. Get Cartridge Status
7.2.5. Get Gear Groups
7.2.6. Start Cartridge
7.2.7. Stop Cartridge
7.2.8. Restart Cartridge
7.2.9. Reload Cartridge
7.2.10. Update Cartridge Configuration
7.2.11. Delete Cartridge
8. User Information
8.1. View User Information
8.2. Parent and Child Accounts
8.2.1. Delete Child Account
9. Subscription Plans
9.1. List Plans
9.2. Get Plan Information
9.3. Change Plan
10. SSH Keys
10.1. List User SSH Keys
10.2. SSH Key Management
10.2.1. Add SSH Key
10.2.2. Get SSH Key Information
10.2.3. Update SSH Key
10.2.4. Delete SSH Key
A. Supported SSH Keys
B. Revision History