Create a Group for an Inventory

post

/api/v2/inventories/{id}/groups/

Make a POST request to this resource with the following group fields to create a new group associated with this inventory.

name: Name of this group. (string, required)
description: Optional description of this group. (string, default="")
variables: Group variables in JSON or YAML format. (json, default=``)

Remove Inventory Groups:

Make a POST request to this resource with id and disassociate fields to delete the associated group.

{
    "id": 123,
    "disassociate": true
}

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Root Schema : schema

Example:

{
    "description":"Hello world",
    "name":"New name"
}

Response

Supported Media Types

application/json

201 Response

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":""
}

400 Response

Example Response (application/json)

{
    "inventory":{
        "detail":"Cannot create Group for Smart Inventory"
    }
}

403 Response

Example Response (application/json)

{
    "detail":"You do not have permission to perform this action."
}