Package groups

>>>

GET /katello/api/package_groups
List package_groups

GET /katello/api/content_views/:content_view_id/filters/:filter_id/package_groups
List package_groups

GET /katello/api/content_view_filters/:content_view_filter_id/package_groups
List package_groups

GET /katello/api/repositories/:repository_id/package_groups
List package_groups

Examples

GET /katello/api/package_groups
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 441261589,
      "name": "Katello Server Development",
      "pulp_id": "4f9eea2a-a124-497e-8492-828b6d938aaa",
      "uuid": "4f9eea2a-a124-497e-8492-828b6d938aaa",
      "description": "fun packages for servers",
      "repository": {
        "id": 367202338,
        "name": "Fedora 17 x86_64",
        "product": {
          "id": 785257261,
          "name": "Fedora"
        }
      }
    },
    {
      "id": 283985760,
      "name": "mammals",
      "pulp_id": "4f9eea2a-a124-497e-8492-828b64444abc",
      "uuid": "4f9eea2a-a124-497e-8492-828b64444abc",
      "description": "all kinds of mammals",
      "repository": {
        "id": 367202338,
        "name": "Fedora 17 x86_64",
        "product": {
          "id": 785257261,
          "name": "Fedora"
        }
      }
    }
  ]
}

Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • Must be a number.
content_view_version_id
optional

content view version identifier

Validations:

  • Must be a number.
content_view_filter_id
optional

content view filter identifier

Validations:

  • Must be a number.
content_view_filter_rule_id
optional

content view filter rule identifier

Validations:

  • Must be a number.
repository_id
optional

repository identifier

Validations:

  • Must be a number.
environment_id
optional

environment identifier

Validations:

  • Must be a number.
ids
optional

ids to filter content by

Validations:

  • Must be an array of any type
include_filter_ids
optional

Includes associated content view filter ids in response

Validations:

  • Must be one of: true, false, 1, 0.
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
>>>

GET /katello/api/package_groups/:id
Show a package group

GET /katello/api/repositories/:repository_id/package_groups/:id
Show a package group

Examples

GET /katello/api/package_groups/283985760
204

Params

Param name Description
repository_id
optional

repository identifier

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
id
required

a package group identifier

Validations:

  • String
>>>

GET /katello/api/package_groups/compare
List package_groups

Examples

GET /katello/api/package_groups/compare
200
{
  "total": 2,
  "subtotal": 2,
  "selectable": 2,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 441261589,
      "name": "Katello Server Development",
      "pulp_id": "4f9eea2a-a124-497e-8492-828b6d938aaa",
      "uuid": "4f9eea2a-a124-497e-8492-828b6d938aaa",
      "description": "fun packages for servers",
      "repository": {
        "id": 367202338,
        "name": "Fedora 17 x86_64",
        "product": {
          "id": 785257261,
          "name": "Fedora"
        }
      },
      "comparison": [
        840492357
      ]
    },
    {
      "id": 283985760,
      "name": "mammals",
      "pulp_id": "4f9eea2a-a124-497e-8492-828b64444abc",
      "uuid": "4f9eea2a-a124-497e-8492-828b64444abc",
      "description": "all kinds of mammals",
      "repository": {
        "id": 367202338,
        "name": "Fedora 17 x86_64",
        "product": {
          "id": 785257261,
          "name": "Fedora"
        }
      },
      "comparison": [
        840492357
      ]
    }
  ]
}

Params

Param name Description
content_view_version_ids
optional

content view versions to compare

Validations:

  • Must be an array of any type
repository_id
optional

Library repository id to restrict comparisons to

Validations:

  • Must be a number.
restrict_comparison
optional

Return same, different or all results

Validations:

  • String
>>>

POST /katello/api/package_group
Create a package group

Examples

POST /katello/api/package_groups
{
  "repository_id": 367202338,
  "name": "My_Group",
  "description": "My Group",
  "mandatory_package_names": [
    "katello-agent"
  ],
  "package_group": {
    "name": "My_Group",
    "description": "My Group"
  }
}
200
{
  "status": "success"
}

Params

Param name Description
repository_id
required

repository_id

Validations:

  • String
name
required

package group name

Validations:

  • String
description
optional

package group description. Defaults to params

Validations:

  • String
user_visible
optional

set “user_visible” flag on package group. Defaults to true

Validations:

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

mandatory package names to include in the package group

Validations:

  • Must be an array of any type
optional_package_names
optional

optional package names to include in the package group

Validations:

  • Must be an array of any type
conditional_package_names
optional

conditional package names to include in the package group

Validations:

  • Must be an array of any type
default_package_names
optional

default package names to include in the package group

Validations:

  • Must be an array of any type
>>>

DELETE /katello/api/package_group
Delete a package group

Examples

DELETE /katello/api/package_groups
{
  "name": "My_Group",
  "repository_id": 367202338,
  "package_group": {
    "name": "My_Group"
  }
}
200
{
  "status": "success"
}

Params

Param name Description
name
required

package group name

Validations:

  • String
repository_id
required

repository_id

Validations:

  • String