RetentionPreviewHolds

Fields

4 fields

active

array of RetentionPreviewHold

packs_kept

integer

project_held

boolean

runs_kept

integer

Raw schema (JSON)

{
  "properties": {
    "active": {
      "items": {
        "$ref": "#/components/schemas/RetentionPreviewHold"
      },
      "title": "Active",
      "type": "array"
    },
    "packs_kept": {
      "default": 0,
      "title": "Packs Kept",
      "type": "integer"
    },
    "project_held": {
      "default": false,
      "title": "Project Held",
      "type": "boolean"
    },
    "runs_kept": {
      "default": 0,
      "title": "Runs Kept",
      "type": "integer"
    }
  },
  "title": "RetentionPreviewHolds",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/retention-policy/preview — Preview Retention Purge

Used by schemas

• RetentionPreviewResponse

More details

• Specification: OpenAPI JSON