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
   # ...

   Copy to Clipboard Toggle word wrap
2. Restart your Red Hat Quay deployment.

Procedure

1. Enter the following command to deploy the Swagger UI container, pointing the URL to your Red Hat Quay’s API discovery endpoint. For example:

   $ podman run -p 8080:8080 -e SWAGGER_JSON_URL=<quay-server.example.com> docker.swagger.io/swaggerapi/swagger-ui

   Copy to Clipboard Toggle word wrap

   Example output

   ---
   /docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
   20-envsubst-on-templates.sh: Running envsubst on /etc/nginx/templates/default.conf.template to /etc/nginx/conf.d/default.conf
   /docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
   /docker-entrypoint.sh: Launching /docker-entrypoint.d/40-swagger-ui.sh
   /docker-entrypoint.sh: Configuration complete; ready for start up
   ---

   Copy to Clipboard Toggle word wrap

2. Navigate to the localhost URL. In this example, it is http://localhost:8080/.

3. Use the Swagger UI to test various API endpoints. For example, to create a new token for a user, you can click the POST /api/v1/user/apptoken endpoint Try it out Execute to generate an example curl command.

   Note

   Currently, server responses cannot be generated. This is because the Swagger UI is not set up to accept bearer tokens. As a result, the following error is returned for each command: {"error": "CSRF token was invalid or missing."}. As a workaround, you can copy this command into your terminal and manually add your bearer token, for example, -H 'Authorization: Bearer <bearer_token>'

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()

   Copy to Clipboard Toggle word wrap

   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

      Copy to Clipboard Toggle word wrap

   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

      Copy to Clipboard Toggle word wrap