GET /katello/api/sync_plans
List sync plans

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

Examples

GET /katello/api/organizations/114267492/sync_plans
200
{
  "total": 1,
  "subtotal": 1,
  "selectable": 1,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 712395790,
      "organization_id": 114267492,
      "name": "Sync Plan Hourly",
      "description": "An hourly sync plan",
      "interval": "hourly",
      "next_sync": "2023-08-23 20:46:00 UTC",
      "sync_date": "2014-01-09 17:46:00 +0000",
      "created_at": "2014-01-09 17:46:00 UTC",
      "updated_at": "2023-08-23 20:15:21 UTC",
      "enabled": true,
      "foreman_tasks_recurring_logic_id": 29,
      "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
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, custom cron.
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

Search fields

Field name Type Possible values
enabled true, false
interval string
name string
organization_id integer