Create a patch group

POST /v1/command/create-patch-group

To create a patch group, you must be authenticated by means of one of the following methods:

X-Authentication Header
RBAC Allowlisted Certificate

Request format

rule is an optional parameter. For more information about formatting see Rule condition grammar.

{
  "patch_group": {
    "name": "string",
    "description": "string",
    "node_list": [
      "string"
    ],
    "rule": [],
    "maintenance_windows": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "blackout_windows": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  },
  "options": {
    "force_move": false
  }
}

Parameters

Name	In	Type	Required	Description
body	body	create-patch-group-payload	true	none

Response format

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created.	patch-group-with-operation-response
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