List Backups belonging to a Project

GET/projects/{projectId}/backups/

API version

v2

Request method

GET

Operation ID

backup-list-project-backups

---

Request

• projectIdstring

  required

  ID of the Project to get Backups for.

Responses

Response headers

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountinteger

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

OK

Schema documentation

• Array[
  • *object
    • 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)
      • sha256Checksumstring
      • withPasswordboolean

        required
    • idstring (uuid)

      required
    • parentIdstring (uuid)
    • projectIdstring (uuid)

      required
    • requestedAtstring (date-time)

      required
    • restorePathobject
      • clearTargetPathboolean

        required
      • determinedTargetPathstring

        required
      • phasestring (one of: running, completed)

        required
      • sourcePathstring

        required
      • targetPathstring
    • statusstring

      required
  ]

Example

Content-Type: application/json

[
  {
    "createdAt": "1985-10-26T01:21:00.000Z",
    "deletable": true,
    "description": "I'm a ProjectBackup",
    "expiresAt": "1985-10-26T01:21:00.000Z",
    "export": {
      "downloadURL": "string",
      "expiresAt": "1985-10-26T01:21:00.000Z",
      "format": "tar",
      "phase": "Completed",
      "sha256Checksum": "string",
      "withPassword": true
    },
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "parentId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "requestedAt": "1985-10-26T01:21:00.000Z",
    "restorePath": {
      "clearTargetPath": true,
      "determinedTargetPath": "string",
      "phase": "running",
      "sourcePath": "string",
      "targetPath": "string"
    },
    "status": "Completed"
  }
]

JSON Schema

{
  "items": {
    "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"
          },
          "sha256Checksum": {
            "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"
      },
      "requestedAt": {
        "format": "date-time",
        "type": "string"
      },
      "restorePath": {
        "properties": {
          "clearTargetPath": {
            "default": false,
            "type": "boolean"
          },
          "determinedTargetPath": {
            "type": "string"
          },
          "phase": {
            "enum": [
              "running",
              "completed"
            ],
            "type": "string"
          },
          "sourcePath": {
            "type": "string"
          },
          "targetPath": {
            "type": "string"
          }
        },
        "required": [
          "phase",
          "sourcePath",
          "determinedTargetPath",
          "clearTargetPath"
        ],
        "type": "object"
      },
      "status": {
        "example": "Completed",
        "type": "string"
      }
    },
    "required": [
      "id",
      "projectId",
      "status",
      "deletable",
      "requestedAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/backups?searchTerm=string&withExportsOnly=true&sortOrder=oldestFirst&limit=50&page=1

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.listProjectBackups({
  "projectId": "string",
  "queryParameters": {
    "searchTerm": "string",
    "withExportsOnly": true,
    "sortOrder": "oldestFirst",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListProjectBackupsRequest(
  projectId: "string"
))
  ->withSearchTerm("string")
  ->withWithExportsOnly(true)
  ->withSortOrder("oldestFirst")
  ->withLimit(50)
  ->withPage(1);
$response = $client->backup()->listProjectBackups($request);

var_dump($response->getBody();