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

Examples

POST /katello/api/organizations/114267492/sync_plans
{
  "sync_plan": {
    "name": "Hourly Sync Plan",
    "sync_date": "2014-01-09 17:46:00 +0000",
    "interval": "hourly",
    "description": "This is my cool new product.",
    "enabled": true
  }
}
201
{
  "id": 712395818,
  "organization_id": 114267492,
  "name": "Hourly Sync Plan",
  "description": "This is my cool new product.",
  "interval": "hourly",
  "next_sync": "2023-08-23 20:46:00 UTC",
  "sync_date": "2014-01-09 17:46:00 +0000",
  "created_at": "2023-08-23 20:15:20 UTC",
  "updated_at": "2023-08-23 20:15:20 UTC",
  "enabled": true,
  "foreman_tasks_recurring_logic_id": 25,
  "cron_expression": null,
  "products": [],
  "permissions": {
    "view_sync_plans": true,
    "edit_sync_plans": true,
    "destroy_sync_plans": true
  }
}

Params

Param name Description
organization_id
required

Organization ID

Validations:

  • Must be a number.
name
required

sync plan name

Validations:

  • String
interval
required

how often synchronization should run

Validations:

  • Must be one of: hourly, daily, weekly, custom cron.
sync_date
required

start datetime of synchronization

Validations:

  • String
description
optional

sync plan description

Validations:

  • String
enabled
required

enables or disables synchronization

Validations:

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

Add custom cron logic for sync plan

Validations:

  • String