Capsule_content

>>>

GET /katello/api/capsules/:id/content/counts
List content counts for the smart proxy

Examples

GET /katello/api/capsules/281110143/content/counts
200

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
>>>

POST /katello/api/capsules/:id/content/update_counts
Update content counts for the smart proxy

Examples

POST /katello/api/capsules/281110143/content/update_counts
{
  "capsule_content": {}
}
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 smart proxy

Validations:

  • Integer
>>>

GET /katello/api/capsules/:id/content/lifecycle_environments
List the lifecycle environments attached to the smart proxy

Examples

GET /katello/api/capsules/281110143/content/lifecycle_environments
200
{
  "total": 0,
  "subtotal": 0,
  "selectable": 0,
  "page": null,
  "per_page": null,
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
organization_id
optional

Id of the organization to limit environments on

Validations:

  • Integer
>>>

GET /katello/api/capsules/:id/content/available_lifecycle_environments
List the lifecycle environments not attached to the smart proxy

Examples

GET /katello/api/capsules/281110143/content/available_lifecycle_environments
204

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
organization_id
optional

Id of the organization to limit environments on

Validations:

  • Integer
>>>

POST /katello/api/capsules/:id/content/lifecycle_environments
Add lifecycle environments to the smart proxy

Examples

POST /katello/api/capsules/281110143/content/lifecycle_environments
{
  "environment_id": 562075838,
  "capsule_content": {
    "environment_id": 562075838
  }
}
200
{
  "total": 1,
  "subtotal": 1,
  "selectable": 1,
  "page": null,
  "per_page": null,
  "error": null,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "library": true,
      "registry_name_pattern": null,
      "registry_unauthenticated_pull": false,
      "id": 562075838,
      "name": "Library",
      "label": "library_label",
      "description": "This is the Library",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 UTC",
      "prior": null,
      "successor": null,
      "counts": {
        "content_hosts": 2,
        "content_views": 4,
        "packages": 5,
        "module_streams": 2,
        "errata": {
          "security": 1,
          "bugfix": 1,
          "enhancement": 1,
          "total": 3
        },
        "yum_repositories": 11,
        "docker_repositories": 4,
        "ostree_repositories": 1,
        "products": 8,
        "debs": 4,
        "deb_repositories": 5
      },
      "permissions": {
        "create_lifecycle_environments": true,
        "view_lifecycle_environments": true,
        "edit_lifecycle_environments": true,
        "destroy_lifecycle_environments": false,
        "promote_or_remove_content_views_to_environments": true
      },
      "content_views": [
        {
          "name": "Published LIbrary view",
          "id": 405955044
        },
        {
          "name": "Published Library and dev view",
          "id": 909058347
        },
        {
          "name": "Published Library - dev - staging view",
          "id": 419082953
        },
        {
          "name": "Composite view",
          "id": 64601712
        }
      ]
    }
  ]
}

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
environment_id
required

Id of the lifecycle environment

Validations:

  • Integer
>>>

DELETE /katello/api/capsules/:id/content/lifecycle_environments/:environment_id
Remove lifecycle environments from the smart proxy

Examples

DELETE /katello/api/capsules/281110143/content/lifecycle_environments/562075838
{
  "capsule_content": {}
}
204

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
environment_id
required

Id of the lifecycle environment

Validations:

  • Integer
>>>

POST /katello/api/capsules/:id/content/sync
Synchronize the content to the smart proxy

Examples

POST /katello/api/capsules/281110143/content/sync
{
  "content_view_id": 909058347,
  "capsule_content": {
    "content_view_id": 909058347
  }
}
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 smart proxy

Validations:

  • Integer
environment_id
optional

Id of the environment to limit the synchronization on

Validations:

  • Integer
content_view_id
optional

Id of the content view to limit the synchronization on

Validations:

  • Integer
repository_id
optional

Id of the repository to limit the synchronization on

Validations:

  • Integer
skip_metadata_check
optional

Skip metadata check on each repository on the smart proxy

Validations:

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

GET /katello/api/capsules/:id/content/sync
Get current smart proxy synchronization status

Examples

GET /katello/api/capsules/281110143/content/sync
200
{
  "last_sync_time": null,
  "download_policy": null,
  "active_sync_tasks": [],
  "last_failed_sync_tasks": [],
  "last_sync_task": null,
  "last_failed_reclaim_tasks": [],
  "lifecycle_environments": [],
  "last_sync_words": null,
  "unsyncable_content_types": [],
  "content_counts": null
}

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
organization_id
optional

Id of the organization to get the status for

Validations:

  • Integer
>>>

DELETE /katello/api/capsules/:id/content/sync
Cancel running smart proxy synchronization

Examples

GET /katello/api/capsules/281110143/content/sync
200
{
  "message": "There's no running synchronization for this smart proxy."
}

Params

Param name Description
id
required

Id of the smart proxy

Validations:

  • Integer
>>>

POST /katello/api/capsules/:id/content/reclaim_space
Reclaim space from all On Demand repositories on a smart proxy

Examples

POST /katello/api/capsules/281110143/content/reclaim_space
{
  "capsule_content": {}
}
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 smart proxy

Validations:

  • Must be a number.