Red Hat Lightspeed APIs

Red Hat Lightspeed API cheat sheet

Jerome Marc
English

Download Cheat sheet

About

Red Hat Lightspeed is a Software-as-a-Service offering that enables users to obtain actionable intelligence regarding their Red Hat Enterprise Linux environments, helping to identify and address operational and vulnerability risks before an issue results in downtime. This cheat sheet covers the use of Red Hat Lightspeed APIs to obtain system details and findings, as well as to interact with specific Red Hat Lightspeed applications. Examples using Python and Ansible are included.

This cheat sheet explains how to:

  • Authenticate with Red Hat Lightspeed API
  • Interact with the inventory
  • Obtain findings identified by Red Hat Lightspeed
  • Work with various Red Hat Lightspeed applications
  • Generate and execute remediations for existing issues
  • Get notifications and integrate with third party applications

Revision history:

  • First edition: Apr 20, 2022
  • Second edition: May 30, 2024
  • Third edition: Jan 30, 2025
  • Fourth edition: May 29, 2025
  • Fifth edition: Oct 10, 2025
  • Sixth edition: Nov 20, 2025

Excerpt

Image builder

Submit a new compose image request:

POST /image-builder/v1/compose
{
  "image_name": "My latest RHEL9 guest image",
  "distribution": "rhel-95",
  "image_requests": [
    {
      "architecture": "x86_64",
      "image_type": "guest-image",
      "upload_request": {
        "type": "aws.s3",
        "options": {}
      }
    }
  ]
}

Get a list of compose image request IDs:

GET /image-builder/v1/composes/

Get the status of a compose image request:

GET /image-builder/v1/composes/<compose_id>

Related blog post: Using hosted image builder via its API

Related Cheat sheets