RetentionPreviewHold

Fields

8 fields

entity_id

string (uuid) or null

entity_label

string or null

entity_type · required

string

expires_at

string (date-time) or null

hold_id · required

string (uuid)

packs_kept

integer

reason · required

string

runs_kept

integer

Raw schema (JSON)

{
  "properties": {
    "entity_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Entity Id"
    },
    "entity_label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Entity Label"
    },
    "entity_type": {
      "title": "Entity Type",
      "type": "string"
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "hold_id": {
      "format": "uuid",
      "title": "Hold Id",
      "type": "string"
    },
    "packs_kept": {
      "default": 0,
      "title": "Packs Kept",
      "type": "integer"
    },
    "reason": {
      "title": "Reason",
      "type": "string"
    },
    "runs_kept": {
      "default": 0,
      "title": "Runs Kept",
      "type": "integer"
    }
  },
  "required": [
    "hold_id",
    "entity_type",
    "reason"
  ],
  "title": "RetentionPreviewHold",
  "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

• RetentionPreviewHolds

More details

• Specification: OpenAPI JSON