Get a Project file's information

GET /v2/projects/{projectId}/filesystem-files/

API version

v2

Request method

GET

Operation ID

project-file-system-list-files

---

Request

• projectIdstring (uuid)

  required

  ID of the Project.

Responses

Format

application/json

Description

OK

Schema documentation

*

Example

null

JSON Schema

{
  "$ref": "#/components/schemas/de.mittwald.v1.project.FilesystemDirectoryListing"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/filesystem-files?file=%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.projectFileSystemListFiles({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "queryParameters": {
    "file": "/home/example.log"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

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

var_dump($response->getBody();