Chapter 5. Enabling and using the Red Hat Quay API

Procedure

1. In your Red Hat Quay config.yaml file, set BROWSER_API_CALLS_XHR_ONLY to false. For example:

   # ...
   BROWSER_API_CALLS_XHR_ONLY: false
   # ...

2. Restart your Red Hat Quay deployment.

Procedure

1. Create a Python script that executes an API command. The following example is used to delete organization applications using the DELETE /api/v1/organization/{orgname}/applications/{client_id} API endpoint.

   example.py file

   import requests 1
   
   # Hard-coded values
   API_BASE_URL = "http://<quay-server.example.com>/api/v1" 2
   ACCESS_TOKEN = "<access_token>" 3
   ORG_NAME = "<organization_name>" 4
   
   def get_all_organization_applications():
       url = f"{API_BASE_URL}/organization/{ORG_NAME}/applications"
       headers = {
           "Authorization": f"Bearer {ACCESS_TOKEN}"
       }
   
       response = requests.get(url, headers=headers)
   
       if response.status_code == 200:
           try:
               applications = response.json()
               # Print the raw response for debugging
               print("Raw response:", applications)
   
               # Adjust parsing logic based on the response structure
               if isinstance(applications, dict) and 'applications' in applications:
                   applications = applications['applications']
   
               if isinstance(applications, list):
                   print("Organization applications retrieved successfully:")
                   for app in applications:
                       # Updated key from 'title' to 'name'
                       print(f"Name: {app['name']}, Client ID: {app['client_id']}")
                   return applications
               else:
                   print("Unexpected response format.")
                   return []
           except requests.exceptions.JSONDecodeError:
               print("Error decoding JSON response:", response.text)
               return []
       else:
           print(f"Failed to retrieve applications. Status code: {response.status_code}, Response: {response.text}")
           return []
   
   def delete_organization_application(client_id):
       url = f"{API_BASE_URL}/organization/{ORG_NAME}/applications/{client_id}"
       headers = {
           "Authorization": f"Bearer {ACCESS_TOKEN}"
       }
   
       response = requests.delete(url, headers=headers)
   
       if response.status_code == 204:
           print(f"Application {client_id} deleted successfully.")
       else:
           print(f"Failed to delete application {client_id}. Status code: {response.status_code}, Response: {response.text}")
   
   def main():
       applications = get_all_organization_applications()
       for app in applications:
           if app['name'] != "<admin_token_app>": <5>  # Skip the "admin-token-app"
               delete_organization_application(app['client_id'])
           else:
               print(f"Skipping deletion of application: {app['name']}")
   
   # Execute the main function
   main()

   1

   Includes the import library in your Python code.

   2

   The URL of your registry appended with /api/v1.

   3

   Your OAuth 2 access token.

   4

   The organization that holds the application.

   The name of the application token to remain.

2. Save the script as prune_applications.py.

3. Create a cron job that automatically runs the script:

   1. Open the crontab editor by running the following command:

      $ crontab -e

   2. In the editor, add the cron job for running the script. The following example runs the script once per month:

      0 0 1 * * sudo python /path/to/prune_images.py >> /var/log/prune_images.log 2>&1