Preface
You can use the Red Hat Quay REST API, which is based on the OAuth 2.0 protocol, to manage repositories, images, permissions, and other registry resources. This reference documents endpoints, request and response schemas, authentication requirements, and error codes.
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:
- API endpoint structure, including supported HTTP methods
- Request and response schemas for each endpoint
- Required and optional parameters
- Authentication and authorization requirements
- Common error codes and troubleshooting information