---
title: "Get volume by id"
method: GET
path: "/v1/volumes/{volumeId}"
tags: ["Volumes"]
---

# Get volume by id

`GET /v1/volumes/{volumeId}`

## Request

- Base URL: `https://api.emma.ms/external`
- URL: `https://api.emma.ms/external/v1/volumes/{volumeId}`
- Auth: HTTP bearer

This endpoint returns a volume by ID.

## Path parameters

- `volumeId` integer, required

## Response `200`

Successful operation

- Volume
  - `id` integer: Volume ID
  - `name` string: Volume name
  - `attachedToId` integer: Compute instance ID that the volume is currently attached to
  - `projectId` integer: Project ID
  - `sizeGb` integer: Volume size in gigabytes
  - `type` 'hdd' | 'ssd' | 'ssd-plus': Volume type
  - `isSystem` boolean: Indicates whether the volume contains OS or not
  - `status` 'DRAFT' | 'BUSY' | 'AVAILABLE' | 'ACTIVE' | 'FAILED' | 'DELETED': Status of the volume
  - `provider` object
    - `id` integer: ID of the cloud provider
    - `name` string: Name of the cloud provider
  - `location` object
    - `id` integer: ID of the data center location
    - `name` string: Name of the data center location (city or state)
    - `country` string: Country of the data center location
    - `continent` string: Name of the geographical continent
    - `region` string: Name of the geographical region
    - `latitude` number, double: Approximate latitude of the geographical location
    - `longitude` number, double: Approximate longitude of the geographical location
  - `dataCenter` object
    - `id` string: Data center ID
    - `name` string: Data center name
    - `providerId` integer: ID of the cloud provider
    - `providerName` string: Name of the cloud provider
    - `locationId` integer: ID of the data center location
    - `locationName` string: Name of the data center location
  - `createdAt` string: Date and time when the volume was created
  - `createdByName` string: Name of the user who created the volume
  - `createdById` integer: ID of the user who created the volume
  - `modifiedAt` string: Date and time when the volume was last edited
  - `modifiedByName` string: Name of the user who last edited the volume
  - `modifiedById` integer: ID of the user who last edited the volume
  - `cost` object
    - `unit` string: Cost period
    - `currency` string: Currency of cost
    - `price` number: Cost of the volume for the period
  - `deviceIdentifier` string, nullable: Device identifier of the volume as seen by the operating system

## Other responses

- `401`: Unauthorized
- `403`: Forbidden - Access is denied
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/emma/apis/public-emma-api.md) - [All operations](https://skmtc.dev/emma/apis/public-emma-api/llms.txt) - [OpenAPI document](https://skmtc.dev/emma/apis/public-emma-api/revisions/9e55f0920078?raw)