partitionTableBtrfsSubvolume_get.rst

partitionTableBtrfsSubvolume_get

.. function:: GET users/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}

Summary

• Method: GET
• Response Code: 200 / 304
• Response Formats: application/xml application/json
• Since: UForge 3.8.5

Retrieves the information of a btrfs subvolume.

Security Summary

• Requires Authentication: true
• Entitlements Required: appliance_create

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object` that created the appliance
• svid (required): the id of the :ref:`btrfssubvolume-object`
• ptid (required): the id of the :ref:`partitiontable-object`
• aid (required): the id of the :ref:`appliance-object`

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/apiusers/{uid}/appliances/{aid}/installProfile/{ipid}/pt/{ptid}/subvolumes/{svid}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`appliance-object`
         * :ref:`appliancepartitiontabledisk-api-resources`
         * :ref:`appliancepartitiontablediskpartition-api-resources`
         * :ref:`btrfssubvolume-object`
         * :ref:`partitionTableBtrfsSubvolume-create`
         * :ref:`partitionTableBtrfsSubvolume-delete`
         * :ref:`partitionTableBtrfsSubvolume-deleteAll`
         * :ref:`partitionTableBtrfsSubvolume-getAll`
         * :ref:`partitionTableBtrfsSubvolume-update`
         * :ref:`partitiontable-object`