Change the description of a project backup

PATCH /v2/project-backups/{projectBackupId}/description/

API version

v2

Request method

PATCH

Operation ID

backup-update-project-backup-description

---

Request

• projectBackupIdstring (uuid)

  required

  ID of the ProjectBackup to change the description of.

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PATCH \
    -d '{"description":"I'm a ProjectBackup"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/project-backups/f0f86186-0a5a-45b2-aa33-502777496347/description

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.updateProjectBackupDescription({
  "projectBackupId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "description": "I'm a ProjectBackup"
  }
});

assertStatus(response, 204);
  

PHP SDK

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

// TODO: Please consult the properties and constructor signature of
// UpdateProjectBackupDescriptionRequestBody to learn how to construct a valid instance
$body = new UpdateProjectBackupDescriptionRequestBody(/* TODO: ... */);

$request = (new UpdateProjectBackupDescriptionRequest(
  projectBackupId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->backup()->updateProjectBackupDescription($request);

var_dump($response->getBody();