Group Snapshots

Group snapshot management

List group snapshots

get

Lists all group snapshots

Authorizations

ApiKeyAuthBearerAuth

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/group_snapshots

HTTPcURLJavaScriptPython

GET /v3/v3/group_snapshots HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

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

Create group snapshot

post

Creates a group snapshot

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Body

application/json

Responses

202

Accepted

application/json

post

/v3/group_snapshots

HTTPcURLJavaScriptPython

POST /v3/v3/group_snapshots HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "group_snapshot": {
    "group_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text"
  }
}

202

Accepted

{
  "group_snapshot": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "text",
    "group_id": "123e4567-e89b-12d3-a456-426614174000",
    "group_type_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-11-28T20:22:24.030Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

List group snapshots with details

get

Lists all group snapshots with details

Authorizations

ApiKeyAuthBearerAuth

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/group_snapshots/detail

HTTPcURLJavaScriptPython

GET /v3/v3/group_snapshots/detail HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "group_snapshots": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "text",
      "group_id": "123e4567-e89b-12d3-a456-426614174000",
      "group_type_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-11-28T20:22:24.030Z",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Show group snapshot details

get

Shows details for a group snapshot

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

group_snapshot_idstring · uuidRequired

The UUID of the group snapshot

Responses

200

OK

application/json

get

/v3/group_snapshots/{group_snapshot_id}

HTTPcURLJavaScriptPython

GET /v3/v3/group_snapshots/{group_snapshot_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "group_snapshot": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "text",
    "group_id": "123e4567-e89b-12d3-a456-426614174000",
    "group_type_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-11-28T20:22:24.030Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Delete group snapshot

delete

Deletes a group snapshot

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

group_snapshot_idstring · uuidRequired

The UUID of the group snapshot

Responses

202

Request is accepted, but processing may take some time

delete

/v3/group_snapshots/{group_snapshot_id}

HTTPcURLJavaScriptPython

DELETE /v3/v3/group_snapshots/{group_snapshot_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