Capsules

>>>

GET /katello/api/capsules
List all smart proxies that have content

Examples

GET /katello/api/capsules
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 UTC",
      "hosts_count": 0,
      "name": "Pulp Primary Proxy",
      "id": 767380118,
      "url": "https://centos8-katello-devel.redhat.example.com:9090",
      "remote_execution_pubkey": null,
      "download_policy": null,
      "supported_pulp_types": [
        "yum",
        "ansible_collection",
        "deb",
        "docker",
        "file",
        "ostree",
        "python"
      ],
      "lifecycle_environments": [],
      "features": [
        {
          "capabilities": [],
          "name": "Pulp",
          "id": 17596590
        },
        {
          "capabilities": [
            "ansible",
            "certguard",
            "container",
            "core",
            "deb",
            "file",
            "rpm",
            "python",
            "ostree"
          ],
          "name": "Pulpcore",
          "id": 990889162
        }
      ]
    },
    {
      "created_at": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 UTC",
      "hosts_count": 0,
      "name": "Unused Proxy",
      "id": 281110143,
      "url": "http://else.where:45672",
      "remote_execution_pubkey": null,
      "download_policy": null,
      "supported_pulp_types": [],
      "lifecycle_environments": [],
      "features": [
        {
          "capabilities": [],
          "name": "Pulp Node",
          "id": 1006510560
        },
        {
          "capabilities": [],
          "name": "Container_Gateway",
          "id": 1006510561
        },
        {
          "capabilities": [
            "core"
          ],
          "name": "Pulpcore",
          "id": 990889162
        }
      ]
    }
  ]
}

Params

Param name Description
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/capsules/:id
Show the smart proxy details

Examples

GET /katello/api/capsules/281110143
204

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer