Create a backup schedule for a Project

POST/projects/{projectId}/backup-schedules/

API version

v2

Request method

POST

Operation ID

backup-create-project-backup-schedule

---

Request

• projectIdstring (uuid)

  required

  ID of the Project to create a BackupSchedule for.

Responses

Format

application/json

Description

Created

Schema documentation

• createdAtstring (date-time)
• descriptionstring

  Description of this ProjectBackupSchedule.

• idstring (uuid)

  required

  ID of this ProjectBackupSchedule.

• isSystemBackupboolean

  required

  True if this ProjectBackupSchedule was created and is managed by mittwald.

• projectIdstring (uuid)

  required

  ID of the Project this ProjectBackupSchedule belongs to.

• schedulestring

  required

  Execution schedule in crontab notation.

• ttlstring

  TTL of the ProjectBackupSchedule as time string.

• updatedAtstring (date-time)

Example

{
  "createdAt": "2024-11-21T11:15:00.770Z",
  "description": "I'm a ProjectBackupSchedule",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "isSystemBackup": true,
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "schedule": "5 4 * * *",
  "ttl": "7d",
  "updatedAt": "2024-11-21T11:15:00.771Z"
}

JSON Schema

{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "description": "Description of this ProjectBackupSchedule.",
      "example": "I'm a ProjectBackupSchedule",
      "type": "string"
    },
    "id": {
      "description": "ID of this ProjectBackupSchedule.",
      "format": "uuid",
      "type": "string"
    },
    "isSystemBackup": {
      "description": "True if this ProjectBackupSchedule was created and is managed by mittwald.",
      "type": "boolean"
    },
    "projectId": {
      "description": "ID of the Project this ProjectBackupSchedule belongs to.",
      "format": "uuid",
      "type": "string"
    },
    "schedule": {
      "description": "Execution schedule in crontab notation.",
      "example": "5 4 * * *",
      "type": "string"
    },
    "ttl": {
      "description": "TTL of the ProjectBackupSchedule as time string.",
      "example": "7d",
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "projectId",
    "schedule",
    "isSystemBackup"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"description":"string","schedule":"5 4 * * *","ttl":"7d"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/backup-schedules

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.createProjectBackupSchedule({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "description": "string",
    "schedule": "5 4 * * *",
    "ttl": "7d"
  }
});

assertStatus(response, 201);
  

PHP SDK

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

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

$request = (new CreateProjectBackupScheduleRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->backup()->createProjectBackupSchedule($request);

var_dump($response->getBody();