v1
Double column
API
CLI
JS Client

Volumes /

Get volume

Retrieve a volume

Required permission

Project > Volumes > General > Read

Path parameters

    • projectId

      string required

      ID of the project

    • volumeId

      string required

      ID of the volume

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • id

        string required

        Identifier for the volume

      • name

        string required

        Volume name

      • spec

        {object} required

        Information about the desired size and type of the volume. Storage class is only configurable with the relevant feature flag enabled for your account,

        • storageClassName

          string
          one of
          ssd, hdd
        • storageSize

          (multiple options) required
          • integer
            one of
            5120, 10240, 20480, 40960
            min
            4096
            max
            204800
          • OR

          • integer
            one of
            40960
            min
            40960
            max
            204800
      • owningObject

        {object}

        The object to attach this volume to.

        • id

          string required

          The internal id of object to attach this volume to.

          pattern
          ^[A-Za-z0-9-]+$
        • type

          string required

          The type of the object to attach this volume to.

          one of
          service
      • status

        string required

        Status the volume is in on the cluster

      • createdAt

        string required

        The timestamp the volume was created at

      • updatedAt

        string required

        The timestamp the volume was last updated at

API
CLI
JS Client

GET /v1/projects/{projectId}/volumes/{volumeId}

Example response

200 OK

Details about the specified Volume.

JSON

{
  "data": {
    "id": "example-volume",
    "name": "Example Volume",
    "spec": {},
    "owningObject": {
      "id": "example-service",
      "type": "service"
    },
    "status": "BOUND",
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}

© 2022 Northflank Ltd. All rights reserved.