# Models

## The ApiVersions object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ApiVersions":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersion"}}}},"ApiVersion":{"type":"object","properties":{"id":{"description":"A common name for the version","type":"string"},"status":{"enum":["CURRENT","SUPPORTED","DEPRECATED"],"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"media-types":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"min_version":{"description":"The minimum microversion supported","type":"string"},"version":{"description":"The maximum microversion supported","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}},"MediaType":{"type":"object","properties":{"base":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The ApiVersion object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ApiVersion":{"type":"object","properties":{"id":{"description":"A common name for the version","type":"string"},"status":{"enum":["CURRENT","SUPPORTED","DEPRECATED"],"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"media-types":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"min_version":{"description":"The minimum microversion supported","type":"string"},"version":{"description":"The maximum microversion supported","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}},"MediaType":{"type":"object","properties":{"base":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The ApiVersionDetails object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ApiVersionDetails":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersion"}}}},"ApiVersion":{"type":"object","properties":{"id":{"description":"A common name for the version","type":"string"},"status":{"enum":["CURRENT","SUPPORTED","DEPRECATED"],"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"media-types":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"min_version":{"description":"The minimum microversion supported","type":"string"},"version":{"description":"The maximum microversion supported","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}},"MediaType":{"type":"object","properties":{"base":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Link object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The MediaType object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"MediaType":{"type":"object","properties":{"base":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Extensions object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Extensions":{"type":"object","properties":{"extensions":{"type":"array","items":{"$ref":"#/components/schemas/Extension"}}}},"Extension":{"type":"object","properties":{"alias":{"description":"The alias for the extension","type":"string"},"description":{"description":"The extension description","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"name":{"description":"The name of the extension","type":"string"},"updated":{"format":"date-time","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Extension object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Extension":{"type":"object","properties":{"alias":{"description":"The alias for the extension","type":"string"},"description":{"description":"The extension description","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"name":{"description":"The name of the extension","type":"string"},"updated":{"format":"date-time","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The VolumeTypes object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeTypes":{"type":"object","properties":{"volume_types":{"type":"array","items":{"$ref":"#/components/schemas/VolumeType"}}}},"VolumeType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume type","type":"string"},"name":{"description":"The name of the volume type","type":"string"},"description":{"description":"The volume type description","type":"string"},"is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"os-volume-type-access:is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"extra_specs":{"description":"Additional specifications for the volume type","type":"object","additionalProperties":{"type":"string"}},"qos_specs_id":{"nullable":true,"format":"uuid","description":"The QoS specifications ID","type":"string"}}}}}}
```

## The VolumeType object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume type","type":"string"},"name":{"description":"The name of the volume type","type":"string"},"description":{"description":"The volume type description","type":"string"},"is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"os-volume-type-access:is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"extra_specs":{"description":"Additional specifications for the volume type","type":"object","additionalProperties":{"type":"string"}},"qos_specs_id":{"nullable":true,"format":"uuid","description":"The QoS specifications ID","type":"string"}}}}}}
```

## The VolumesDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumesDetail":{"type":"object","properties":{"volumes":{"type":"array","items":{"$ref":"#/components/schemas/Volume"}},"volumes_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of volumes (microversion 3.45+)","type":"integer"}}},"Volume":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"name":{"nullable":true,"description":"The volume name","type":"string"},"description":{"nullable":true,"description":"The volume description","type":"string"},"size":{"description":"The size of the volume, in gibibytes (GiB)","type":"integer"},"status":{"description":"The volume status","type":"string"},"volume_type":{"description":"The associated volume type name for the volume","type":"string"},"volume_type_id":{"format":"uuid","description":"The associated volume type ID for the volume","type":"string"},"availability_zone":{"nullable":true,"description":"The name of the availability zone","type":"string"},"bootable":{"description":"Enables or disables the bootable attribute","type":"string"},"encrypted":{"description":"If true, this volume is encrypted","type":"boolean"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"multiattach":{"description":"If true, this volume can attach to more than one instance","type":"boolean"},"attachments":{"description":"Instance attachment information","type":"array","items":{"$ref":"#/components/schemas/VolumeAttachment"}},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"consistencygroup_id":{"nullable":true,"format":"uuid","description":"The UUID of the consistency group","type":"string"},"group_id":{"nullable":true,"format":"uuid","description":"The ID of the group (microversion 3.13+)","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"source_volid":{"nullable":true,"format":"uuid","description":"The UUID of the source volume","type":"string"},"replication_status":{"nullable":true,"description":"The volume replication status","type":"string"},"migration_status":{"nullable":true,"description":"The volume migration status","type":"string"},"os-vol-host-attr:host":{"nullable":true,"description":"Current back-end of the volume","type":"string"},"os-vol-tenant-attr:tenant_id":{"format":"uuid","description":"The project ID which the volume belongs to","type":"string"},"os-vol-mig-status-attr:migstat":{"nullable":true,"description":"The status of this volume migration","type":"string"},"os-vol-mig-status-attr:name_id":{"nullable":true,"description":"The volume ID that this volume name on the back-end is based on","type":"string"},"volume_image_metadata":{"description":"Image metadata entries","type":"object","additionalProperties":{"type":"string"}},"provider_id":{"nullable":true,"description":"The provider ID for the volume (microversion 3.21+)","type":"string"},"service_uuid":{"nullable":true,"format":"uuid","description":"Service UUID (microversion 3.48+)","type":"string"},"shared_targets":{"description":"Shared targets indicator (microversion 3.48+)","type":"boolean"},"cluster_name":{"nullable":true,"description":"The cluster name of volume backend (microversion 3.61+)","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"VolumeAttachment":{"type":"object","properties":{"server_id":{"format":"uuid","description":"The UUID of the attached server","type":"string"},"attachment_id":{"format":"uuid","description":"The attachment UUID","type":"string"},"attached_at":{"format":"date-time","description":"The date and time when attached","type":"string"},"host_name":{"nullable":true,"description":"The name of the attached host","type":"string"},"volume_id":{"format":"uuid","description":"The volume UUID","type":"string"},"device":{"description":"The device path","type":"string"},"id":{"format":"uuid","description":"The attachment ID","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Volume object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Volume":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"name":{"nullable":true,"description":"The volume name","type":"string"},"description":{"nullable":true,"description":"The volume description","type":"string"},"size":{"description":"The size of the volume, in gibibytes (GiB)","type":"integer"},"status":{"description":"The volume status","type":"string"},"volume_type":{"description":"The associated volume type name for the volume","type":"string"},"volume_type_id":{"format":"uuid","description":"The associated volume type ID for the volume","type":"string"},"availability_zone":{"nullable":true,"description":"The name of the availability zone","type":"string"},"bootable":{"description":"Enables or disables the bootable attribute","type":"string"},"encrypted":{"description":"If true, this volume is encrypted","type":"boolean"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"multiattach":{"description":"If true, this volume can attach to more than one instance","type":"boolean"},"attachments":{"description":"Instance attachment information","type":"array","items":{"$ref":"#/components/schemas/VolumeAttachment"}},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"consistencygroup_id":{"nullable":true,"format":"uuid","description":"The UUID of the consistency group","type":"string"},"group_id":{"nullable":true,"format":"uuid","description":"The ID of the group (microversion 3.13+)","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"source_volid":{"nullable":true,"format":"uuid","description":"The UUID of the source volume","type":"string"},"replication_status":{"nullable":true,"description":"The volume replication status","type":"string"},"migration_status":{"nullable":true,"description":"The volume migration status","type":"string"},"os-vol-host-attr:host":{"nullable":true,"description":"Current back-end of the volume","type":"string"},"os-vol-tenant-attr:tenant_id":{"format":"uuid","description":"The project ID which the volume belongs to","type":"string"},"os-vol-mig-status-attr:migstat":{"nullable":true,"description":"The status of this volume migration","type":"string"},"os-vol-mig-status-attr:name_id":{"nullable":true,"description":"The volume ID that this volume name on the back-end is based on","type":"string"},"volume_image_metadata":{"description":"Image metadata entries","type":"object","additionalProperties":{"type":"string"}},"provider_id":{"nullable":true,"description":"The provider ID for the volume (microversion 3.21+)","type":"string"},"service_uuid":{"nullable":true,"format":"uuid","description":"Service UUID (microversion 3.48+)","type":"string"},"shared_targets":{"description":"Shared targets indicator (microversion 3.48+)","type":"boolean"},"cluster_name":{"nullable":true,"description":"The cluster name of volume backend (microversion 3.61+)","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"VolumeAttachment":{"type":"object","properties":{"server_id":{"format":"uuid","description":"The UUID of the attached server","type":"string"},"attachment_id":{"format":"uuid","description":"The attachment UUID","type":"string"},"attached_at":{"format":"date-time","description":"The date and time when attached","type":"string"},"host_name":{"nullable":true,"description":"The name of the attached host","type":"string"},"volume_id":{"format":"uuid","description":"The volume UUID","type":"string"},"device":{"description":"The device path","type":"string"},"id":{"format":"uuid","description":"The attachment ID","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The VolumeAttachment object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeAttachment":{"type":"object","properties":{"server_id":{"format":"uuid","description":"The UUID of the attached server","type":"string"},"attachment_id":{"format":"uuid","description":"The attachment UUID","type":"string"},"attached_at":{"format":"date-time","description":"The date and time when attached","type":"string"},"host_name":{"nullable":true,"description":"The name of the attached host","type":"string"},"volume_id":{"format":"uuid","description":"The volume UUID","type":"string"},"device":{"description":"The device path","type":"string"},"id":{"format":"uuid","description":"The attachment ID","type":"string"}}}}}}
```

## The VolumeResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeResponse":{"type":"object","properties":{"volume":{"$ref":"#/components/schemas/Volume"}}},"Volume":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"name":{"nullable":true,"description":"The volume name","type":"string"},"description":{"nullable":true,"description":"The volume description","type":"string"},"size":{"description":"The size of the volume, in gibibytes (GiB)","type":"integer"},"status":{"description":"The volume status","type":"string"},"volume_type":{"description":"The associated volume type name for the volume","type":"string"},"volume_type_id":{"format":"uuid","description":"The associated volume type ID for the volume","type":"string"},"availability_zone":{"nullable":true,"description":"The name of the availability zone","type":"string"},"bootable":{"description":"Enables or disables the bootable attribute","type":"string"},"encrypted":{"description":"If true, this volume is encrypted","type":"boolean"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"multiattach":{"description":"If true, this volume can attach to more than one instance","type":"boolean"},"attachments":{"description":"Instance attachment information","type":"array","items":{"$ref":"#/components/schemas/VolumeAttachment"}},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"consistencygroup_id":{"nullable":true,"format":"uuid","description":"The UUID of the consistency group","type":"string"},"group_id":{"nullable":true,"format":"uuid","description":"The ID of the group (microversion 3.13+)","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"source_volid":{"nullable":true,"format":"uuid","description":"The UUID of the source volume","type":"string"},"replication_status":{"nullable":true,"description":"The volume replication status","type":"string"},"migration_status":{"nullable":true,"description":"The volume migration status","type":"string"},"os-vol-host-attr:host":{"nullable":true,"description":"Current back-end of the volume","type":"string"},"os-vol-tenant-attr:tenant_id":{"format":"uuid","description":"The project ID which the volume belongs to","type":"string"},"os-vol-mig-status-attr:migstat":{"nullable":true,"description":"The status of this volume migration","type":"string"},"os-vol-mig-status-attr:name_id":{"nullable":true,"description":"The volume ID that this volume name on the back-end is based on","type":"string"},"volume_image_metadata":{"description":"Image metadata entries","type":"object","additionalProperties":{"type":"string"}},"provider_id":{"nullable":true,"description":"The provider ID for the volume (microversion 3.21+)","type":"string"},"service_uuid":{"nullable":true,"format":"uuid","description":"Service UUID (microversion 3.48+)","type":"string"},"shared_targets":{"description":"Shared targets indicator (microversion 3.48+)","type":"boolean"},"cluster_name":{"nullable":true,"description":"The cluster name of volume backend (microversion 3.61+)","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"VolumeAttachment":{"type":"object","properties":{"server_id":{"format":"uuid","description":"The UUID of the attached server","type":"string"},"attachment_id":{"format":"uuid","description":"The attachment UUID","type":"string"},"attached_at":{"format":"date-time","description":"The date and time when attached","type":"string"},"host_name":{"nullable":true,"description":"The name of the attached host","type":"string"},"volume_id":{"format":"uuid","description":"The volume UUID","type":"string"},"device":{"description":"The device path","type":"string"},"id":{"format":"uuid","description":"The attachment ID","type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The VolumeCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeCreateRequest":{"type":"object","properties":{"volume":{"required":["size"],"type":"object","properties":{"size":{"description":"The size of the volume, in gibibytes (GiB)","type":"integer"},"name":{"description":"The volume name","type":"string"},"description":{"description":"The volume description","type":"string"},"availability_zone":{"description":"The name of the availability zone","type":"string"},"volume_type":{"description":"The volume type (either name or ID)","type":"string"},"source_volid":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"snapshot_id":{"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"backup_id":{"format":"uuid","description":"The UUID of the backup (microversion 3.47+)","type":"string"},"imageRef":{"format":"uuid","description":"The UUID of the image to create bootable volume","type":"string"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"consistencygroup_id":{"format":"uuid","description":"The UUID of the consistency group","type":"string"},"multiattach":{"description":"Enable multiattach capability","type":"boolean"}}},"OS-SCH-HNT:scheduler_hints":{"description":"Scheduler hints","type":"object"}}}}}}
```

## The VolumeUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeUpdateRequest":{"type":"object","properties":{"volume":{"type":"object","properties":{"name":{"description":"The volume name","type":"string"},"description":{"description":"The volume description","type":"string"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}}}}}}}}}
```

## The VolumesSummary object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumesSummary":{"type":"object","properties":{"volume-summary":{"type":"object","properties":{"total_size":{"description":"Total size of volumes in GB","type":"integer"},"total_count":{"description":"Total number of volumes","type":"integer"},"metadata":{"description":"Dictionary of lists containing all volumes' metadata (microversion 3.36+)","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## The Metadata object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Metadata":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The MetaItem object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"MetaItem":{"type":"object","properties":{"meta":{"type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The ExtendVolumeRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ExtendVolumeRequest":{"type":"object","properties":{"os-extend":{"required":["new_size"],"type":"object","properties":{"new_size":{"description":"The new size of the volume, in gibibytes (GiB)","type":"integer"}}}}}}}}
```

## The ExtendVolumeCompletionRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ExtendVolumeCompletionRequest":{"type":"object","properties":{"os-extend_volume_completion":{"type":"object","properties":{"error":{"description":"Used to indicate that the extend operation has failed","type":"boolean"}}}}}}}}
```

## The ResetStatusRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ResetStatusRequest":{"type":"object","properties":{"os-reset_status":{"required":["status"],"type":"object","properties":{"status":{"description":"The volume status","type":"string"},"migration_status":{"description":"The volume migration status","type":"string"},"attach_status":{"description":"The volume attach status","type":"string"}}}}}}}}
```

## The RevertToSnapshotRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"RevertToSnapshotRequest":{"type":"object","properties":{"revert":{"required":["snapshot_id"],"type":"object","properties":{"snapshot_id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"}}}}}}}}
```

## The SetImageMetadataRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SetImageMetadataRequest":{"type":"object","properties":{"os-set_image_metadata":{"required":["metadata"],"type":"object","properties":{"metadata":{"description":"Image metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}}}}}}}}}
```

## The UnsetImageMetadataRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"UnsetImageMetadataRequest":{"type":"object","properties":{"os-unset_image_metadata":{"required":["key"],"type":"object","properties":{"key":{"description":"The metadata key name to remove","type":"string"}}}}}}}}
```

## The ShowImageMetadataRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ShowImageMetadataRequest":{"type":"object","properties":{"os-show_image_metadata":{"type":"object"}}}}}}
```

## The AttachVolumeRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AttachVolumeRequest":{"type":"object","properties":{"os-attach":{"required":["mountpoint"],"type":"object","properties":{"instance_uuid":{"format":"uuid","description":"The UUID of the attaching instance","type":"string"},"host_name":{"description":"The name of the attaching host","type":"string"},"mountpoint":{"description":"The attaching mount point","type":"string"}}}}}}}}
```

## The DetachVolumeRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DetachVolumeRequest":{"type":"object","properties":{"os-detach":{"type":"object"}}}}}}
```

## The SnapshotsSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotsSimple":{"type":"object","properties":{"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/SnapshotSimple"}},"snapshots_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of snapshots (microversion 3.45+)","type":"integer"}}},"SnapshotSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"},"name":{"nullable":true,"description":"The snapshot name","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The SnapshotSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"},"name":{"nullable":true,"description":"The snapshot name","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The SnapshotsDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotsDetail":{"type":"object","properties":{"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/Snapshot"}},"snapshots_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of snapshots (microversion 3.45+)","type":"integer"}}},"Snapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"},"name":{"nullable":true,"description":"The snapshot name","type":"string"},"description":{"nullable":true,"description":"The snapshot description","type":"string"},"size":{"description":"The size of the snapshot, in gibibytes (GiB)","type":"integer"},"status":{"description":"The snapshot status","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"os-extended-snapshot-attributes:project_id":{"format":"uuid","description":"The project ID","type":"string"},"os-extended-snapshot-attributes:progress":{"description":"The snapshot progress","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Snapshot object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Snapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"},"name":{"nullable":true,"description":"The snapshot name","type":"string"},"description":{"nullable":true,"description":"The snapshot description","type":"string"},"size":{"description":"The size of the snapshot, in gibibytes (GiB)","type":"integer"},"status":{"description":"The snapshot status","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"os-extended-snapshot-attributes:project_id":{"format":"uuid","description":"The project ID","type":"string"},"os-extended-snapshot-attributes:progress":{"description":"The snapshot progress","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The SnapshotResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotResponse":{"type":"object","properties":{"snapshot":{"$ref":"#/components/schemas/Snapshot"}}},"Snapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the snapshot","type":"string"},"name":{"nullable":true,"description":"The snapshot name","type":"string"},"description":{"nullable":true,"description":"The snapshot description","type":"string"},"size":{"description":"The size of the snapshot, in gibibytes (GiB)","type":"integer"},"status":{"description":"The snapshot status","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"os-extended-snapshot-attributes:project_id":{"format":"uuid","description":"The project ID","type":"string"},"os-extended-snapshot-attributes:progress":{"description":"The snapshot progress","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"consumes_quota":{"description":"Whether this resource consumes quota (microversion 3.65+)","type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The SnapshotCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotCreateRequest":{"type":"object","properties":{"snapshot":{"required":["volume_id"],"type":"object","properties":{"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"name":{"description":"The snapshot name","type":"string"},"description":{"description":"The snapshot description","type":"string"},"force":{"description":"Create snapshot even if volume is in-use","type":"boolean"},"metadata":{"description":"Metadata key and value pairs","type":"object","additionalProperties":{"type":"string"}}}}}}}}}
```

## The SnapshotUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"SnapshotUpdateRequest":{"type":"object","properties":{"snapshot":{"type":"object","properties":{"name":{"description":"The snapshot name","type":"string"},"description":{"description":"The snapshot description","type":"string"}}}}}}}}
```

## The ResetSnapshotStatusRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ResetSnapshotStatusRequest":{"type":"object","properties":{"os-reset_status":{"required":["status"],"type":"object","properties":{"status":{"description":"The snapshot status","type":"string"}}}}}}}}
```

## The ManageSnapshotRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ManageSnapshotRequest":{"type":"object","properties":{"snapshot":{"required":["volume_id"],"type":"object","properties":{"volume_id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"ref":{"description":"Driver-specific reference object","type":"object"}}}}}}}}
```

## The UnmanageSnapshotRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"UnmanageSnapshotRequest":{"type":"object","properties":{"os-unmanage":{"type":"object"}}}}}}
```

## The Attachments object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Attachments":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}},"Attachment":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the attachment","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"instance":{"nullable":true,"format":"uuid","description":"The UUID of the instance","type":"string"},"status":{"description":"The attachment status","type":"string"},"attach_mode":{"description":"The attachment mode","type":"string"},"attached_at":{"nullable":true,"format":"date-time","description":"The date and time when attached","type":"string"},"detached_at":{"nullable":true,"format":"date-time","description":"The date and time when detached","type":"string"},"connector":{"nullable":true,"description":"Connector information","type":"object"},"connection_info":{"nullable":true,"description":"Connection information","type":"object"}}}}}}
```

## The Attachment object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Attachment":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the attachment","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"instance":{"nullable":true,"format":"uuid","description":"The UUID of the instance","type":"string"},"status":{"description":"The attachment status","type":"string"},"attach_mode":{"description":"The attachment mode","type":"string"},"attached_at":{"nullable":true,"format":"date-time","description":"The date and time when attached","type":"string"},"detached_at":{"nullable":true,"format":"date-time","description":"The date and time when detached","type":"string"},"connector":{"nullable":true,"description":"Connector information","type":"object"},"connection_info":{"nullable":true,"description":"Connection information","type":"object"}}}}}}
```

## The AttachmentResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AttachmentResponse":{"type":"object","properties":{"attachment":{"$ref":"#/components/schemas/Attachment"}}},"Attachment":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the attachment","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"instance":{"nullable":true,"format":"uuid","description":"The UUID of the instance","type":"string"},"status":{"description":"The attachment status","type":"string"},"attach_mode":{"description":"The attachment mode","type":"string"},"attached_at":{"nullable":true,"format":"date-time","description":"The date and time when attached","type":"string"},"detached_at":{"nullable":true,"format":"date-time","description":"The date and time when detached","type":"string"},"connector":{"nullable":true,"description":"Connector information","type":"object"},"connection_info":{"nullable":true,"description":"Connection information","type":"object"}}}}}}
```

## The AttachmentCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AttachmentCreateRequest":{"type":"object","properties":{"attachment":{"required":["volume_uuid"],"type":"object","properties":{"volume_uuid":{"format":"uuid","description":"The UUID of the volume","type":"string"},"instance_uuid":{"format":"uuid","description":"The UUID of the instance","type":"string"},"connector":{"description":"Connector information","type":"object"},"mode":{"description":"Attachment mode (microversion 3.54+)","enum":["rw","ro"],"type":"string"}}}}}}}}
```

## The AttachmentUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AttachmentUpdateRequest":{"type":"object","properties":{"attachment":{"type":"object","properties":{"connector":{"description":"Connector information","type":"object"}}}}}}}}
```

## The CompleteAttachmentRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"CompleteAttachmentRequest":{"type":"object","properties":{"os-complete":{"type":"object"}}}}}}
```

## The AvailabilityZones object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AvailabilityZones":{"type":"object","properties":{"availabilityZoneInfo":{"type":"array","items":{"$ref":"#/components/schemas/AvailabilityZone"}}}},"AvailabilityZone":{"type":"object","properties":{"zoneName":{"description":"The availability zone name","type":"string"},"zoneState":{"type":"object","properties":{"available":{"description":"Whether the zone is available","type":"boolean"}}}}}}}}
```

## The AvailabilityZone object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AvailabilityZone":{"type":"object","properties":{"zoneName":{"description":"The availability zone name","type":"string"},"zoneState":{"type":"object","properties":{"available":{"description":"Whether the zone is available","type":"boolean"}}}}}}}}
```

## The StoragePools object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"StoragePools":{"type":"object","properties":{"pools":{"type":"array","items":{"$ref":"#/components/schemas/StoragePool"}}}},"StoragePool":{"type":"object","properties":{"name":{"description":"The pool name","type":"string"},"capabilities":{"description":"Pool capabilities","type":"object"},"total_capacity_gb":{"description":"Total capacity in GB","type":"number"},"free_capacity_gb":{"description":"Free capacity in GB","type":"number"},"allocated_capacity_gb":{"description":"Allocated capacity in GB","type":"number"},"QoS_support":{"description":"Whether QoS is supported","type":"boolean"},"reserved_percentage":{"description":"Reserved percentage","type":"integer"},"driver_version":{"description":"Driver version","type":"string"},"storage_protocol":{"description":"Storage protocol","type":"string"},"vendor_name":{"description":"Vendor name","type":"string"},"volume_backend_name":{"description":"Volume backend name","type":"string"},"location_info":{"description":"Location information","type":"string"}}}}}}
```

## The StoragePool object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"StoragePool":{"type":"object","properties":{"name":{"description":"The pool name","type":"string"},"capabilities":{"description":"Pool capabilities","type":"object"},"total_capacity_gb":{"description":"Total capacity in GB","type":"number"},"free_capacity_gb":{"description":"Free capacity in GB","type":"number"},"allocated_capacity_gb":{"description":"Allocated capacity in GB","type":"number"},"QoS_support":{"description":"Whether QoS is supported","type":"boolean"},"reserved_percentage":{"description":"Reserved percentage","type":"integer"},"driver_version":{"description":"Driver version","type":"string"},"storage_protocol":{"description":"Storage protocol","type":"string"},"vendor_name":{"description":"Vendor name","type":"string"},"volume_backend_name":{"description":"Volume backend name","type":"string"},"location_info":{"description":"Location information","type":"string"}}}}}}
```

## The BackupsSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupsSimple":{"type":"object","properties":{"backups":{"type":"array","items":{"$ref":"#/components/schemas/BackupSimple"}},"backups_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of backups (microversion 3.45+)","type":"integer"}}},"BackupSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the backup","type":"string"},"name":{"nullable":true,"description":"The backup name","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The BackupSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the backup","type":"string"},"name":{"nullable":true,"description":"The backup name","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The BackupsDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupsDetail":{"type":"object","properties":{"backups":{"type":"array","items":{"$ref":"#/components/schemas/Backup"}},"backups_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of backups (microversion 3.45+)","type":"integer"}}},"Backup":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the backup","type":"string"},"name":{"nullable":true,"description":"The backup name","type":"string"},"description":{"nullable":true,"description":"The backup description","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"status":{"description":"The backup status","type":"string"},"size":{"description":"The size of the backup, in gibibytes (GiB)","type":"integer"},"object_count":{"description":"Number of objects in the backup","type":"integer"},"container":{"nullable":true,"description":"Backup container","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone of the backup","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"data_timestamp":{"format":"date-time","description":"The data timestamp","type":"string"},"has_dependent_backups":{"description":"Whether the backup has dependent backups","type":"boolean"},"is_incremental":{"description":"Whether the backup is incremental","type":"boolean"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The Backup object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Backup":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the backup","type":"string"},"name":{"nullable":true,"description":"The backup name","type":"string"},"description":{"nullable":true,"description":"The backup description","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"status":{"description":"The backup status","type":"string"},"size":{"description":"The size of the backup, in gibibytes (GiB)","type":"integer"},"object_count":{"description":"Number of objects in the backup","type":"integer"},"container":{"nullable":true,"description":"Backup container","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone of the backup","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"data_timestamp":{"format":"date-time","description":"The data timestamp","type":"string"},"has_dependent_backups":{"description":"Whether the backup has dependent backups","type":"boolean"},"is_incremental":{"description":"Whether the backup is incremental","type":"boolean"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The BackupResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupResponse":{"type":"object","properties":{"backup":{"$ref":"#/components/schemas/Backup"}}},"Backup":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the backup","type":"string"},"name":{"nullable":true,"description":"The backup name","type":"string"},"description":{"nullable":true,"description":"The backup description","type":"string"},"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"status":{"description":"The backup status","type":"string"},"size":{"description":"The size of the backup, in gibibytes (GiB)","type":"integer"},"object_count":{"description":"Number of objects in the backup","type":"integer"},"container":{"nullable":true,"description":"Backup container","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone of the backup","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"data_timestamp":{"format":"date-time","description":"The data timestamp","type":"string"},"has_dependent_backups":{"description":"Whether the backup has dependent backups","type":"boolean"},"is_incremental":{"description":"Whether the backup is incremental","type":"boolean"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"encryption_key_id":{"nullable":true,"format":"uuid","description":"The UUID of the encryption key (microversion 3.64+)","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The BackupCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupCreateRequest":{"type":"object","properties":{"backup":{"required":["volume_id"],"type":"object","properties":{"volume_id":{"format":"uuid","description":"The UUID of the source volume","type":"string"},"name":{"description":"The backup name","type":"string"},"description":{"description":"The backup description","type":"string"},"container":{"description":"Backup container","type":"string"},"incremental":{"description":"Create incremental backup","type":"boolean"},"force":{"description":"Create backup even if volume is in-use","type":"boolean"},"snapshot_id":{"format":"uuid","description":"The UUID of the source snapshot","type":"string"},"availability_zone":{"description":"The availability zone for the backup","type":"string"}}}}}}}}
```

## The BackupUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"BackupUpdateRequest":{"type":"object","properties":{"backup":{"type":"object","properties":{"name":{"description":"The backup name","type":"string"},"description":{"description":"The backup description","type":"string"}}}}}}}}
```

## The RestoreBackupRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"RestoreBackupRequest":{"type":"object","properties":{"restore":{"type":"object","properties":{"volume_id":{"format":"uuid","description":"The UUID of the target volume","type":"string"},"name":{"description":"Name for new volume if creating","type":"string"}}}}}}}}
```

## The ResetBackupStatusRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ResetBackupStatusRequest":{"type":"object","properties":{"os-reset_status":{"required":["status"],"type":"object","properties":{"status":{"description":"The backup status","type":"string"}}}}}}}}
```

## The ExportBackupRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ExportBackupRequest":{"type":"object","properties":{"backup-export":{"type":"object"}}}}}}
```

## The ImportBackupRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ImportBackupRequest":{"type":"object","properties":{"backup-import":{"required":["backup_service","backup_url"],"type":"object","properties":{"backup_service":{"description":"Backup service name","type":"string"},"backup_url":{"description":"Backup URL","type":"string"}}}}}}}}
```

## The Clusters object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Clusters":{"type":"object","properties":{"clusters":{"type":"array","items":{"$ref":"#/components/schemas/ClusterSimple"}}}},"ClusterSimple":{"type":"object","properties":{"name":{"description":"The cluster name","type":"string"},"binary":{"description":"The binary name","type":"string"},"state":{"description":"The cluster state","type":"string"},"status":{"description":"The cluster status","type":"string"}}}}}}
```

## The ClustersDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ClustersDetail":{"type":"object","properties":{"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}}}},"Cluster":{"type":"object","properties":{"name":{"description":"The cluster name","type":"string"},"binary":{"description":"The binary name","type":"string"},"state":{"description":"The cluster state","type":"string"},"status":{"description":"The cluster status","type":"string"},"num_hosts":{"description":"Number of hosts in the cluster","type":"integer"},"num_down_hosts":{"description":"Number of down hosts in the cluster","type":"integer"},"last_heartbeat":{"nullable":true,"format":"date-time","description":"Last heartbeat timestamp","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling cluster","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"}}}}}}
```

## The ClusterSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ClusterSimple":{"type":"object","properties":{"name":{"description":"The cluster name","type":"string"},"binary":{"description":"The binary name","type":"string"},"state":{"description":"The cluster state","type":"string"},"status":{"description":"The cluster status","type":"string"}}}}}}
```

## The Cluster object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Cluster":{"type":"object","properties":{"name":{"description":"The cluster name","type":"string"},"binary":{"description":"The binary name","type":"string"},"state":{"description":"The cluster state","type":"string"},"status":{"description":"The cluster status","type":"string"},"num_hosts":{"description":"Number of hosts in the cluster","type":"integer"},"num_down_hosts":{"description":"Number of down hosts in the cluster","type":"integer"},"last_heartbeat":{"nullable":true,"format":"date-time","description":"Last heartbeat timestamp","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling cluster","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"}}}}}}
```

## The ClusterResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ClusterResponse":{"type":"object","properties":{"cluster":{"$ref":"#/components/schemas/Cluster"}}},"Cluster":{"type":"object","properties":{"name":{"description":"The cluster name","type":"string"},"binary":{"description":"The binary name","type":"string"},"state":{"description":"The cluster state","type":"string"},"status":{"description":"The cluster status","type":"string"},"num_hosts":{"description":"Number of hosts in the cluster","type":"integer"},"num_down_hosts":{"description":"Number of down hosts in the cluster","type":"integer"},"last_heartbeat":{"nullable":true,"format":"date-time","description":"Last heartbeat timestamp","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling cluster","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"}}}}}}
```

## The ClusterUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ClusterUpdateRequest":{"type":"object","properties":{"cluster":{"type":"object","properties":{"disabled":{"description":"Whether to disable the cluster","type":"boolean"},"disabled_reason":{"description":"Reason for disabling","type":"string"}}}}}}}}
```

## The Services object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Services":{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"}}}},"Service":{"type":"object","properties":{"binary":{"description":"The service binary name","type":"string"},"host":{"description":"The host name","type":"string"},"zone":{"description":"The availability zone","type":"string"},"status":{"description":"The service status","type":"string"},"state":{"description":"The service state","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling service","type":"string"},"cluster":{"nullable":true,"description":"The cluster name","type":"string"},"frozen":{"description":"Whether the service is frozen","type":"boolean"},"replication_status":{"nullable":true,"description":"Replication status","type":"string"},"active_backend_id":{"nullable":true,"description":"Active backend ID","type":"string"}}}}}}
```

## The Service object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Service":{"type":"object","properties":{"binary":{"description":"The service binary name","type":"string"},"host":{"description":"The host name","type":"string"},"zone":{"description":"The availability zone","type":"string"},"status":{"description":"The service status","type":"string"},"state":{"description":"The service state","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling service","type":"string"},"cluster":{"nullable":true,"description":"The cluster name","type":"string"},"frozen":{"description":"Whether the service is frozen","type":"boolean"},"replication_status":{"nullable":true,"description":"Replication status","type":"string"},"active_backend_id":{"nullable":true,"description":"Active backend ID","type":"string"}}}}}}
```

## The ServiceResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ServiceResponse":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/Service"}}},"Service":{"type":"object","properties":{"binary":{"description":"The service binary name","type":"string"},"host":{"description":"The host name","type":"string"},"zone":{"description":"The availability zone","type":"string"},"status":{"description":"The service status","type":"string"},"state":{"description":"The service state","type":"string"},"updated_at":{"nullable":true,"format":"date-time","description":"The date and time when the resource was updated","type":"string"},"disabled_reason":{"nullable":true,"description":"Reason for disabling service","type":"string"},"cluster":{"nullable":true,"description":"The cluster name","type":"string"},"frozen":{"description":"Whether the service is frozen","type":"boolean"},"replication_status":{"nullable":true,"description":"Replication status","type":"string"},"active_backend_id":{"nullable":true,"description":"Active backend ID","type":"string"}}}}}}
```

## The ServiceUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ServiceUpdateRequest":{"type":"object","properties":{"body":{"type":"object","properties":{"disabled":{"description":"Whether to disable the service","type":"boolean"},"disabled_reason":{"description":"Reason for disabling","type":"string"}}}}}}}}
```

## The GroupsSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupsSimple":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupSimple"}}}},"GroupSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group","type":"string"},"name":{"nullable":true,"description":"The group name","type":"string"}}}}}}
```

## The GroupSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group","type":"string"},"name":{"nullable":true,"description":"The group name","type":"string"}}}}}}
```

## The GroupsDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupsDetail":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}},"Group":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group","type":"string"},"name":{"nullable":true,"description":"The group name","type":"string"},"description":{"nullable":true,"description":"The group description","type":"string"},"status":{"description":"The group status","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone","type":"string"},"group_type":{"description":"The group type","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group snapshot","type":"string"},"source_group_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group","type":"string"},"volume_types":{"description":"List of volume type IDs","type":"array","items":{"type":"string"}},"volumes":{"description":"List of volume UUIDs","type":"array","items":{"format":"uuid","type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The Group object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"Group":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group","type":"string"},"name":{"nullable":true,"description":"The group name","type":"string"},"description":{"nullable":true,"description":"The group description","type":"string"},"status":{"description":"The group status","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone","type":"string"},"group_type":{"description":"The group type","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group snapshot","type":"string"},"source_group_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group","type":"string"},"volume_types":{"description":"List of volume type IDs","type":"array","items":{"type":"string"}},"volumes":{"description":"List of volume UUIDs","type":"array","items":{"format":"uuid","type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The GroupResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupResponse":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/Group"}}},"Group":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group","type":"string"},"name":{"nullable":true,"description":"The group name","type":"string"},"description":{"nullable":true,"description":"The group description","type":"string"},"status":{"description":"The group status","type":"string"},"availability_zone":{"nullable":true,"description":"The availability zone","type":"string"},"group_type":{"description":"The group type","type":"string"},"group_snapshot_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group snapshot","type":"string"},"source_group_id":{"nullable":true,"format":"uuid","description":"The UUID of the source group","type":"string"},"volume_types":{"description":"List of volume type IDs","type":"array","items":{"type":"string"}},"volumes":{"description":"List of volume UUIDs","type":"array","items":{"format":"uuid","type":"string"}},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The GroupCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupCreateRequest":{"type":"object","properties":{"group":{"required":["group_type","volume_types"],"type":"object","properties":{"name":{"description":"The group name","type":"string"},"description":{"description":"The group description","type":"string"},"group_type":{"description":"The group type","type":"string"},"volume_types":{"description":"List of volume type names or IDs","type":"array","items":{"type":"string"}},"availability_zone":{"description":"The availability zone","type":"string"}}}}}}}}
```

## The GroupUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupUpdateRequest":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"description":"The group name","type":"string"},"description":{"description":"The group description","type":"string"},"add_volumes":{"description":"Comma-separated list of volume UUIDs to add","type":"string"},"remove_volumes":{"description":"Comma-separated list of volume UUIDs to remove","type":"string"}}}}}}}}
```

## The CreateGroupSnapshotRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"CreateGroupSnapshotRequest":{"type":"object","properties":{"create-group-snapshot":{"type":"object","properties":{"name":{"description":"The group snapshot name","type":"string"},"description":{"description":"The group snapshot description","type":"string"}}}}}}}}
```

## The DeleteGroupSnapshotRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DeleteGroupSnapshotRequest":{"type":"object","properties":{"delete-group-snapshot":{"required":["group_snapshot"],"type":"object","properties":{"group_snapshot":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"}}}}}}}}
```

## The ResetGroupStatusRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ResetGroupStatusRequest":{"type":"object","properties":{"reset_status":{"required":["status"],"type":"object","properties":{"status":{"description":"The group status","type":"string"}}}}}}}}
```

## The EnableGroupReplicationRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"EnableGroupReplicationRequest":{"type":"object","properties":{"enable_replication":{"type":"object"}}}}}}
```

## The DisableGroupReplicationRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DisableGroupReplicationRequest":{"type":"object","properties":{"disable_replication":{"type":"object"}}}}}}
```

## The FailoverGroupReplicationRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"FailoverGroupReplicationRequest":{"type":"object","properties":{"failover_replication":{"type":"object","properties":{"allow_attached_volume":{"description":"Allow attached volumes to be failed over","type":"boolean"},"secondary_backend_id":{"description":"Secondary backend ID","type":"string"}}}}}}}}
```

## The ListGroupReplicationTargetsRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ListGroupReplicationTargetsRequest":{"type":"object","properties":{"list_replication_targets":{"type":"object"}}}}}}
```

## The GroupSnapshotsSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshotsSimple":{"type":"object","properties":{"group_snapshots":{"type":"array","items":{"$ref":"#/components/schemas/GroupSnapshotSimple"}}}},"GroupSnapshotSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"name":{"nullable":true,"description":"The group snapshot name","type":"string"}}}}}}
```

## The GroupSnapshotSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshotSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"name":{"nullable":true,"description":"The group snapshot name","type":"string"}}}}}}
```

## The GroupSnapshotsDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshotsDetail":{"type":"object","properties":{"group_snapshots":{"type":"array","items":{"$ref":"#/components/schemas/GroupSnapshot"}}}},"GroupSnapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"name":{"nullable":true,"description":"The group snapshot name","type":"string"},"description":{"nullable":true,"description":"The group snapshot description","type":"string"},"status":{"description":"The group snapshot status","type":"string"},"group_id":{"format":"uuid","description":"The UUID of the source group","type":"string"},"group_type_id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The GroupSnapshot object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"name":{"nullable":true,"description":"The group snapshot name","type":"string"},"description":{"nullable":true,"description":"The group snapshot description","type":"string"},"status":{"description":"The group snapshot status","type":"string"},"group_id":{"format":"uuid","description":"The UUID of the source group","type":"string"},"group_type_id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The GroupSnapshotResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshotResponse":{"type":"object","properties":{"group_snapshot":{"$ref":"#/components/schemas/GroupSnapshot"}}},"GroupSnapshot":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group snapshot","type":"string"},"name":{"nullable":true,"description":"The group snapshot name","type":"string"},"description":{"nullable":true,"description":"The group snapshot description","type":"string"},"status":{"description":"The group snapshot status","type":"string"},"group_id":{"format":"uuid","description":"The UUID of the source group","type":"string"},"group_type_id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"created_at":{"format":"date-time","description":"The date and time when the resource was created","type":"string"},"user_id":{"format":"uuid","description":"The UUID of the user","type":"string"},"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"}}}}}}
```

## The GroupSnapshotCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSnapshotCreateRequest":{"type":"object","properties":{"group_snapshot":{"required":["group_id"],"type":"object","properties":{"group_id":{"format":"uuid","description":"The UUID of the source group","type":"string"},"name":{"description":"The group snapshot name","type":"string"},"description":{"description":"The group snapshot description","type":"string"}}}}}}}}
```

## The GroupTypes object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupTypes":{"type":"object","properties":{"group_types":{"type":"array","items":{"$ref":"#/components/schemas/GroupType"}}}},"GroupType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"name":{"description":"The name of the group type","type":"string"},"description":{"nullable":true,"description":"The group type description","type":"string"},"is_public":{"description":"Whether the group type is publicly visible","type":"boolean"},"group_specs":{"description":"Group specifications","type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The GroupType object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"name":{"description":"The name of the group type","type":"string"},"description":{"nullable":true,"description":"The group type description","type":"string"},"is_public":{"description":"Whether the group type is publicly visible","type":"boolean"},"group_specs":{"description":"Group specifications","type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The GroupTypeResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupTypeResponse":{"type":"object","properties":{"group_type":{"$ref":"#/components/schemas/GroupType"}}},"GroupType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the group type","type":"string"},"name":{"description":"The name of the group type","type":"string"},"description":{"nullable":true,"description":"The group type description","type":"string"},"is_public":{"description":"Whether the group type is publicly visible","type":"boolean"},"group_specs":{"description":"Group specifications","type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The GroupTypeCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupTypeCreateRequest":{"type":"object","properties":{"group_type":{"required":["name"],"type":"object","properties":{"name":{"description":"The name of the group type","type":"string"},"description":{"description":"The group type description","type":"string"},"is_public":{"description":"Whether the group type is publicly visible","type":"boolean"},"group_specs":{"description":"Group specifications","type":"object","additionalProperties":{"type":"string"}}}}}}}}}
```

## The GroupTypeUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupTypeUpdateRequest":{"type":"object","properties":{"group_type":{"type":"object","properties":{"name":{"description":"The name of the group type","type":"string"},"description":{"description":"The group type description","type":"string"},"is_public":{"description":"Whether the group type is publicly visible","type":"boolean"}}}}}}}}
```

## The GroupSpecs object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"GroupSpecs":{"type":"object","properties":{"group_specs":{"type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The ManageableVolumes object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ManageableVolumes":{"type":"object","properties":{"manageable-volumes":{"type":"array","items":{"$ref":"#/components/schemas/ManageableVolumeSimple"}}}},"ManageableVolumeSimple":{"type":"object","properties":{"reference":{"description":"Driver-specific reference object","type":"object"},"size":{"description":"Size of the volume in GB","type":"integer"},"safe_to_manage":{"description":"Whether the volume is safe to manage","type":"boolean"},"reason_not_safe":{"nullable":true,"description":"Reason why volume is not safe to manage","type":"string"},"cinder_id":{"nullable":true,"format":"uuid","description":"Cinder volume UUID if already managed","type":"string"},"extra_info":{"nullable":true,"description":"Additional information","type":"string"}}}}}}
```

## The ManageableVolumeSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ManageableVolumeSimple":{"type":"object","properties":{"reference":{"description":"Driver-specific reference object","type":"object"},"size":{"description":"Size of the volume in GB","type":"integer"},"safe_to_manage":{"description":"Whether the volume is safe to manage","type":"boolean"},"reason_not_safe":{"nullable":true,"description":"Reason why volume is not safe to manage","type":"string"},"cinder_id":{"nullable":true,"format":"uuid","description":"Cinder volume UUID if already managed","type":"string"},"extra_info":{"nullable":true,"description":"Additional information","type":"string"}}}}}}
```

## The ManageableVolumesDetail object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ManageableVolumesDetail":{"type":"object","properties":{"manageable-volumes":{"type":"array","items":{"$ref":"#/components/schemas/ManageableVolume"}}}},"ManageableVolume":{"type":"object","properties":{"reference":{"description":"Driver-specific reference object","type":"object"},"size":{"description":"Size of the volume in GB","type":"integer"},"safe_to_manage":{"description":"Whether the volume is safe to manage","type":"boolean"},"reason_not_safe":{"nullable":true,"description":"Reason why volume is not safe to manage","type":"string"},"cinder_id":{"nullable":true,"format":"uuid","description":"Cinder volume UUID if already managed","type":"string"},"extra_info":{"nullable":true,"description":"Additional information","type":"string"}}}}}}
```

## The ManageableVolume object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ManageableVolume":{"type":"object","properties":{"reference":{"description":"Driver-specific reference object","type":"object"},"size":{"description":"Size of the volume in GB","type":"integer"},"safe_to_manage":{"description":"Whether the volume is safe to manage","type":"boolean"},"reason_not_safe":{"nullable":true,"description":"Reason why volume is not safe to manage","type":"string"},"cinder_id":{"nullable":true,"format":"uuid","description":"Cinder volume UUID if already managed","type":"string"},"extra_info":{"nullable":true,"description":"Additional information","type":"string"}}}}}}
```

## The VolumeTypeResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeTypeResponse":{"type":"object","properties":{"volume_type":{"$ref":"#/components/schemas/VolumeType"}}},"VolumeType":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume type","type":"string"},"name":{"description":"The name of the volume type","type":"string"},"description":{"description":"The volume type description","type":"string"},"is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"os-volume-type-access:is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"extra_specs":{"description":"Additional specifications for the volume type","type":"object","additionalProperties":{"type":"string"}},"qos_specs_id":{"nullable":true,"format":"uuid","description":"The QoS specifications ID","type":"string"}}}}}}
```

## The VolumeTypeCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeTypeCreateRequest":{"type":"object","properties":{"volume_type":{"required":["name"],"type":"object","properties":{"name":{"description":"The name of the volume type","type":"string"},"description":{"description":"The volume type description","type":"string"},"os-volume-type-access:is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"},"extra_specs":{"description":"Additional specifications for the volume type","type":"object","additionalProperties":{"type":"string"}}}}}}}}}
```

## The VolumeTypeUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeTypeUpdateRequest":{"type":"object","properties":{"volume_type":{"type":"object","properties":{"name":{"description":"The name of the volume type","type":"string"},"description":{"description":"The volume type description","type":"string"},"is_public":{"description":"Whether the volume type is publicly visible","type":"boolean"}}}}}}}}
```

## The ExtraSpecs object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"ExtraSpecs":{"type":"object","properties":{"extra_specs":{"type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The VolumeTypeAccess object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeTypeAccess":{"type":"object","properties":{"volume_type_access":{"type":"array","items":{"type":"object","properties":{"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"volume_type_id":{"format":"uuid","description":"The UUID of the volume type","type":"string"}}}}}}}}}
```

## The AddProjectAccessRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"AddProjectAccessRequest":{"type":"object","properties":{"addProjectAccess":{"required":["project"],"type":"object","properties":{"project":{"description":"The ID of the project","type":"string"}}}}}}}}
```

## The RemoveProjectAccessRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"RemoveProjectAccessRequest":{"type":"object","properties":{"removeProjectAccess":{"required":["project"],"type":"object","properties":{"project":{"description":"The ID of the project","type":"string"}}}}}}}}
```

## The DefaultTypes object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DefaultTypes":{"type":"object","properties":{"default_types":{"type":"array","items":{"$ref":"#/components/schemas/DefaultType"}}}},"DefaultType":{"type":"object","properties":{"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"volume_type_id":{"format":"uuid","description":"The UUID of the volume type","type":"string"}}}}}}
```

## The DefaultType object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DefaultType":{"type":"object","properties":{"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"volume_type_id":{"format":"uuid","description":"The UUID of the volume type","type":"string"}}}}}}
```

## The DefaultTypeResponse object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DefaultTypeResponse":{"type":"object","properties":{"default_type":{"$ref":"#/components/schemas/DefaultType"}}},"DefaultType":{"type":"object","properties":{"project_id":{"format":"uuid","description":"The UUID of the project","type":"string"},"volume_type_id":{"format":"uuid","description":"The UUID of the volume type","type":"string"}}}}}}
```

## The DefaultTypeRequest object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"DefaultTypeRequest":{"type":"object","properties":{"default_type":{"required":["volume_type"],"type":"object","properties":{"volume_type":{"description":"The name or UUID for an existing volume type","type":"string"}}}}}}}}
```

## The VolumesSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumesSimple":{"type":"object","properties":{"volumes":{"type":"array","items":{"$ref":"#/components/schemas/VolumeSimple"}},"volumes_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"count":{"description":"Total count of volumes (microversion 3.45+)","type":"integer"}}},"VolumeSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"name":{"type":"string"}}},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The VolumeSimple object

```json
{"openapi":"3.0.3","info":{"title":"OpenStack Block Storage API (Cinder)","version":"3.71"},"components":{"schemas":{"VolumeSimple":{"type":"object","properties":{"id":{"format":"uuid","description":"The UUID of the volume","type":"string"},"name":{"type":"string"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform9.com/api-docs/block-storage-service/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.