Types

Volume type management

List volume types

get

Lists volume types

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters
is_publicbooleanOptional

Filter the volume type 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/types
200

OK

Create volume type

post

Creates a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body
Responses
200

OK

application/json
post
/v3/types
200

OK

Show default volume type

get

Shows details for the default volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Responses
200

OK

application/json
get
/v3/types/default

Show volume type details

get

Shows details for a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

Responses
200

OK

application/json
get
/v3/types/{volume_type_id}
200

OK

Update volume type

put

Updates a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

Body
Responses
200

OK

application/json
put
/v3/types/{volume_type_id}
200

OK

Delete volume type

delete

Deletes a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

Responses
delete
/v3/types/{volume_type_id}
202

Request is accepted, but processing may take some time

No content

Show volume type extra specs

get

Shows all extra specifications assigned to a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

Responses
200

OK

application/json
get
/v3/types/{volume_type_id}/extra_specs
200

OK

Create or update volume type extra specs

post

Adds new extra specifications to a volume type, or updates existing ones

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

Body
Responses
200

OK

application/json
post
/v3/types/{volume_type_id}/extra_specs
200

OK

Show volume type extra spec

get

Shows the specific extra specification assigned to a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

keystringRequired

The key name of the extra spec for a volume type

Responses
200

OK

application/json
Responseobject
get
/v3/types/{volume_type_id}/extra_specs/{key}
200

OK

Update volume type extra spec

put

Update the specific extra specification assigned to a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

keystringRequired

The key name of the extra spec for a volume type

Body
objectOptional
Responses
200

OK

application/json
Responseobject
put
/v3/types/{volume_type_id}/extra_specs/{key}
200

OK

Delete volume type extra spec

delete

Deletes the specific extra specification assigned to a volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_type_idstring · uuidRequired

The UUID for an existing volume type

keystringRequired

The key name of the extra spec for a volume type

Responses
delete
/v3/types/{volume_type_id}/extra_specs/{key}
202

Request is accepted, but processing may take some time

No content

Add or remove volume type access

post

Adds or removes private volume type access to/from a project

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_typestring · uuidRequired

The UUID for an existing volume type

Body
or
Responses
post
/v3/types/{volume_type}/action
202

Request is accepted, but processing may take some time

No content

List volume type access

get

Lists project IDs that have access to private volume type

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
volume_typestring · uuidRequired

The UUID for an existing volume type

Responses
200

OK

application/json
get
/v3/types/{volume_type}/os-volume-type-access
200

OK

Last updated

Was this helpful?