Red Hat Quay API guide
Red Hat Quay API Guide
Abstract
Red Hat Quay API guide
Red Hat Quay API Guide
Abstract
- Preface
- 1. Introduction to Red Hat Quay OAuth 2.0 tokens
- 2. Using the Red Hat Quay API
- 3. Red Hat Quay Application Programming Interface (API)
- 3.1. Authorization
- 3.2. appspecifictokens
- 3.3. build
- 3.4. discovery
- 3.5. error
- 3.6. globalmessages
- 3.7. logs
- 3.8. manifest
- 3.9. mirror
- 3.10. namespacequota
- 3.10.1. listUserQuota
- 3.10.2. getOrganizationQuotaLimit
- 3.10.3. changeOrganizationQuotaLimit
- 3.10.4. deleteOrganizationQuotaLimit
- 3.10.5. createOrganizationQuotaLimit
- 3.10.6. listOrganizationQuotaLimit
- 3.10.7. getUserQuotaLimit
- 3.10.8. listUserQuotaLimit
- 3.10.9. getOrganizationQuota
- 3.10.10. changeOrganizationQuota
- 3.10.11. deleteOrganizationQuota
- 3.10.12. createOrganizationQuota
- 3.10.13. listOrganizationQuota
- 3.10.14. getUserQuota
- 3.11. organization
- 3.11.1. createOrganization
- 3.11.2. validateProxyCacheConfig
- 3.11.3. getOrganizationCollaborators
- 3.11.4. getOrganizationApplication
- 3.11.5. updateOrganizationApplication
- 3.11.6. deleteOrganizationApplication
- 3.11.7. createOrganizationApplication
- 3.11.8. getOrganizationApplications
- 3.11.9. getProxyCacheConfig
- 3.11.10. deleteProxyCacheConfig
- 3.11.11. createProxyCacheConfig
- 3.11.12. getOrganizationMember
- 3.11.13. removeOrganizationMember
- 3.11.14. getOrganizationMembers
- 3.11.15. getOrganization
- 3.11.16. changeOrganizationDetails
- 3.11.17. deleteAdminedOrganization
- 3.11.18. getApplicationInformation
- 3.12. permission
- 3.13. policy
- 3.13.1. createOrganizationAutoPrunePolicy
- 3.13.2. listOrganizationAutoPrunePolicies
- 3.13.3. getOrganizationAutoPrunePolicy
- 3.13.4. deleteOrganizationAutoPrunePolicy
- 3.13.5. updateOrganizationAutoPrunePolicy
- 3.13.6. createRepositoryAutoPrunePolicy
- 3.13.7. listRepositoryAutoPrunePolicies
- 3.13.8. getRepositoryAutoPrunePolicy
- 3.13.9. deleteRepositoryAutoPrunePolicy
- 3.13.10. updateRepositoryAutoPrunePolicy
- 3.13.11. createUserAutoPrunePolicy
- 3.13.12. listUserAutoPrunePolicies
- 3.13.13. getUserAutoPrunePolicy
- 3.13.14. deleteUserAutoPrunePolicy
- 3.13.15. updateUserAutoPrunePolicy
- 3.14. prototype
- 3.15. referrers
- 3.16. repository
- 3.17. repositorynotification
- 3.18. robot
- 3.18.1. getUserRobots
- 3.18.2. getOrgRobotPermissions
- 3.18.3. regenerateOrgRobotToken
- 3.18.4. getUserRobotPermissions
- 3.18.5. regenerateUserRobotToken
- 3.18.6. getOrgRobot
- 3.18.7. createOrgRobot
- 3.18.8. deleteOrgRobot
- 3.18.9. getOrgRobots
- 3.18.10. getUserRobot
- 3.18.11. createUserRobot
- 3.18.12. deleteUserRobot
- 3.18.13. Auth Federated Robot Token
- 3.18.14. createOrgRobotFederation
- 3.19. search
- 3.20. secscan
- 3.21. superuser
- 3.21.1. createInstallUser
- 3.21.2. deleteInstallUser
- 3.21.3. listAllUsers
- 3.21.4. listAllLogs
- 3.21.5. listAllOrganizations
- 3.21.6. createServiceKey
- 3.21.7. listServiceKeys
- 3.21.8. changeUserQuotaSuperUser
- 3.21.9. deleteUserQuotaSuperUser
- 3.21.10. createUserQuotaSuperUser
- 3.21.11. listUserQuotaSuperUser
- 3.21.12. changeOrganizationQuotaSuperUser
- 3.21.13. deleteOrganizationQuotaSuperUser
- 3.21.14. createOrganizationQuotaSuperUser
- 3.21.15. listOrganizationQuotaSuperUser
- 3.21.16. changeOrganization
- 3.21.17. deleteOrganization
- 3.21.18. approveServiceKey
- 3.21.19. deleteServiceKey
- 3.21.20. updateServiceKey
- 3.21.21. getServiceKey
- 3.21.22. getRepoBuildStatusSuperUser
- 3.21.23. getRepoBuildSuperUser
- 3.21.24. getRepoBuildLogsSuperUser
- 3.21.25. getRegistrySize
- 3.21.26. postRegistrySize
- 3.22. tag
- 3.23. team
- 3.24. trigger
- 3.25. user
- 3.26. Definitions
- 4. API configuration examples
Preface
+
- Preface
- 1. Introduction to Red Hat Quay OAuth 2.0 tokens
- 2. Using the Red Hat Quay API
- 3. Red Hat Quay Application Programming Interface (API)
- 3.1. Authorization
- 3.2. appspecifictokens
- 3.3. build
- 3.4. discovery
- 3.5. error
- 3.6. globalmessages
- 3.7. logs
- 3.8. manifest
- 3.9. mirror
- 3.10. namespacequota
- 3.10.1. listUserQuota
- 3.10.2. getOrganizationQuotaLimit
- 3.10.3. changeOrganizationQuotaLimit
- 3.10.4. deleteOrganizationQuotaLimit
- 3.10.5. createOrganizationQuotaLimit
- 3.10.6. listOrganizationQuotaLimit
- 3.10.7. getUserQuotaLimit
- 3.10.8. listUserQuotaLimit
- 3.10.9. getOrganizationQuota
- 3.10.10. changeOrganizationQuota
- 3.10.11. deleteOrganizationQuota
- 3.10.12. createOrganizationQuota
- 3.10.13. listOrganizationQuota
- 3.10.14. getUserQuota
- 3.11. organization
- 3.11.1. createOrganization
- 3.11.2. validateProxyCacheConfig
- 3.11.3. getOrganizationCollaborators
- 3.11.4. getOrganizationApplication
- 3.11.5. updateOrganizationApplication
- 3.11.6. deleteOrganizationApplication
- 3.11.7. createOrganizationApplication
- 3.11.8. getOrganizationApplications
- 3.11.9. getProxyCacheConfig
- 3.11.10. deleteProxyCacheConfig
- 3.11.11. createProxyCacheConfig
- 3.11.12. getOrganizationMember
- 3.11.13. removeOrganizationMember
- 3.11.14. getOrganizationMembers
- 3.11.15. getOrganization
- 3.11.16. changeOrganizationDetails
- 3.11.17. deleteAdminedOrganization
- 3.11.18. getApplicationInformation
- 3.12. permission
- 3.13. policy
- 3.13.1. createOrganizationAutoPrunePolicy
- 3.13.2. listOrganizationAutoPrunePolicies
- 3.13.3. getOrganizationAutoPrunePolicy
- 3.13.4. deleteOrganizationAutoPrunePolicy
- 3.13.5. updateOrganizationAutoPrunePolicy
- 3.13.6. createRepositoryAutoPrunePolicy
- 3.13.7. listRepositoryAutoPrunePolicies
- 3.13.8. getRepositoryAutoPrunePolicy
- 3.13.9. deleteRepositoryAutoPrunePolicy
- 3.13.10. updateRepositoryAutoPrunePolicy
- 3.13.11. createUserAutoPrunePolicy
- 3.13.12. listUserAutoPrunePolicies
- 3.13.13. getUserAutoPrunePolicy
- 3.13.14. deleteUserAutoPrunePolicy
- 3.13.15. updateUserAutoPrunePolicy
- 3.14. prototype
- 3.15. referrers
- 3.16. repository
- 3.17. repositorynotification
- 3.18. robot
- 3.18.1. getUserRobots
- 3.18.2. getOrgRobotPermissions
- 3.18.3. regenerateOrgRobotToken
- 3.18.4. getUserRobotPermissions
- 3.18.5. regenerateUserRobotToken
- 3.18.6. getOrgRobot
- 3.18.7. createOrgRobot
- 3.18.8. deleteOrgRobot
- 3.18.9. getOrgRobots
- 3.18.10. getUserRobot
- 3.18.11. createUserRobot
- 3.18.12. deleteUserRobot
- 3.18.13. Auth Federated Robot Token
- 3.18.14. createOrgRobotFederation
- 3.19. search
- 3.20. secscan
- 3.21. superuser
- 3.21.1. createInstallUser
- 3.21.2. deleteInstallUser
- 3.21.3. listAllUsers
- 3.21.4. listAllLogs
- 3.21.5. listAllOrganizations
- 3.21.6. createServiceKey
- 3.21.7. listServiceKeys
- 3.21.8. changeUserQuotaSuperUser
- 3.21.9. deleteUserQuotaSuperUser
- 3.21.10. createUserQuotaSuperUser
- 3.21.11. listUserQuotaSuperUser
- 3.21.12. changeOrganizationQuotaSuperUser
- 3.21.13. deleteOrganizationQuotaSuperUser
- 3.21.14. createOrganizationQuotaSuperUser
- 3.21.15. listOrganizationQuotaSuperUser
- 3.21.16. changeOrganization
- 3.21.17. deleteOrganization
- 3.21.18. approveServiceKey
- 3.21.19. deleteServiceKey
- 3.21.20. updateServiceKey
- 3.21.21. getServiceKey
- 3.21.22. getRepoBuildStatusSuperUser
- 3.21.23. getRepoBuildSuperUser
- 3.21.24. getRepoBuildLogsSuperUser
- 3.21.25. getRegistrySize
- 3.21.26. postRegistrySize
- 3.22. tag
- 3.23. team
- 3.24. trigger
- 3.25. user
- 3.26. Definitions
- 4. API configuration examples
Preface
The Red Hat Quay application programming interface (API) provides a comprehensive, RESTful interface for managing and automating tasks within Red Hat Quay. Designed around the OAuth 2.0 protocol, this API enables secure, fine-grained access to Red Hat Quay resources, and allows administrators and users to perform such actions as creating repositories, managing images, setting permissions, and more.
Red Hat Quay follows Semantic Versioning (SemVer) principles, ensuring predictable API stability across releases, such as: @@ -264,67 +264,67 @@ oauth2_implicit
Scopes
The following scopes are used to control access to the API endpoints: -
| Scope | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+
|