Red Hat Content Views API

openapi: 3.2.0
info:
  title: Red Hat Satellite Content Views API
  description: The Red Hat Satellite API provides programmatic access to managing Satellite infrastructure, including content management, host provisioning, patch management, and configuration across large-scale Linux environments. It covers both the Foreman API for host and infrastructure management and the Katello API for content and subscription management.
  version: '6.16'
  contact:
    name: Red Hat Support
    url: https://access.redhat.com/support
  termsOfService: https://www.redhat.com/en/about/terms-use
servers:
- url: https://satellite.example.com
  description: Red Hat Satellite Server
security:
- basicAuth: []
tags:
- name: Content Views
  description: Operations for managing content views that define curated snapshots of software repositories for controlled content delivery.
paths:
  /katello/api/v2/content_views:
    get:
      operationId: listContentViews
      summary: Red Hat List Content Views
      description: Retrieves the list of content views that define curated snapshots of software repositories used for controlled content delivery to hosts.
      tags:
      - Content Views
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      - name: organization_id
        in: query
        description: Filter by organization identifier.
        schema:
          type: integer
        example: '500123'
      - name: name
        in: query
        description: Filter by content view name.
        schema:
          type: string
        example: Example Title
      responses:
        '200':
          description: Successfully retrieved content views
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContentViewList'
              examples:
                Listcontentviews200Example:
                  summary: Default listContentViews 200 response
                  x-microcks-default: true
                  value:
                    total: 10
                    subtotal: 10
                    page: 10
                    per_page: 10
                    results:
                    - id: abc123
                      name: Example Title
                      label: Example Title
                      description: A sample description.
                      composite: true
                      organization_id: '500123'
                      repository_ids:
                      - {}
                      last_published: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createContentView
      summary: Red Hat Create a Content View
      description: Creates a new content view that can include selected repositories and filters for curating content delivery.
      tags:
      - Content Views
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - organization_id
              properties:
                name:
                  type: string
                  description: The name of the content view.
                description:
                  type: string
                  description: A description of the content view.
                organization_id:
                  type: integer
                  description: The organization to create the content view in.
                repository_ids:
                  type: array
                  description: IDs of repositories to include.
                  items:
                    type: integer
            examples:
              CreatecontentviewRequestExample:
                summary: Default createContentView request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  organization_id: '500123'
                  repository_ids:
                  - 10
      responses:
        '201':
          description: Content view created successfully
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    PageParam:
      name: page
      in: query
      description: The page number for paginated results.
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPageParam:
      name: per_page
      in: query
      description: The number of results per page.
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 20
  schemas:
    PaginatedContentViewList:
      type: object
      properties:
        total:
          type: integer
          example: 10
        subtotal:
          type: integer
          example: 10
        page:
          type: integer
          example: 10
        per_page:
          type: integer
          example: 10
        results:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              label:
                type: string
              description:
                type: string
              composite:
                type: boolean
              organization_id:
                type: integer
              repository_ids:
                type: array
                items:
                  type: integer
              last_published:
                type: string
                format: date-time
          example: []
  responses:
    UnauthorizedError:
      description: Authentication credentials are missing or invalid.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using a valid Satellite username and password. Alternatively, a personal access token can be used.
externalDocs:
  description: Red Hat Satellite REST API Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.16/html-single/using_the_satellite_rest_api/index