Repository_sets

>>>

GET /katello/api/repository_sets
List repository sets.

GET /katello/api/products/:product_id/repository_sets
List repository sets for a product.

Examples

GET /katello/api/repository_sets
200
{
  "total": 1,
  "subtotal": 1,
  "selectable": 1,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "enabled": false,
      "product": {
        "id": 1073012828,
        "name": "Red Hat Linux"
      },
      "content": {
        "id": 998579520,
        "name": "rhel",
        "label": "rhel",
        "vendor": null,
        "content_type": "yum",
        "content_url": "/content/dist/rhel/server/$releasever/$basearch/os",
        "gpg_url": null
      },
      "repositories": [
        {
          "id": 177000827,
          "name": "RHEL 7 x86_64",
          "arch": "x86_64",
          "releasever": "7Server"
        },
        {
          "id": 103207400,
          "name": "RHEL 6 x86_64",
          "arch": "x86_64",
          "releasever": "6Server"
        },
        {
          "id": 721593910,
          "name": "RHEL 7 no_arch",
          "arch": "noarch",
          "releasever": "7Server"
        }
      ],
      "name": "rhel",
      "vendor": null,
      "label": "rhel",
      "id": "69",
      "type": "yum",
      "gpgUrl": null,
      "contentUrl": "/content/dist/rhel/server/$releasever/$basearch/os",
      "archRestricted": "x86_64",
      "osRestricted": null,
      "override": "default",
      "overrides": [],
      "enabled_content_override": null,
      "redhat": true
    }
  ]
}

Params

Param name Description
product_id
optional

ID of a product to list repository sets from

Validations:

  • Must be a number.
name
optional

Repository set name to search on

Validations:

  • String
enabled
optional

If true, only return repository sets that have been enabled. Defaults to false

Validations:

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

If true, only return repository sets that are associated with an active subscriptions

Validations:

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

organization identifier

Validations:

  • Must be a number.
with_custom
optional

If true, return custom repository sets along with redhat repos. Will be ignored if repository_type is supplied.

Validations:

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

activation key identifier

Validations:

  • Must be a number.
host_id
optional

Id of the host

Validations:

  • Must be a number.
content_access_mode_all DEPRECATED
optional

Get all content available, not just that provided by subscriptions.

Validations:

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

Limit content to just that available in the host's or activation key's content view version and lifecycle environment.

Validations:

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

Limit content to enabled / disabled / overridden

Validations:

  • Must be one of: enabled, disabled, overridden.
repository_type
optional

Limit content to Red Hat / custom

Validations:

  • Must be one of: redhat, custom.
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
content_label string
content_type string
enabled_by_default true, false
label string
name string
path string
product string
product_id integer
product_name string
redhat true, false
>>>

GET /katello/api/repository_sets/:id
Get info about a repository set

GET /katello/api/products/:product_id/repository_sets/:id
Get info about a repository set

Params

Param name Description
id
required

ID of the repository set

Validations:

  • Must be a number.
product_id
optional

ID of a product to list repository sets from

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
>>>

GET /katello/api/repository_sets/:id/available_repositories
Get list of available repositories for the repository set

GET /katello/api/products/:product_id/repository_sets/:id/available_repositories
Get list of available repositories for the repository set

Examples

GET /katello/api/products/1073012828/repository_sets/content-123/available_repositories
200
{
  "total": 15,
  "subtotal": 15,
  "selectable": 15,
  "page": null,
  "per_page": null,
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "substitutions": {
        "releasever": null,
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": ".10",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "7Server",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "7.10",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "7.9",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "7.0",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.10",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.2",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.1",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "4.2",
        "basearch": "x86_64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5Workstation",
        "basearch": "ia64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.10",
        "basearch": "ia64"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.11",
        "basearch": "i386"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.10",
        "basearch": "i386"
      },
      "path": ""
    },
    {
      "substitutions": {
        "releasever": "5.10",
        "basearch": ""
      },
      "path": ""
    }
  ]
}

Params

Param name Description
id
required

ID of the repository set

Validations:

  • Must be a number.
product_id
optional

ID of a product to list repository sets from

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
>>>

PUT /katello/api/repository_sets/:id/enable
Enable a repository from the set

PUT /katello/api/products/:product_id/repository_sets/:id/enable
Enable a repository from the set

Examples

PUT /katello/api/products/1073012828/repository_sets/content-123/enable
{
  "repository_set": {}
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
id
required

ID of the repository set to enable

Validations:

  • Must be a number.
product_id
optional

ID of the product containing the repository set

Validations:

  • Must be a number.
basearch
optional

Basearch to enable

Validations:

  • String
releasever
optional

Releasever to enable

Validations:

  • String
organization_id
optional

organization identifier

Validations:

  • Must be a number.
>>>

PUT /katello/api/repository_sets/:id/disable
Disable a repository from the set

PUT /katello/api/products/:product_id/repository_sets/:id/disable
Disable a repository from the set

Examples

PUT /katello/api/products/1073012828/repository_sets/content-123/disable
{
  "basearch": "x86_64",
  "releasever": "6Server",
  "repository_set": {
    "basearch": "x86_64",
    "releasever": "6Server"
  }
}
202
{
  "id": null,
  "label": null,
  "pending": null,
  "username": null,
  "started_at": null,
  "ended_at": null,
  "state": null,
  "result": null,
  "progress": null,
  "input": null,
  "output": {},
  "humanized": null,
  "cli_example": null,
  "available_actions": {
    "cancellable": null,
    "resumable": null
  }
}

Params

Param name Description
id
required

ID of the repository set to disable

Validations:

  • Must be a number.
repository_id
optional

ID of the repository within the set to disable

Validations:

  • Must be a number.
product_id
optional

ID of the product containing the repository set

Validations:

  • Must be a number.
basearch
optional

Basearch to disable

Validations:

  • String
releasever
optional

Releasever to disable

Validations:

  • String
organization_id
optional

organization identifier

Validations:

  • Must be a number.