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:
- Major releases: Introduce new capabilities. Might include breaking changes to API compatibility. For example, the API of Red Hat Quay 2.0 differs from Red Hat Quay 3.0.
- Minor releases: Add new functionality in a backward-compatible manner. For example, a 3.y release adds functionality to the version 3. release.
- Patch releases: Deliver bug fixes and improvements while preserving backward compatibility with minor releases, such as 3.y.z.
The following guide describes the Red Hat Quay API in more detail, and provides details on the following topics:
- OAuth 2 access tokens and how they compare to traditional API tokens and Red Hat Quay’s robot tokens
- Generating an OAuth 2 access token
- Best practices for token management
- OAuth 2 access token capabilities
- Using the Red Hat Quay API
- Red Hat Quay API configuration examples
This guide is accompanied with a second guide, . . ., that provides information about all api/v1 endpoints and how to access those endpoints with example commands.
