RetireCompliancePackRequest

Fields

Bring a pack's retention window forward to now.

2 fields

confirmation_id · required

string

Must equal the pack id exactly.

reason · required

string

Raw schema (JSON)

{
  "description": "Bring a pack's retention window forward to now.\n\nTyped confirmation rather than a checkbox: a pack is audit evidence, and\nretiring it early hands it to the next nightly purge.",
  "properties": {
    "confirmation_id": {
      "description": "Must equal the pack id exactly.",
      "maxLength": 64,
      "minLength": 1,
      "title": "Confirmation Id",
      "type": "string"
    },
    "reason": {
      "maxLength": 500,
      "minLength": 3,
      "title": "Reason",
      "type": "string"
    }
  },
  "required": [
    "confirmation_id",
    "reason"
  ],
  "title": "RetireCompliancePackRequest",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/compliance-packs/{pack_id}/retire — Retire Compliance Pack

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON