Get volume | Volumes | Northflank API docs
v1
ApplicationAPI & CLI
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

      • tags

        [array] required

        An array of previously defined tags to help identify and group the resource.

        • string
          min length
          3
          max length
          39
          pattern
          ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

      • spec

        (multiple options: oneOf) 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.

      • attachedObjects

        [array]

        List of objects this volume is attached to.

        • {object}

          The object to attach this volume to.

          • id

            string required

            The 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",
    "tags": [
      "my-tag"
    ],
    "spec": {
      "storageClassName": "ssd",
      "storageSize": 4096
    },
    "attachedObjects": [
      {
        "id": "example-service",
        "type": "service"
      }
    ],
    "status": "BOUND",
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com