Documentation menu

Get service volume

GEThttps://api.instacloud.com/projects/{projectId}/services/{serviceId}/volume

Token scope: account · org · project — read-only tokens allowed.

A compute or managed-database service's data volume (size + mount path — configurable on attachment for compute, the image's data directory for a managed DB; null when none is attached) plus this plan's volume cap.

Parameters

NameInTypeRequiredDescription
projectIdpathstringyes
serviceIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
volumeobject | nullyesnull = no volume attached (attach one any time with PUT …/volume)
volume.sizeGibintegeryes
volume.mountPathstringyesconfigured container mount path (defaults to /data for compute)
volume.idstring | nullno
volume.appliedMountPathstring | nullno
volume.pendingbooleanno
capobjectyes
cap.volumeGibintegeryesthis plan's maximum volume size (whole Gi)

400

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown