Create a patch job

POST /v1/command/create-patch-job

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

Request format

{
  "name": "string",
  "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
}

Parameters

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

Response format

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

Responses

Status Meaning Description Schema
201 Created Created. Inline
401 Unauthorized Authentication failed. not-authenticated-error
403 Forbidden Requester does not have create permissions. forbidden-request-error
409 Conflict Node already exists in a different patch group and force is false. collision-error
415 Unsupported Media Type Content type of payload is unsupported. content-type-error
500 Internal Server Error Unexpected server error. error

Response schema

Name In Type Required Description
ยป id string(uuid) true none none