Get a single patch job

GET /v1/patch-jobs/{id}

To get a single patch job, you must be authenticated by means of one of the following methods:
  • X-Authentication Header
  • RBAC Allowlisted Certificate

Parameters

Name In Type Required Description
id path identifier true none

Response format

{
  "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"
}

Responses

Status Meaning Description Schema
200 OK Request was successful, returns an individual patch job. patch-job-response
401 Unauthorized Authentication failed. not-authenticated-error
403 Forbidden Requester does not have view permissions. forbidden-request-error
404 Not Found Patch job not found. error