Groups

Generic volume group management

List groups

get

Lists all generic volume groups

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

Responses
200

OK

application/json
get
/v3/groups
GET /v3/v3/groups HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "groups": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ]
}

Create group

post

Creates a generic volume group

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Body
Responses
post
/v3/groups
POST /v3/v3/groups HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "group": {
    "name": "text",
    "description": "text",
    "group_type": "text",
    "volume_types": [
      "text"
    ],
    "availability_zone": "text"
  }
}
202

Accepted

{
  "group": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "text",
    "availability_zone": "text",
    "group_type": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "source_group_id": "123e4567-e89b-12d3-a456-426614174000",
    "volume_types": [
      "text"
    ],
    "volumes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "created_at": "2025-11-28T20:25:35.485Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

List groups with details

get

Lists all generic volume groups with details

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

Responses
200

OK

application/json
get
/v3/groups/detail
GET /v3/v3/groups/detail HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "groups": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "text",
      "availability_zone": "text",
      "group_type": "text",
      "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
      "source_group_id": "123e4567-e89b-12d3-a456-426614174000",
      "volume_types": [
        "text"
      ],
      "volumes": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "created_at": "2025-11-28T20:25:35.485Z",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Show group details

get

Shows details for a group

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_idstring · uuidRequired

The UUID of the group

Responses
200

OK

application/json
get
/v3/groups/{group_id}
GET /v3/v3/groups/{group_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "group": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "text",
    "availability_zone": "text",
    "group_type": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "source_group_id": "123e4567-e89b-12d3-a456-426614174000",
    "volume_types": [
      "text"
    ],
    "volumes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "created_at": "2025-11-28T20:25:35.485Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Update group

put

Updates a group

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_idstring · uuidRequired

The UUID of the group

Body
Responses
200

OK

application/json
put
/v3/groups/{group_id}
PUT /v3/v3/groups/{group_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "group": {
    "name": "text",
    "description": "text",
    "add_volumes": "text",
    "remove_volumes": "text"
  }
}
200

OK

{
  "group": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "text",
    "availability_zone": "text",
    "group_type": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "source_group_id": "123e4567-e89b-12d3-a456-426614174000",
    "volume_types": [
      "text"
    ],
    "volumes": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "created_at": "2025-11-28T20:25:35.485Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Delete group

delete

Deletes a group

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_idstring · uuidRequired

The UUID of the group

Query parameters
delete-volumesbooleanOptional

Also delete volumes in the group

Default: false
Responses
delete
/v3/groups/{group_id}
DELETE /v3/v3/groups/{group_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
202

Request is accepted, but processing may take some time

No content

Perform group action

post

Performs various actions on a group

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_idstring · uuidRequired

The UUID of the group

Body
one ofOptional
or
or
or
or
or
or
Responses
200

OK (for list operations)

application/json
Responseobject
post
/v3/groups/{group_id}/action
POST /v3/v3/groups/{group_id}/action HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "create-group-snapshot": {
    "name": "text",
    "description": "text"
  }
}
{}
PreviousServicesNextGroup Snapshots

Last updated

Was this helpful?