OpenShift Online


Reference documentation for OpenShift Online Representational State Transfer Application Programming Interface (REST API)

Red Hat OpenShift Documentation Team

Legal Notice

Copyright © 2014 Red Hat.
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, 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.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.


The OpenShift Online REST API Guide is a reference to the REST API of OpenShift Online. This guide explains each API resource, and where applicable, describes the parameters associated with that resource, with the resulting output example shown in JSON syntax. This provides the basis for developers to develop applications to interact with OpenShift Online.
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
2.2. We Need Feedback!
1. Introduction to OpenShift Online
1.1. About OpenShift API
1.2. About Representational State Transfer (REST)
2. General API Information
2.1. Authentication
2.2. Version
2.3. Resource Links
2.4. Response Information
2.5. Messages
2.6. Response Type
2.7. Status Codes
3. API Entry Point
4. User Information
4.1. View User Information
4.2. Parent and Child Accounts
4.2.1. Create Child Account
4.2.2. Delete Child Account
5. Subscription Plans
5.1. List Plans
5.2. Get Plan Information
5.3. Change Plan
6. SSH Keys
6.1. Add SSH Key
6.2. List User SSH Keys
6.3. Get SSH Key Information
6.4. Update SSH Key
6.5. Delete SSH Key
7. Authorizations
7.1. Add an Authorization
7.2. List Authorizations
7.3. Get Authorization Information
7.4. Update an Authorization
7.5. Delete an Authorization
8. Domains
8.1. Create a Domain
8.2. List Domains
8.3. List Domains by Owner
8.4. Get Domain Information
8.5. Update Domain
8.6. Remove Self from a Domain
8.7. Delete a Domain
9. Teams
9.1. Create Team
9.2. List Teams
9.3. List Teams by Owner
9.4. Search Teams by Name
9.5. Get Team Information
9.6. Remove Self from a Team
9.7. Delete Team
10. Members
10.1. List Members of a Domain
10.2. Add or Remove Domain Members
10.3. List Members of an Application
10.4. Add Team Member
10.5. List Members of a Team
10.6. Add or Remove Team Members
10.7. Get Member Information
10.8. Update Team Member
10.9. Delete Team Member
11. Quickstarts
11.1. List Quickstarts
11.2. Show Quickstart
11.3. Search Quickstarts
12. Applications
12.1. Resolve DNS
12.2. Create an Application
12.3. List Applications by Owner
12.4. List Applications for a User
12.5. List Applications for a Domain
12.6. List Applications and Cartridges
12.7. Get Application Information
12.8. Get Application and Cartridge Information
12.9. Update an Application
12.10. Enable High Availability (HA) on Application
12.11. Disable High Availability (HA) on Application
12.12. Start Application
12.13. Stop Application
12.14. Force Stop Application
12.15. Restart Application
12.16. Scale Up Application
12.17. Scale Down Application
12.18. Tidy Application Framework
12.19. Reload Application
12.20. Trigger Thread Dump
12.21. Delete Application
13. Application Aliases and SSL Certificates
13.1. Add Application Alias
13.2. List Application Aliases
13.3. Get Application Alias Information
13.4. Update Application Alias
13.5. Delete Application Alias
14. Cartridges
14.1. List Cartridges
14.2. Embedded Cartridges
14.2.1. Add Embedded Cartridge
14.2.2. List Embedded Cartridges
14.2.3. Get Cartridge Information
14.2.4. Update Cartridge Configuration
14.2.5. Get Cartridge Status
14.2.6. Start Cartridge
14.2.7. Stop Cartridge
14.2.8. Restart Cartridge
14.2.9. Reload Cartridge
14.2.10. Delete Cartridge
15. Deployments
15.1. List Application Deployments
15.2. Deploy an Application
15.3. Activate a Deployment of an Application
15.4. Update an Application Deployment
16. Environment Variables
16.1. Add Environment Variable
16.2. List Environment Variables
16.3. Get Environment Variable Information
16.4. Update Environment Variable
16.5. Delete Environment Variable
17. Gear Groups
17.1. Get Application Gear Groups
A. Valid Options for API Resources
A.1. Subscription Plans
A.2. SSH Keys
A.3. Authorizations
A.4. Domains
A.5. Teams
A.6. Members
A.7. Applications
A.8. Cartridges
A.9. Deployments
B. Revision History