Get a project backup

GET/project-backups/{projectBackupId}/

API version

v2

Request method

GET

Operation ID

backup-get-project-backup

---

Request

• projectBackupIdstring (uuid)

  required

  ID of the ProjectBackup to retrieve.

Responses

Format

application/json

Description

OK

Schema documentation

• createdAtstring (date-time)
• deletableboolean

  required
• descriptionstring
• expiresAtstring (date-time)
• exportobject
  • downloadURLstring (url)
  • expiresAtstring (date-time)
  • formatstring

    required
  • phasestring (one of: , Pending, Exporting, Failed, Completed, Expired)
  • withPasswordboolean

    required
• idstring (uuid)

  required
• parentIdstring (uuid)
• projectIdstring (uuid)

  required
• statusstring

  required

Example

{
  "createdAt": "2024-12-22T00:30:30.824Z",
  "deletable": true,
  "description": "I'm a ProjectBackup",
  "expiresAt": "2024-12-22T00:30:30.824Z",
  "export": {
    "downloadURL": "string",
    "expiresAt": "2024-12-22T00:30:30.824Z",
    "format": "tar",
    "phase": "Completed",
    "withPassword": true
  },
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "parentId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "status": "Completed"
}

JSON Schema

{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "deletable": {
      "type": "boolean"
    },
    "description": {
      "example": "I'm a ProjectBackup",
      "type": "string"
    },
    "expiresAt": {
      "format": "date-time",
      "type": "string"
    },
    "export": {
      "properties": {
        "downloadURL": {
          "format": "url",
          "type": "string"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "format": {
          "example": "tar",
          "type": "string"
        },
        "phase": {
          "enum": [
            "",
            "Pending",
            "Exporting",
            "Failed",
            "Completed",
            "Expired"
          ],
          "example": "Completed",
          "type": "string"
        },
        "withPassword": {
          "type": "boolean"
        }
      },
      "required": [
        "format",
        "withPassword"
      ],
      "type": "object"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "parentId": {
      "format": "uuid",
      "type": "string"
    },
    "projectId": {
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "example": "Completed",
      "type": "string"
    }
  },
  "required": [
    "id",
    "projectId",
    "status",
    "deletable"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/project-backups/f0f86186-0a5a-45b2-aa33-502777496347

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.getProjectBackup({
  "projectBackupId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetProjectBackupRequest(
  projectBackupId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->backup()->getProjectBackup($request);

var_dump($response->getBody();