Ansible Collections

>>>

GET /katello/api/ansible_collections
List ansible_collections

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

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

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

Examples

GET /katello/api/ansible_collections
200
{
  "total": 1,
  "subtotal": 1,
  "selectable": 1,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 317008280,
      "name": "collection",
      "namespace": "test",
      "version": "1.0",
      "checksum": null,
      "description": null,
      "tags": []
    }
  ]
}

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/ansible_collections/:id
Show an ansible collection

GET /katello/api/repositories/:repository_id/ansible_collections/:id
Show an ansible collection

Examples

GET /katello/api/ansible_collections/Thisisafakeid
404
{
  "displayMessage": "Failed to find Ansible Collection with id 'Thisisafakeid'.",
  "errors": [
    "Failed to find Ansible Collection with id 'Thisisafakeid'."
  ]
}

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

an ansible collection identifier

Validations:

  • String
>>>

GET /katello/api/ansible_collections/compare
List :resource

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