DeletionJobResponse

Fields

One deletion that ran (or is running).

22 fields

acknowledged_at: string (date-time) or null
bytes_reclaimed: integer or null
collect_expires_at: string (date-time) or null
collected_at: string (date-time) or null
counts: object or null
criteria: object or null
error: string or null
export_bytes: integer or null
export_manifest_sha256: string or null
export_summary: object or null
export_target: string or null
export_tier: string or null
export_verified_at: string (date-time) or null
finished_at: string (date-time) or null
holds_honoured: object or null
id · required: string (uuid)
job_kind · required: string
project_id · required: string (uuid)
references_broken: object or null
requested_at · required: string (date-time)
started_at: string (date-time) or null
status · required: string

Raw schema (JSON)

{
  "description": "One deletion that ran (or is running).\n\n`bytes_reclaimed` is nullable and is NOT defaulted to 0 — \"reclaimed\nnothing\" and \"nobody measured\" are opposite findings, and this is the\nsurface that tells an operator whether a purge was worth running.",
  "properties": {
    "acknowledged_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Acknowledged At"
    },
    "bytes_reclaimed": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bytes Reclaimed"
    },
    "collect_expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Collect Expires At"
    },
    "collected_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Collected At"
    },
    "counts": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Counts"
    },
    "criteria": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Criteria"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error"
    },
    "export_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Bytes"
    },
    "export_manifest_sha256": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Manifest Sha256"
    },
    "export_summary": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Summary"
    },
    "export_target": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Target"
    },
    "export_tier": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Tier"
    },
    "export_verified_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Export Verified At"
    },
    "finished_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "holds_honoured": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Holds Honoured"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "job_kind": {
      "title": "Job Kind",
      "type": "string"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "references_broken": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "References Broken"
    },
    "requested_at": {
      "format": "date-time",
      "title": "Requested At",
      "type": "string"
    },
    "started_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "job_kind",
    "status",
    "requested_at"
  ],
  "title": "DeletionJobResponse",
  "type": "object"
}

Used by endpoints

3 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/projects/{project_id}/deletion/jobs/{job_id} — Get Deletion Job
POST /api/v1/projects/{project_id}/deletion/jobs/{job_id}/acknowledge — Acknowledge Deletion Archive
GET /api/v1/projects/{project_id}/deletion/jobs — List Deletion Jobs

Used by schemas

DeletionJobListResponse

More details

Specification: OpenAPI JSON