Get a Project directory filesystem usage

GET/projects/{projectId}/filesystem-disk-usage/

API version

v2

Request method

GET

Operation ID

project-file-system-get-disk-usage

---

Request

• projectIdstring (uuid)

  required

  ID of the Project.

Responses

Format

application/json

Description

OK

Schema documentation

• pathstring
• totalBytesinteger
• usedBytesinteger

Example

{
  "path": "string",
  "totalBytes": 123,
  "usedBytes": 123
}

JSON Schema

{
  "properties": {
    "path": {
      "type": "string"
    },
    "totalBytes": {
      "type": "integer"
    },
    "usedBytes": {
      "type": "integer"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/filesystem-disk-usage?directory=%2Fhome%2Fexample.log

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.projectFileSystem.projectFileSystemGetDiskUsage({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "queryParameters": {
    "directory": "/home/example.log"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\ProjectFileSystem\ProjectFileSystemGetDiskUsage\ProjectFileSystemGetDiskUsageRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ProjectFileSystemGetDiskUsageRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
))
  ->withDirectory("/home/example.log");
$response = $client->projectFileSystem()->projectFileSystemGetDiskUsage($request);

var_dump($response->getBody();