APaptible
PersistentDisks

show persistent disk

Changed on

Returns the details of a specific persistent disk by ID.

get/persistent_disks/{id}

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

idinteger required

id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Response

successful

_typestring required
idinteger required
handlestring required
statusstring required
disk_typestring required
sizeinteger required
provisioned_iopsinteger required
disk_statusstring required
aws_resource_idstring required
kms_arnstring required
modification_progressinteger required
availability_zonestring required
formattedboolean required
created_atstring dateTime required
updated_atstring dateTime required
modified_atstring dateTime required
deleted_atstring dateTime required

Changes

  • 1dc1e5b8c6ebRevision changes
    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed