# GetVolume reads one volume by its resource name.


[API catalog](/reference/api/) · [Docker Sandboxes overview](/reference/api/sandboxes/latest/) · [Product manual](https://docs.docker.com/ai/sandboxes-api/) · [OpenAPI specification](/reference/api/sandboxes/api.yaml)

API version: v1


> This API is experimental. Features, interfaces,
> and behavior may change.




`GET /v1/volumes/{volume}`

GetVolume reads one volume by its resource name.

Returns unimplemented when this operation is unavailable. Support does not grant permission.

## Connection and access

[API connection and authentication guidance](/reference/api/sandboxes/latest/#authentication)


Server: `https://connect.docker.com/sandboxes`

Effective security: alternatives are OR; schemes within an alternative are AND. An empty array declares no HTTP authentication requirement.

```json
[
  {
    "bearer": []
  }
]
```

## Example request

Replace placeholders and provide the required credentials or request body.

```console
curl \
  --request GET \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Accept: application/json' \
  'https://connect.docker.com/sandboxes/v1/volumes/<VOLUME>'
```



## Parameters

### volume

Location: path. Required: yes.

The volume id.

```json
{
  "description": "The volume id.",
  "in": "path",
  "name": "volume",
  "pointer": "/paths/~1v1~1volumes~1{volume}/get/parameters/0",
  "required": true,
  "schema": {
    "type": "string"
  }
}
```

### If-None-Match

Location: header. Required: no.

A quoted entity-tag or comma-separated list, compared weakly with the current resource etag. A match, including a weak form or wildcard *, answers 304 without a body after authorization. Malformed input is treated as no match.

```json
{
  "description": "A quoted entity-tag or comma-separated list, compared weakly with the current resource etag. A match, including a weak form or wildcard *, answers 304 without a body after authorization. Malformed input is treated as no match.",
  "in": "header",
  "name": "If-None-Match",
  "pointer": "/paths/~1v1~1volumes~1{volume}/get/parameters/1",
  "schema": {
    "type": "string"
  }
}
```

## Request and responses

### Response 200 application/json

Success


Schema:

```json
{
  "$ref": "#/components/schemas/Volume"
}
```



Headers:

```json
{
  "ETag": {
    "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
    "schema": {
      "type": "string"
    }
  }
}
```








### Response 304 

The resource's etag equals the If-None-Match value, so this response carries no body.

No response content is declared.











### Response 404 application/json

The target is absent or not visible within the caller's scope.


Schema:

```json
{
  "$ref": "#/components/schemas/Error"
}
```









notFound:
```json
{
  "code": "notFound",
  "message": "The target is absent or not visible within the caller's scope."
}
```


### Response 501 application/json

This operation is not available on this service.


Schema:

```json
{
  "$ref": "#/components/schemas/Error"
}
```









unimplemented:
```json
{
  "code": "unimplemented",
  "message": "This operation is not available on this service."
}
```


### Response default application/json

The structured Error body identifies the failure with a stable code and optional typed details.


Schema:

```json
{
  "$ref": "#/components/schemas/Error"
}
```









Schema example:
```json
{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}
```


## Complete operation contract

```json
{
  "description": "GetVolume reads one volume by its resource name.\n\nReturns unimplemented when this operation is unavailable. Support does not grant permission.",
  "operationId": "getVolume",
  "parameters": [
    {
      "description": "The volume id.",
      "in": "path",
      "name": "volume",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "A quoted entity-tag or comma-separated list, compared weakly with the current resource etag. A match, including a weak form or wildcard *, answers 304 without a body after authorization. Malformed input is treated as no match.",
      "in": "header",
      "name": "If-None-Match",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Volume"
          }
        }
      },
      "description": "Success",
      "headers": {
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "304": {
      "description": "The resource's etag equals the If-None-Match value, so this response carries no body."
    },
    "404": {
      "content": {
        "application/json": {
          "examples": {
            "notFound": {
              "summary": "The target is absent or not visible within the caller's scope.",
              "value": {
                "code": "notFound",
                "message": "The target is absent or not visible within the caller's scope."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The target is absent or not visible within the caller's scope."
    },
    "501": {
      "content": {
        "application/json": {
          "examples": {
            "unimplemented": {
              "summary": "This operation is not available on this service.",
              "value": {
                "code": "unimplemented",
                "message": "This operation is not available on this service."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "This operation is not available on this service."
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "GetVolume reads one volume by its resource name.",
  "tags": [
    "Volumes"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "NOT_FOUND",
      "description": "The target is absent or not visible within the caller's scope."
    },
    {
      "code": "UNIMPLEMENTED",
      "description": "This operation is not available on this service."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "volumesRead"
  ],
  "x-sbx-serving-surface": "management"
}
```

## Referenced schemas

- [#/components/schemas/Error](/reference/api/sandboxes/latest/schemas/Error/)

- [#/components/schemas/Volume](/reference/api/sandboxes/latest/schemas/Volume/)