Get table of contents for a project backup

GET/project-backups/{projectBackupId}/path/

API version

v2

Request method

GET

Operation ID

backup-get-project-backup-directories

---

Request

• projectBackupIdstring

  required

  UUID of the Project Backup to get the table of contents for.

Responses

Format

application/json

Description

OK

Schema documentation

*

Example

Content-Type: application/json

null

JSON Schema

{
  "$ref": "#/components/schemas/de.mittwald.v1.backup.ProjectBackupPath"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/project-backups/string/path?directory=string

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.backup.getProjectBackupDirectories({
  "projectBackupId": "string",
  "queryParameters": {
    "directory": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Backup\GetProjectBackupDirectories\GetProjectBackupDirectoriesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetProjectBackupDirectoriesRequest(
  projectBackupId: "string"
))
  ->withDirectory("string");
$response = $client->backup()->getProjectBackupDirectories($request);

var_dump($response->getBody();