Upstream subscriptions

Red Hat subscriptions management platform.

>>>

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

Examples

GET /katello/api/organizations/114267492/upstream_subscriptions
200
{
  "total": null,
  "subtotal": null,
  "selectable": null,
  "page": "3",
  "per_page": "7",
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {}
  ]
}

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 Katello 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

Examples

PUT /katello/api/organizations/114267492/upstream_subscriptions
{
  "pools": [
    {
      "id": "12345",
      "quantity": 5
    }
  ],
  "upstream_subscription": {
    "pools": [
      {
        "id": "12345",
        "quantity": 5
      }
    ]
  }
}
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
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

Katello 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 manifest

Examples

DELETE /katello/api/organizations/114267492/upstream_subscriptions
{
  "pool_ids": [
    "1",
    "2",
    "3"
  ],
  "upstream_subscription": {
    "pool_ids": [
      "1",
      "2",
      "3"
    ]
  }
}
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
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

Examples

POST /katello/api/organizations/114267492/upstream_subscriptions
{
  "pools": [
    {
      "id": "3",
      "quantity": 6
    }
  ],
  "upstream_subscription": {
    "pools": [
      {
        "id": "3",
        "quantity": 6
      }
    ]
  }
}
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
pools
required

Array of pools to add

Validations:

  • Must be an Array of nested elements
pools[id]
required

Candlepin ID of pool to add

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.
>>>

GET /katello/api/organizations/:organization_id/upstream_subscriptions/ping
Check if a connection can be made to Red Hat Subscription Management.