v1
Double column
API
CLI
JS Client

Volumes /

Attach volume

Attach a volume

Required permission

Project > Volumes > General > Update

Path parameters

    • projectId

      string required

      ID of the project

    • volumeId

      string required

      ID of the volume

Request body

  • {object}
    • owningObject

      {object} required

      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

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

    API
    CLI
    JS Client

    POST /v1/projects/{projectId}/volumes/{volumeId}/attach

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
      --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
      --request POST \
      --data '{"owningObject":{"id":"example-service","type":"service"}}' \
      http://api.northflank.com/v1/projects/{projectId}/volumes/{volumeId}/attach

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
      "data": {}
    }

    © 2022 Northflank Ltd. All rights reserved.