Red Hat Enterprise Linux Systems API

openapi: 3.2.0
info:
  title: Red Hat Subscription Management Systems API
  description: API for managing Red Hat Enterprise Linux subscriptions, entitlements, and system registrations. Enables automated lifecycle management of subscriptions, system inventory, and entitlement reporting using OAuth 2.0 with offline tokens.
  version: v1
  contact:
    name: Red Hat Customer Portal
    url: https://access.redhat.com/management/api
  termsOfService: https://www.redhat.com/en/about/terms-use
servers:
- url: https://api.access.redhat.com/management/v1
  description: Red Hat Subscription Management API v1
tags:
- name: Systems
  description: Registered system management
paths:
  /systems:
    get:
      operationId: listSystems
      summary: List Systems
      description: Returns a list of systems registered with Red Hat Subscription Management. Supports pagination via limit and offset parameters.
      tags:
      - Systems
      parameters:
      - name: limit
        in: query
        description: Maximum number of systems to return
        schema:
          type: integer
          default: 100
          maximum: 100
      - name: offset
        in: query
        description: Offset for pagination
        schema:
          type: integer
          default: 0
      security:
      - OAuth2: []
      responses:
        '200':
          description: List of registered systems
          content:
            application/json:
              schema:
                type: object
                properties:
                  body:
                    type: array
                    items:
                      $ref: '#/components/schemas/System'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          description: Unauthorized - invalid or expired token
  /systems/{uuid}:
    get:
      operationId: getSystem
      summary: Get System
      description: Returns details for a specific registered system by UUID.
      tags:
      - Systems
      parameters:
      - name: uuid
        in: path
        required: true
        description: System UUID
        schema:
          type: string
          format: uuid
      security:
      - OAuth2: []
      responses:
        '200':
          description: System detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System'
        '404':
          description: System not found
components:
  schemas:
    System:
      type: object
      description: A registered RHEL system
      properties:
        uuid:
          type: string
          format: uuid
          description: Unique system identifier
        name:
          type: string
          description: System hostname
        type:
          type: string
          description: System type (physical, virtual, hypervisor)
        created:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
        entitlementCount:
          type: integer
          description: Number of active entitlements
        entitlementStatus:
          type: string
          enum:
          - valid
          - invalid
          - partial
        serviceLevel:
          type: string
          description: Service level agreement tier
        usage:
          type: string
          description: System usage type
        facts:
          type: object
          description: System hardware and software facts
    Pagination:
      type: object
      properties:
        count:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token
          scopes: {}