Version: API v1

getAccountStatistics

GET/v1/accounts/{accountIdentifier}/stats

API version

Request method

GET

Operation ID

getAccountStatistics

Liefert Statistiken zur Speicherplatzauslastung eines Projekts

Request

accountIdentifierstring
required
Name oder ID eines Accounts

Responses

Format

application/json

Description

Objekt der Speicherplatzauslastung eines Projekts

accountsarray of object
required
- Array[
  - *object
    - detailsobject
      required
      - backupsobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - dbspaceobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - mailobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - snapshotobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - systemobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - templateobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
      - webspaceobject
        required
        itemsarray of object
        required
        Array[
        *object
        itemNamestring
        required
        itemSizenumber (integer)
        required
        Speicherplatzverbrauch in KiB
        itemUpdatedAtnumber (integer)
        required
        Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.
        ]
        summarynumber (integer)
        required
        Gesamt-Speicherplatzverbrauch, in KiB
    - limitnumber (integer)
      required
      Speicherplatzbeschränkung des Projekts
    - namestring
      required
      Name des Projekts
    - percentnumber
      required
      Relative/prozentuale Auslastung (0-100) des Projekt-Speicherplatzes
    - summarynumber (integer)
      required
      Absolute Speicherplatzverbrauch des Projekts, in KiB
  ]
metaobject
- limitnumber (integer)
  required
  Speicherplatzbeschränkung der relevanten Projekte
- percentnumber
  required
  Relative/prozentuale Auslastung (0-100) des Projekt-Speicherplatzes
- summarynumber (integer)
  required
  Absolute Speicherplatzverbrauch der Projekte, in KiB

Content-Type: application/json

{
  "accounts": [
    {
      "details": {
        "backups": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "dbspace": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "mail": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "snapshot": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "system": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "template": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        },
        "webspace": {
          "items": [
            {
              "itemName": "string",
              "itemSize": 123,
              "itemUpdatedAt": 123
            }
          ],
          "summary": 123
        }
      },
      "limit": 123,
      "name": "string",
      "percent": 123,
      "summary": 123
    }
  ],
  "meta": {
    "limit": 123,
    "percent": 123,
    "summary": 123
  }
}

{
  "title": "StorageStatistics",
  "required": [
    "accounts"
  ],
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array",
      "items": {
        "required": [
          "details",
          "limit",
          "name",
          "percent",
          "summary"
        ],
        "type": "object",
        "properties": {
          "details": {
            "required": [
              "backups",
              "dbspace",
              "mail",
              "snapshot",
              "system",
              "template",
              "webspace"
            ],
            "type": "object",
            "properties": {
              "backups": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "dbspace": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "mail": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "snapshot": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "system": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "template": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              },
              "webspace": {
                "title": "StorageStatisticsItemList",
                "required": [
                  "items",
                  "summary"
                ],
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "title": "StorageStatisticsItem",
                      "required": [
                        "itemName",
                        "itemSize",
                        "itemUpdatedAt"
                      ],
                      "type": "object",
                      "properties": {
                        "itemName": {
                          "type": "string"
                        },
                        "itemSize": {
                          "type": "number",
                          "description": "Speicherplatzverbrauch in KiB\n",
                          "format": "integer"
                        },
                        "itemUpdatedAt": {
                          "type": "number",
                          "description": "Letzter Änderungszeitpunkt, als UNIX-Zeitstempel in Sekunden.\n",
                          "format": "integer"
                        }
                      }
                    }
                  },
                  "summary": {
                    "type": "number",
                    "description": "Gesamt-Speicherplatzverbrauch, in KiB",
                    "format": "integer"
                  }
                }
              }
            }
          },
          "limit": {
            "type": "number",
            "description": "Speicherplatzbeschränkung des Projekts",
            "format": "integer"
          },
          "name": {
            "type": "string",
            "description": "Name des Projekts"
          },
          "percent": {
            "type": "number",
            "description": "Relative/prozentuale Auslastung (0-100) des Projekt-Speicherplatzes"
          },
          "summary": {
            "type": "number",
            "description": "Absolute Speicherplatzverbrauch des Projekts, in KiB",
            "format": "integer"
          }
        }
      }
    },
    "meta": {
      "required": [
        "limit",
        "percent",
        "summary"
      ],
      "type": "object",
      "properties": {
        "limit": {
          "type": "number",
          "description": "Speicherplatzbeschränkung der relevanten Projekte",
          "format": "integer"
        },
        "percent": {
          "type": "number",
          "description": "Relative/prozentuale Auslastung (0-100) des Projekt-Speicherplatzes"
        },
        "summary": {
          "type": "number",
          "description": "Absolute Speicherplatzverbrauch der Projekte, in KiB",
          "format": "integer"
        }
      }
    }
  }
}

Usage examples

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/stats

getAccountStatistics

Request​

Path parametersrequired

Responses​

OK200

Usage examples​

On this page

Request

Responses

Usage examples