Types
Volume type management
Lists volume types
OpenStack authentication token
Filter the volume type by public visibility
Comma-separated list of sort keys and optional sort directions
Sorts by an attribute
Sorts by direction (asc or desc)
Requests a page size of items
Used in conjunction with limit to return items starting from the offset position
The ID of the last-seen item
OK
GET /v3/v3/types HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
OK
{
"volume_types": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"qos_specs_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Creates a volume type
OpenStack authentication token
OK
POST /v3/v3/types HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"volume_type": {
"name": "text",
"description": "text",
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
}OK
{
"volume_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"qos_specs_id": "123e4567-e89b-12d3-a456-426614174000"
}
}Shows details for the default volume type
OpenStack authentication token
OK
The requested resource could not be found
Something went wrong with the service which prevents it from fulfilling the request
GET /v3/v3/types/default HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
{
"volume_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"qos_specs_id": "123e4567-e89b-12d3-a456-426614174000"
}
}Shows details for a volume type
OpenStack authentication token
The UUID for an existing volume type
OK
GET /v3/v3/types/{volume_type_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
OK
{
"volume_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"qos_specs_id": "123e4567-e89b-12d3-a456-426614174000"
}
}Updates a volume type
OpenStack authentication token
The UUID for an existing volume type
OK
PUT /v3/v3/types/{volume_type_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"volume_type": {
"name": "text",
"description": "text",
"is_public": true
}
}OK
{
"volume_type": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"qos_specs_id": "123e4567-e89b-12d3-a456-426614174000"
}
}Deletes a volume type
OpenStack authentication token
The UUID for an existing volume type
Request is accepted, but processing may take some time
DELETE /v3/v3/types/{volume_type_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
Request is accepted, but processing may take some time
No content
Shows all extra specifications assigned to a volume type
OpenStack authentication token
The UUID for an existing volume type
OK
GET /v3/v3/types/{volume_type_id}/extra_specs HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
OK
{
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Adds new extra specifications to a volume type, or updates existing ones
OpenStack authentication token
The UUID for an existing volume type
OK
POST /v3/v3/types/{volume_type_id}/extra_specs HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
{
"extra_specs": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Shows the specific extra specification assigned to a volume type
OpenStack authentication token
The UUID for an existing volume type
The key name of the extra spec for a volume type
OK
GET /v3/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
OK
{}Update the specific extra specification assigned to a volume type
OpenStack authentication token
The UUID for an existing volume type
The key name of the extra spec for a volume type
OK
PUT /v3/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}OK
{}Deletes the specific extra specification assigned to a volume type
OpenStack authentication token
The UUID for an existing volume type
The key name of the extra spec for a volume type
Request is accepted, but processing may take some time
DELETE /v3/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
Request is accepted, but processing may take some time
No content
Adds or removes private volume type access to/from a project
OpenStack authentication token
The UUID for an existing volume type
Request is accepted, but processing may take some time
POST /v3/v3/types/{volume_type}/action HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"addProjectAccess": {
"project": "text"
}
}Request is accepted, but processing may take some time
No content
Lists project IDs that have access to private volume type
OpenStack authentication token
The UUID for an existing volume type
OK
GET /v3/v3/types/{volume_type}/os-volume-type-access HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
OK
{
"volume_type_access": [
{
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"volume_type_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Last updated
Was this helpful?