Jump To Close Expand all Collapse all Table of contents REST API Guide 1. Introduction to OpenShift Enterprise Expand section "1. Introduction to OpenShift Enterprise" Collapse section "1. Introduction to OpenShift Enterprise" 1.1. Introduction to OpenShift API 1.2. Introduction to Representational State Transfer (REST) 2. General API Information Expand section "2. General API Information" Collapse section "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 Expand section "4. User Information" Collapse section "4. User Information" 4.1. View User Information 4.2. Parent and Child Accounts Expand section "4.2. Parent and Child Accounts" Collapse section "4.2. Parent and Child Accounts" 4.2.1. Delete Child Account 5. SSH Keys Expand section "5. SSH Keys" Collapse section "5. SSH Keys" 5.1. Add SSH Key 5.2. List User SSH Keys 5.3. Get SSH Key Information 5.4. Update SSH Key 5.5. Delete SSH Key 6. Authorizations Expand section "6. Authorizations" Collapse section "6. Authorizations" 6.1. Add an Authorization 6.2. List Authorizations 6.3. Get Authorization Information 6.4. Update an Authorization 6.5. Delete an Authorization 7. Domains Expand section "7. Domains" Collapse section "7. Domains" 7.1. Create a Domain 7.2. List Domains 7.3. List Domains by Owner 7.4. Get Domain Information 7.5. Update Domain 7.6. Remove Self from a Domain 7.7. Delete a Domain 8. Teams Expand section "8. Teams" Collapse section "8. Teams" 8.1. Create Team 8.2. List Teams 8.3. List Teams by Owner 8.4. Search Teams by Name 8.5. Get Team Information 8.6. Remove Self from a Team 8.7. Delete Team 9. Members Expand section "9. Members" Collapse section "9. Members" 9.1. List Members of a Domain 9.2. Add or Remove Domain Members 9.3. List Members of an Application 9.4. Add Team Member 9.5. List Members of a Team 9.6. Add or Remove Team Members 9.7. Get Member Information 9.8. Update Team Member 9.9. Delete Team Member 10. Quickstarts Expand section "10. Quickstarts" Collapse section "10. Quickstarts" 10.1. List Quickstarts 10.2. Show Quickstart 10.3. Search Quickstarts 11. Applications Expand section "11. Applications" Collapse section "11. Applications" 11.1. Resolve DNS 11.2. Create an Application 11.3. List Applications by Owner 11.4. List Applications for a User 11.5. List Applications for a Domain 11.6. List Applications and Cartridges 11.7. Get Application Information 11.8. Get Application and Cartridge Information 11.9. Update an Application 11.10. Enable High Availability (HA) on Application 11.11. Disable High Availability (HA) on Application 11.12. Start Application 11.13. Stop Application 11.14. Force Stop Application 11.15. Restart Application 11.16. Scale Up Application 11.17. Scale Down Application 11.18. Tidy Application Framework 11.19. Reload Application 11.20. Trigger Thread Dump 11.21. Delete Application 12. Application Aliases and SSL Certificates Expand section "12. Application Aliases and SSL Certificates" Collapse section "12. Application Aliases and SSL Certificates" 12.1. Add Application Alias 12.2. List Application Aliases 12.3. Get Application Alias Information 12.4. Update Application Alias 12.5. Delete Application Alias 13. Cartridges Expand section "13. Cartridges" Collapse section "13. Cartridges" 13.1. List Cartridges 13.2. Embedded Cartridges Expand section "13.2. Embedded Cartridges" Collapse section "13.2. Embedded Cartridges" 13.2.1. Add Embedded Cartridge 13.2.2. List Embedded Cartridges 13.2.3. Get Cartridge Information 13.2.4. Update Cartridge Configuration 13.2.5. Get Cartridge Status 13.2.6. Start Cartridge 13.2.7. Stop Cartridge 13.2.8. Restart Cartridge 13.2.9. Reload Cartridge 13.2.10. Delete Cartridge 14. Deployment Expand section "14. Deployment" Collapse section "14. Deployment" 14.1. List Application Deployments 14.2. Deploy an Application 14.3. Activate a Deployment of an Application 14.4. Update an Application Deployment 15. Environment Variables Expand section "15. Environment Variables" Collapse section "15. Environment Variables" 15.1. Add Environment Variable 15.2. List Environment Variables 15.3. Get Environment Variable Information 15.4. Update Environment Variable 15.5. Delete Environment Variable 16. Gear Groups Expand section "16. Gear Groups" Collapse section "16. Gear Groups" 16.1. Get Application Gear Groups 16.2. Get Application Gear Endpoints A. Valid Options for API Resources Expand section "A. Valid Options for API Resources" Collapse section "A. Valid Options for API Resources" A.1. SSH Keys A.2. Authorizations A.3. Domains A.4. Teams A.5. Members A.6. Applications A.7. Cartridges A.8. Deployments B. Revision History Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF 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” Previous Next