RetentionPurgeRequest

Fields

POST .../retention-policy/purge — typed-name confirmation (project_reset convention): must equal the project name exactly.

1 field

confirmation_name · required

string

Raw schema (JSON)

{
  "description": "POST ``.../retention-policy/purge`` — typed-name confirmation\n(``project_reset`` convention): must equal the project name exactly.",
  "properties": {
    "confirmation_name": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Confirmation Name",
      "type": "string"
    }
  },
  "required": [
    "confirmation_name"
  ],
  "title": "RetentionPurgeRequest",
  "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/purge — Enqueue Retention Purge

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON