Red Hat subscriptions management platform.


GET /katello/api/organizations/:organization_id/upstream_subscriptions
List available subscriptions from Red Hat Subscription Management

Params

Param name Description
organization_id
required

Organization ID

Validations:

  • Must be a number.

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

The order to sort the results in. [asc, desc] Defaults to ‘desc’.

Validations:

  • String

sort_by
optional

The field to sort the data by. Defaults to the created date.

Validations:

  • String

pool_ids
optional

Return only the upstream pools which map to the given local pool IDs

Validations:

  • Must be an array of any type

quantities_only
optional

Only returns id and quantity fields

Validations:

  • Must be one of: true, false, 1, 0

attachable
optional

Return only subscriptions which can be attached to the upstream allocation

Validations:

  • Must be one of: true, false, 1, 0


PUT /katello/api/organizations/:organization_id/upstream_subscriptions
Update the quantity of one or more subscriptions on an upstream allocation

Params

Param name Description
organization_id
required

Organization ID

Validations:

  • Must be a number.

pools
required

Array of Pools to be updated. Only pools originating upstream are accepted.

Validations:

  • Must be an Array of nested elements

pools[id]
required

ID of local pool to update

Validations:

  • String

pools[quantity]
required

Desired quantity of the pool

Validations:

  • Integer


DELETE /katello/api/organizations/:organization_id/upstream_subscriptions
Remove one or more subscriptions from an upstream subscription allocation

Params

Param name Description
organization_id
required

Organization ID

Validations:

  • Must be a number.

pool_ids
required

Array of local pool IDs. Only pools originating upstream are accepted.

Validations:

  • Must be an array of any type


POST /katello/api/organizations/:organization_id/upstream_subscriptions
Add subscriptions consumed by a manifest from Red Hat Subscription Management

Params

Param name Description
pools
required

Array of pools to add

Validations:

  • Must be an Array of nested elements

pools[id]
required

Pool ID

Validations:

  • String

pools[quantity]
required

Quantity of entitlements to bind

Validations:

  • Must be a number.

organization_id
required

Organization ID

Validations:

  • Must be a number.