Get a list of patch jobs

Parameters

Name	In	Type	Required	Description
limit	query	limit	false	none
offset	query	offset	false	none

Response format

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "description": "string",
      "parameters": {
        "yum_params": "string",
        "dpkg_params": "string",
        "zypper_params": "string",
        "reboot": "always",
        "timeout": 3600,
        "security_only": false,
        "clean_cache": true
      },
      "scope": {
        "patch_group_id": "29980d5c-46c9-4ec0-82cc-ea2bba6a4260"
      },
      "schedule": {
        "frequency": "now",
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "ignore_maintenance_windows": false,
      "ignore_blackout_windows": false,
      "next_run_time": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "job_type": "patching"
    }
  ],
  "pagination": {
    "limit": 1000,
    "offset": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Request was successful, returns an array of patch jobs.	Inline
401	Unauthorized	Authentication failed.	not-authenticated-error
403	Forbidden	Requester does not have view permissions.	forbidden-request-error

Response schema

Status code: 200

Name	Type	Required	Restrictions	Description
» items	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none
»»» id	identifier(uuid)	false	none	none

and

Name	Type	Required	Restrictions	Description
»» anonymous	patch-job	false	none	none
»»» description	string	false	none	none
»»» parameters	patch-job-parameters	false	none	none
»»»» yum_params	string	false	none	Any additional parameters to include in the yum upgrade command (such as including/excluding repos)
»»»» dpkg_params	string	false	none	Any additional parameters to include in the dpkg command
»»»» zypper_params	string	false	none	Any additional parameters to include in the zypper update command
»»»» reboot	string	false	none	Should the server reboot after patching has been applied? (Defaults to 'never')
»»»» timeout	integer	false	none	How many seconds should we wait until timing out the patch run?
»»»» security_only	boolean	false	none	Limit patches to those tagged as security related?
»»»» clean_cache	boolean	false	none	Should the yum/dpkg caches be cleaned at the start of the task? (Defaults to false)
»»» scope	object	false	none	none
»»»» patch_group_id	string(uuid)	false	none	none
»»» schedule	object	true	none	none
»»»» frequency	string	true	none	How often the job should run. If now, the rest of the schedule is ignored, and will be run at the first opportunity.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	one-time-execution	false	none	none
»»»»» timestamp	string(date-time)	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	repeated-time-interval	false	none	none
»»»»» name	string	true	none	A user defined unique name for the interval
»»»»» description	string	false	none	A user defined description for the interval
»»»»» series_start	string(date)	false	none	The start of the valid period for the series. If not specified, defaults to today in UTC
»»»»» series_end	string(date)	false	none	The end of the valid period of the series. If not specified, implies the end of time.
»»»»» series	object	true	none	Define valid periods of time within the overall window. Times within the overall window that are outside a subwindow are not valid.
»»»»»» cron	string	true	none	cron tab specification per https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html#format

continued

Name	Type	Required	Restrictions	Description
»»» ignore_maintenance_windows	boolean	false	none	Allow this job run outside the defined maintenance windows
»»» ignore_blackout_windows	boolean	false	none	Allow this job run inside the defined blackout windows

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» next_run_time	string(date-time)	false	none	When the job will next run, if applicable
»»» created_by	string(uuid)	false	none	User id that created the job
»»» job_type none	string	false	none	The type of patch job

continued

Name	Type	Required	Restrictions	Description
pagination	object	false	none	none
»» limit	limit	false	none	The maximum number of records returned. Zero indicates no limit.
»» offset	offset	false	none	The number of records skipped before collecting the results.

Enumerated values

Property	Value
reboot	always
reboot	never
reboot	patched
reboot	smart
frequency	now
frequency	once
frequency	recurring
job_type	patching
job_type	remediate