Group Types

Group type management

List group types

get

Lists all group types

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters
is_publicbooleanOptional

Filter by public visibility

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_types
GET /v3/v3/group_types HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "group_types": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "is_public": true,
      "group_specs": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Create group type

post

Creates a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Body
Responses
200

OK

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

{
  "group_type": {
    "name": "text",
    "description": "text",
    "is_public": true,
    "group_specs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}
200

OK

{
  "group_type": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "is_public": true,
    "group_specs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Show default group type

get

Shows details for the default group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Responses
200

OK

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

OK

{
  "group_type": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "is_public": true,
    "group_specs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Show group type details

get

Shows details for a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

Responses
200

OK

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

OK

{
  "group_type": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "is_public": true,
    "group_specs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Update group type

put

Updates a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

Body
Responses
200

OK

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

{
  "group_type": {
    "name": "text",
    "description": "text",
    "is_public": true
  }
}
200

OK

{
  "group_type": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "is_public": true,
    "group_specs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Delete group type

delete

Deletes a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

Responses
delete
/v3/group_types/{group_type_id}
DELETE /v3/v3/group_types/{group_type_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

Show group type specs

get

Shows all group specs assigned to a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

Responses
200

OK

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

OK

{
  "group_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Create or update group type specs

post

Adds new group specs to a group type, or updates existing ones

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

Body
Responses
200

OK

application/json
post
/v3/group_types/{group_type_id}/group_specs
POST /v3/v3/group_types/{group_type_id}/group_specs HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "group_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
200

OK

{
  "group_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Show group type spec

get

Shows the specific group spec assigned to a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

keystringRequired

The key name of the group spec

Responses
200

OK

application/json
Responseobject
get
/v3/group_types/{group_type_id}/group_specs/{key}
GET /v3/v3/group_types/{group_type_id}/group_specs/{key} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{}

Update group type spec

put

Update the specific group spec assigned to a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

keystringRequired

The key name of the group spec

Body
objectOptional
Responses
200

OK

application/json
Responseobject
put
/v3/group_types/{group_type_id}/group_specs/{key}
PUT /v3/v3/group_types/{group_type_id}/group_specs/{key} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

OK

{}

Delete group type spec

delete

Deletes the specific group spec assigned to a group type

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
group_type_idstring · uuidRequired

The UUID of the group type

keystringRequired

The key name of the group spec

Responses
delete
/v3/group_types/{group_type_id}/group_specs/{key}
DELETE /v3/v3/group_types/{group_type_id}/group_specs/{key} 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
PreviousGroup SnapshotsNextManageable Volumes

Last updated

Was this helpful?