Skip to main content
GET
/
history
/
batch
/
cleanable-batch-report
Get Cleanable Batch Report
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/batch/cleanable-batch-report \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "batchType": "instance-modification",
    "historyTimeToLive": 5,
    "finishedBatchCount": 100,
    "cleanableBatchCount": 53
  },
  {
    "batchType": "instance-deletion",
    "historyTimeToLive": 5,
    "finishedBatchCount": 1000,
    "cleanableBatchCount": 13
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
finished
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

​
batchType
string | null

The type of the batch operation.

​
historyTimeToLive
integer<int32> | null

The history time to live of the batch operation.

​
finishedBatchesCount
integer<int64> | null

The count of the finished batch operations.

​
cleanableBatchesCount
integer<int64> | null

The count of the cleanable historic batch operations, referring to history time to live.