---
updatedAt: 2026-03-31T06:02:41.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/artifactory/llms.txt
---

# Get the Configured Retention Policies List

Finds the bundles that are candidates for retention according to the configuration type.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "JFrog Artifactory Retention (Release Bundle v1) API",
    "description": "REST API for managing retention policies for Release Bundle v1 versions in JFrog Artifactory. The Retention feature is disabled by default and must be enabled by the customer. Retention policies are designed to work with Postgres and Derby databases. Other databases are not officially supported.",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}/artifactory/api/v1/bundle/retention",
      "description": "JFrog Platform",
      "variables": {
        "jfrog_url": {
          "default": "myserver.jfrog.io",
          "description": "Your JFrog Platform hostname (e.g., mycompany.jfrog.io)"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Retention",
      "description": "Release Bundle v1 retention policy management operations"
    }
  ],
  "paths": {
    "/report": {
      "post": {
        "tags": [
          "Retention"
        ],
        "summary": "Get the Configured Retention Policies List",
        "description": "Finds the bundles that are candidates for retention according to the configuration type.",
        "operationId": "getConfiguredRetentionPoliciesList",
        "parameters": [
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            },
            "description": "Offset in set of all fitting bundle versions (fitting by retention config). Default is 0."
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 100
            },
            "description": "Maximum amount of items to return. Default is 100."
          },
          {
            "name": "order_by",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "bundle_name",
                "bundle_version",
                "distribution_time",
                "keep"
              ],
              "default": "distribution_time"
            },
            "description": "Order by field. Default is \"distribution_time\"."
          },
          {
            "name": "direction",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "asc"
            },
            "description": "Sort direction. Default is \"asc\"."
          },
          {
            "name": "pattern",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "*"
            },
            "description": "Case insensitive name/version pattern, where \"*\" is allowed as the wild card. Default is \"*\"."
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type"
                ],
                "properties": {
                  "include_keep": {
                    "type": "boolean",
                    "description": "Include bundles marked as keep"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "MAX_VERSIONS_PER_RELEASE_BUNDLE",
                      "MAX_DAYS_TO_KEEP"
                    ],
                    "description": "The retention policy type"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "integer"
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "bundle_name": {
                            "type": "string"
                          },
                          "bundle_version": {
                            "type": "string"
                          },
                          "creation_time": {
                            "type": "integer"
                          },
                          "distribution_time": {
                            "type": "integer"
                          },
                          "keep": {
                            "type": "boolean"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Bad Credentials - The provided authentication is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Permission Denied - The user does not have the necessary permissions to perform this action.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "405": {
            "description": "Method Not Allowed - This endpoint is not available on this Artifactory instance configuration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    },
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "description": "Standard JFrog error envelope",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "integer"
                },
                "message": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-JFrog-Art-Api"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```