1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Groups

Update a Group

put

/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 PUT request, include all fields in the request.

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Root Schema : schema
Example:
{
    "description":"Hello world",
    "name":"New name"
}
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"Hello world",
    "id":1,
    "inventory":1,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"New name",
    "related":{
        "activity_stream":"/api/v2/groups/1/activity_stream/",
        "ad_hoc_commands":"/api/v2/groups/1/ad_hoc_commands/",
        "all_hosts":"/api/v2/groups/1/all_hosts/",
        "children":"/api/v2/groups/1/children/",
        "hosts":"/api/v2/groups/1/hosts/",
        "inventory":"/api/v2/inventories/1/",
        "inventory_sources":"/api/v2/groups/1/inventory_sources/",
        "job_events":"/api/v2/groups/1/job_events/",
        "job_host_summaries":"/api/v2/groups/1/job_host_summaries/",
        "potential_children":"/api/v2/groups/1/potential_children/",
        "variable_data":"/api/v2/groups/1/variable_data/"
    },
    "summary_fields":{
        "inventory":{
            "description":"",
            "has_active_failures":false,
            "has_inventory_sources":false,
            "hosts_with_active_failures":0,
            "id":1,
            "inventory_sources_with_failures":0,
            "kind":"",
            "name":"test-inv",
            "organization_id":1,
            "total_groups":0,
            "total_hosts":0,
            "total_inventory_sources":0
        },
        "user_capabilities":{
            "copy":true,
            "delete":true,
            "edit":true
        }
    },
    "type":"group",
    "url":"/api/v2/groups/1/",
    "variables":""
}

403 Response

Body
Example Response (application/json)
{
    "detail":"You do not have permission to perform this action."
}
Back to Top