GET /katello/api/sync_plans
List sync plans

GET /katello/api/organizations/:organization_id/sync_plans

Params

Param Name Description
organization_id
Required

Filter sync plans by organization name or label

Validations:

  • number.

name
Optional

filter by name

Validations:

  • String

sync_date
Optional

filter by sync date

Validations:

  • String

interval
Optional

filter by interval

Validations:

  • Must be one of: hourly, daily, weekly.


GET /katello/api/organizations/:organization_id/sync_plans/:id
Show a sync plan

GET /katello/api/sync_plans/:id
Show a sync plan

Params

Param Name Description
organization_id
Optional

Filter sync plans by organization name or label

Validations:

  • number.

id
Required

sync plan numeric identifier

Validations:

  • number.


POST /katello/api/organizations/:organization_id/sync_plans
Create a sync plan

Params

Param Name Description
organization_id
Required

Filter sync plans by organization name or label

Validations:

  • number.

name
Required

sync plan name

Validations:

  • String

interval
Required

how often synchronization should run

Validations:

  • Must be one of: hourly, daily, weekly.

sync_date
Required

start datetime of synchronization

Validations:

  • String

description
Optional

sync plan description

Validations:

  • String

enabled
Required

enables or disables synchronization

Validations:

  • boolean


PUT /katello/api/organizations/:organization_id/sync_plans/:id
Update a sync plan

PUT /katello/api/sync_plans/:id
Update a sync plan

Params

Param Name Description
organization_id
Optional

Filter sync plans by organization name or label

Validations:

  • number.

id
Required

sync plan numeric identifier

Validations:

  • number.

name
Optional

sync plan name

Validations:

  • String

interval
Optional

how often synchronization should run

Validations:

  • Must be one of: hourly, daily, weekly.

sync_date
Optional

start datetime of synchronization

Validations:

  • String

description
Optional

sync plan description

Validations:

  • String

enabled
Optional

enables or disables synchronization

Validations:

  • boolean


DELETE /katello/api/organizations/:organization_id/sync_plans/:id
Destroy a sync plan

DELETE /katello/api/sync_plans/:id
Destroy a sync plan

Params

Param Name Description
organization_id
Optional

Filter sync plans by organization name or label

Validations:

  • number.

id
Optional

sync plan numeric identifier

Validations:

  • number.


PUT /katello/api/organizations/:organization_id/sync_plans/:id/add_products
Add products to sync plan

Params

Param Name Description
id
Required

ID of the sync plan

Validations:

  • String

product_ids
Required

List of product ids to add to the sync plan

Validations:

  • Must be an array of any type


PUT /katello/api/organizations/:organization_id/sync_plans/:id/remove_products
Remove products from sync plan

Params

Param Name Description
id
Required

ID of the sync plan

Validations:

  • String

product_ids
Required

List of product ids to remove from the sync plan

Validations:

  • Must be an array of any type


PUT /katello/api/sync_plans/:id/sync
Initiate a sync of the products attached to the sync plan

PUT /katello/api/organizations/:organization_id/sync_plans/:id/sync
Initiate a sync of the products attached to the sync plan

Params

Param Name Description
id
Required

ID of the sync plan

Validations:

  • String