Types

Volume type management

List volume types

get

Lists volume types

Authorizations

pcdAuth

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

HTTPcURLJavaScriptPython

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

200

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"
    }
  ]
}

Create volume type

post

Creates a volume type

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body

application/json

Responses

200

OK

application/json

post

/v3/types

HTTPcURLJavaScriptPython

POST /cinder/v3/types HTTP/1.1
Host: example.platform9.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"
    }
  }
}

200

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"
  }
}

Show default volume type

get

Shows details for the default volume type

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Responses

200

OK

application/json

404

The requested resource could not be found

500

Something went wrong with the service which prevents it from fulfilling the request

get

/v3/types/default

HTTPcURLJavaScriptPython

GET /cinder/v3/types/default HTTP/1.1
Host: example.platform9.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"
  }
}

Show volume type details

get

Shows details for a volume type

Authorizations

pcdAuth

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}

HTTPcURLJavaScriptPython

GET /cinder/v3/types/{volume_type_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

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"
  }
}

Update volume type

put

Updates a volume type

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

volume_type_idstring · uuidRequired

The UUID for an existing volume type

Body

application/json

Responses

200

OK

application/json

put

/v3/types/{volume_type_id}

HTTPcURLJavaScriptPython

PUT /cinder/v3/types/{volume_type_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "volume_type": {
    "name": "text",
    "description": "text",
    "is_public": true
  }
}

200

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"
  }
}

Delete volume type

delete

Deletes a volume type

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

volume_type_idstring · uuidRequired

The UUID for an existing volume type

Responses

202

Request is accepted, but processing may take some time

delete

/v3/types/{volume_type_id}

HTTPcURLJavaScriptPython

DELETE /cinder/v3/types/{volume_type_id} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

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

pcdAuth

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

HTTPcURLJavaScriptPython

GET /cinder/v3/types/{volume_type_id}/extra_specs HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "extra_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Create or update volume type extra specs

post

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

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

volume_type_idstring · uuidRequired

The UUID for an existing volume type

Body

application/json

Responses

200

OK

application/json

post

/v3/types/{volume_type_id}/extra_specs

HTTPcURLJavaScriptPython

POST /cinder/v3/types/{volume_type_id}/extra_specs HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "extra_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

{
  "extra_specs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Show volume type extra spec

get

Shows the specific extra specification assigned to a volume type

Authorizations

pcdAuth

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}

HTTPcURLJavaScriptPython

GET /cinder/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{}

Update volume type extra spec

put

Update the specific extra specification assigned to a volume type

Authorizations

pcdAuth

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

application/json

objectOptional

Responses

200

OK

application/json

Responseobject

put

/v3/types/{volume_type_id}/extra_specs/{key}

HTTPcURLJavaScriptPython

PUT /cinder/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

OK

{}

Delete volume type extra spec

delete

Deletes the specific extra specification assigned to a volume type

Authorizations

pcdAuth

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

202

Request is accepted, but processing may take some time

delete

/v3/types/{volume_type_id}/extra_specs/{key}

HTTPcURLJavaScriptPython

DELETE /cinder/v3/types/{volume_type_id}/extra_specs/{key} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

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

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

volume_typestring · uuidRequired

The UUID for an existing volume type

Body

application/json

or

Responses

202

Request is accepted, but processing may take some time

post

/v3/types/{volume_type}/action

HTTPcURLJavaScriptPython

POST /cinder/v3/types/{volume_type}/action HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "addProjectAccess": {
    "project": "text"
  }
}

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

pcdAuth

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

HTTPcURLJavaScriptPython

GET /cinder/v3/types/{volume_type}/os-volume-type-access HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "volume_type_access": [
    {
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "volume_type_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}