Show Table of Contents Hide Table of Contents English English Multi-page HTML Single-page HTML PDF ePub REST API Guide1. Introduction to OpenShift Enterprise1.1. Introduction to OpenShift API1.2. Introduction to Representational State Transfer (REST)2. General API Information2.1. Authentication2.2. Version2.3. Resource Links2.4. Response Information2.5. Messages2.6. Response Type2.7. Status Codes3. API Entry Point4. User Information4.1. View User Information4.2. Parent and Child Accounts4.2.1. Delete Child Account5. SSH Keys5.1. Add SSH Key5.2. List User SSH Keys5.3. Get SSH Key Information5.4. Update SSH Key5.5. Delete SSH Key6. Authorizations6.1. Add an Authorization6.2. List Authorizations6.3. Get Authorization Information6.4. Update an Authorization6.5. Delete an Authorization7. Domains7.1. Create a Domain7.2. List Domains7.3. List Domains by Owner7.4. Get Domain Information7.5. Update Domain7.6. Remove Self from a Domain7.7. Delete a Domain8. Teams8.1. Create Team8.2. List Teams8.3. List Teams by Owner8.4. Search Teams by Name8.5. Get Team Information8.6. Remove Self from a Team8.7. Delete Team9. Members9.1. List Members of a Domain9.2. Add or Remove Domain Members9.3. List Members of an Application9.4. Add Team Member9.5. List Members of a Team9.6. Add or Remove Team Members9.7. Get Member Information9.8. Update Team Member9.9. Delete Team Member10. Quickstarts10.1. List Quickstarts10.2. Show Quickstart10.3. Search Quickstarts11. Applications11.1. Resolve DNS11.2. Create an Application11.3. List Applications by Owner11.4. List Applications for a User11.5. List Applications for a Domain11.6. List Applications and Cartridges11.7. Get Application Information11.8. Get Application and Cartridge Information11.9. Update an Application11.10. Enable High Availability (HA) on Application11.11. Disable High Availability (HA) on Application11.12. Start Application11.13. Stop Application11.14. Force Stop Application11.15. Restart Application11.16. Scale Up Application11.17. Scale Down Application11.18. Tidy Application Framework11.19. Reload Application11.20. Trigger Thread Dump11.21. Delete Application12. Application Aliases and SSL Certificates12.1. Add Application Alias12.2. List Application Aliases12.3. Get Application Alias Information12.4. Update Application Alias12.5. Delete Application Alias13. Cartridges13.1. List Cartridges13.2. Embedded Cartridges13.2.1. Add Embedded Cartridge13.2.2. List Embedded Cartridges13.2.3. Get Cartridge Information13.2.4. Update Cartridge Configuration13.2.5. Get Cartridge Status13.2.6. Start Cartridge13.2.7. Stop Cartridge13.2.8. Restart Cartridge13.2.9. Reload Cartridge13.2.10. Delete Cartridge14. Deployment14.1. List Application Deployments14.2. Deploy an Application14.3. Activate a Deployment of an Application14.4. Update an Application Deployment15. Environment Variables15.1. Add Environment Variable15.2. List Environment Variables15.3. Get Environment Variable Information15.4. Update Environment Variable15.5. Delete Environment Variable16. Gear Groups16.1. Get Application Gear Groups16.2. Get Application Gear EndpointsA. Valid Options for API ResourcesA.1. SSH KeysA.2. AuthorizationsA.3. DomainsA.4. TeamsA.5. MembersA.6. ApplicationsA.7. CartridgesA.8. DeploymentsB. Revision HistoryLegal Notice A.5. Members Name Valid Options role view; edit; admin; none [a] id login type user; team [b] [a] Note that only the view option is valid when adding members to a team. [b] Note that only the user option is valid when adding members to a team. See Also: Section 9.2, “Add or Remove Domain Members” Section 9.4, “Add Team Member” Section 9.6, “Add or Remove Team Members” Section 9.8, “Update Team Member” A.4. Teams A.6. Applications
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.