List Mail RateLimits

GET/v2/mail-rate-limits/

API version

v2

Request method

GET

Operation ID

mail-list-mail-rate-limits

---

Request

No request parameters.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
  • *object
    • idstring (uuid)

      required
    • rateLimitinteger

      required
  ]

Example

Content-Type: application/json

[
  {
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "rateLimit": 123
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "rateLimit": {
        "type": "integer"
      }
    },
    "required": [
      "id",
      "rateLimit"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/mail-rate-limits

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.listMailRateLimits({});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListMailRateLimitsRequest());
$response = $client->mail()->listMailRateLimits($request);

var_dump($response->getBody();