GET /katello/api/products
List products

GET /katello/api/subscriptions/:subscription_id/products
List of subscription products in a subscription

GET /katello/api/activation_keys/:activation_key_id/products
List of subscription products in an activation key

GET /katello/api/organizations/:organization_id/products
List of products in an organization

GET /katello/api/sync_plans/:sync_plan_id/products
List of Products for sync plan

GET /katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products
List of Products for sync plan

Examples

GET /katello/api/organizations/114267492/sync_plans/712395790/products
200
{
  "total": 7,
  "subtotal": 7,
  "selectable": 7,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 867224909,
      "cp_id": "123123123000",
      "name": "Debian",
      "label": "debian_label",
      "description": "The universal operating system",
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 5
    },
    {
      "id": 905280015,
      "cp_id": "123123123004",
      "name": "Empty Product",
      "label": "empty_product",
      "description": null,
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 0
    },
    {
      "id": 56996862,
      "cp_id": "123123123005",
      "name": "Empty Product_2",
      "label": "empty_product_2",
      "description": null,
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 0
    },
    {
      "id": 921304035,
      "cp_id": "123123123006",
      "name": "Oracle",
      "label": "oracle_label",
      "description": "An open source Linux distribution.",
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 1
    },
    {
      "id": 785658510,
      "cp_id": "123123123003",
      "name": "OSTree Product",
      "label": "ostree_product",
      "description": "A product for ostree content",
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 0
    },
    {
      "id": 516337990,
      "cp_id": "123123123002",
      "name": "Puppet Product",
      "label": "puppet_product",
      "description": "A product for puppet content",
      "provider_id": 36826545,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 3
    },
    {
      "id": 1073012828,
      "cp_id": "redhat",
      "name": "Red Hat Linux",
      "label": "redhat_label",
      "description": "A more Enterprisy fedora",
      "provider_id": 1073012828,
      "sync_plan_id": null,
      "sync_summary": {},
      "gpg_key_id": null,
      "ssl_ca_cert_id": null,
      "ssl_client_cert_id": null,
      "ssl_client_key_id": null,
      "sync_state": null,
      "last_sync": null,
      "last_sync_words": null,
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "sync_plan": null,
      "repository_count": 3
    }
  ]
}

Params

Param name Description
organization_id
required

Filter products by organization

Validations:

  • Must be a number.
subscription_id
optional

Filter products by subscription

Validations:

  • Must be a number.
name
optional

Filter products by name

Validations:

  • String
enabled
optional

Return enabled products only

Validations:

  • Must be one of: true, false, 1, 0.
custom
optional

Return custom products only

Validations:

  • Must be one of: true, false, 1, 0.
redhat_only
optional

Return Red Hat (non-custom) products only

Validations:

  • Must be one of: true, false, 1, 0.
include_available_content
optional

Whether to include available content attribute in results

Validations:

  • Must be one of: true, false, 1, 0.
sync_plan_id
optional

Filter products by sync plan id

Validations:

  • Must be a number.
available_for
optional

Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported.

Validations:

  • String
search
optional

Search string

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String
full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.
sort_by
optional

Field to sort the results on

Validations:

  • String
sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

Search fields

Field name Type Possible values
description text
label string
name string
organization_id integer
redhat true, false