InstanceEnablePreviewResponse

Fields

6 fields

already_enabled · required

boolean

confirmation_phrase · required

string

items

array of InstanceEnablePreviewItem

preview_hash · required

string

total · required

integer

truncated · required

boolean

Raw schema (JSON)

{
  "properties": {
    "already_enabled": {
      "title": "Already Enabled",
      "type": "boolean"
    },
    "confirmation_phrase": {
      "title": "Confirmation Phrase",
      "type": "string"
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/InstanceEnablePreviewItem"
      },
      "title": "Items",
      "type": "array"
    },
    "preview_hash": {
      "title": "Preview Hash",
      "type": "string"
    },
    "total": {
      "title": "Total",
      "type": "integer"
    },
    "truncated": {
      "title": "Truncated",
      "type": "boolean"
    }
  },
  "required": [
    "total",
    "truncated",
    "preview_hash",
    "confirmation_phrase",
    "already_enabled"
  ],
  "title": "InstanceEnablePreviewResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/settings/retention-defaults/enable-preview — Preview Retention Defaults Enable

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON