List backups belonging to a mail address

GET/mail-addresses/{mailAddressId}/backups/

API version

v2

Request method

GET

Operation ID

mail-list-backups-for-mail-address

---

Request

• mailAddressIdstring (uuid)

  required

  ID of the MailAddress to retrieve backups for.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • namestring

    required
]

Example

Content-Type: application/json

[
  {
    "name": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "name": {
        "type": "string"
      }
    },
    "required": [
      "name"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

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

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

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Mail\ListBackupsForMailAddress\ListBackupsForMailAddressRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListBackupsForMailAddressRequest(
  mailAddressId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->mail()->listBackupsForMailAddress($request);

var_dump($response->getBody();