Create a patch job to perform remediation

post_v1_command_remediate-patch-job

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

Example 

POST /v1/command/remediate-patch-job HTTP/1.1 
Content-Type: application/json   
Accept: application/json

Request format

 {           
  "description": "Patch job for group 1", 
  "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": { 
    "timestamp": "2024-12-18T10:00:00Z" 
  }, 
  "ignore_maintenance_windows": false, 
  "ignore_blackout_windows": false, 
  "certnames": [ 
    "string" 
  ],
  "vulnerabilities": [ 
    "string" 
  ] 
}

Parameters

Name In Type Required Description
body body remediate-patch-job-payload true none

Example response

201 Response

{ 
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" 
}

Response format

Status Meaning Description Schema
201 Created Created. remediate-patch-job-response
401 Unauthorized Authentication failed. not-authenticated-error
403 Forbidden Requestor does not have create permissions. forbidden-request-error