InstanceRetentionPolicyRead

Fields

GET/PUT /api/v1/settings/retention-defaults. A NULL value = the code default.

13 fields

artifacts_days

integer or null

audit_days

integer or null

code_defaults · required

object

effective · required

object

enabled · required

boolean

enabled_at

string (date-time) or null

enabled_by_name

string or null

inheriting_projects · required

object

keep_last_runs

integer or null

purge_window_start_utc

integer or null

raw_events_days

integer or null

runs_days

integer or null

updated_at

string (date-time) or null

Raw schema (JSON)

{
  "description": "GET/PUT ``/api/v1/settings/retention-defaults``. A NULL value = the code default.",
  "properties": {
    "artifacts_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Artifacts Days"
    },
    "audit_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Audit Days"
    },
    "code_defaults": {
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "integer"
          }
        ]
      },
      "title": "Code Defaults",
      "type": "object"
    },
    "effective": {
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "integer"
          }
        ]
      },
      "title": "Effective",
      "type": "object"
    },
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "enabled_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Enabled At"
    },
    "enabled_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Enabled By Name"
    },
    "inheriting_projects": {
      "additionalProperties": {
        "type": "integer"
      },
      "title": "Inheriting Projects",
      "type": "object"
    },
    "keep_last_runs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Keep Last Runs"
    },
    "purge_window_start_utc": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Purge Window Start Utc"
    },
    "raw_events_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Raw Events Days"
    },
    "runs_days": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs Days"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "enabled",
    "code_defaults",
    "effective",
    "inheriting_projects"
  ],
  "title": "InstanceRetentionPolicyRead",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/settings/retention-defaults — Get Retention Defaults
• PUT /api/v1/settings/retention-defaults — Update Retention Defaults
• POST /api/v1/settings/retention-defaults/enable — Enable Retention Defaults

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON