Skip to content

AnalyticsHostDto

Endpoints · All schemas

The library volume, always the whole host whatever is selected

FieldRequiredDescription
breakdownNoSee definition below
capacityBytesYesBytes
freeBytesYesBytes
observedAtYesstring
stateYesSee definition below
volumeUsedBytesYesBytes

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AnalyticsVolumeBreakdownDto, AnalyticsState

{
  "description": "The library volume, always the whole host whatever is selected",
  "properties": {
    "breakdown": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnalyticsVolumeBreakdownDto"
        }
      ],
      "nullable": true
    },
    "capacityBytes": {
      "description": "Bytes",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "freeBytes": {
      "description": "Bytes",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "observedAt": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "state": {
      "$ref": "#/components/schemas/AnalyticsState"
    },
    "volumeUsedBytes": {
      "description": "Bytes",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "capacityBytes",
    "freeBytes",
    "observedAt",
    "state",
    "volumeUsedBytes"
  ],
  "type": "object"
}