Update a Group
patch
/api/v2/groups/{id}/
Make a PUT or PATCH request to this resource to update this group. The following fields may be modified:
name
: Name of this group. (string, required)description
: Optional description of this group. (string, default=""
)inventory
: (id, required)variables
: Group variables in JSON or YAML format. (json, default=``)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : Group
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
inventory(required):
integer
Title:
Inventory
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
variables:
string
Title:
Variables
Group variables in JSON or YAML format.
Response
Supported Media Types
- application/json
200 Response
Root Schema : Group
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
inventory(required):
integer
Title:
Inventory
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
variables:
string
Title:
Variables
Group variables in JSON or YAML format.