Setting the Pruning Config
Setting the Pruning Config
Set the Pruning Config values
Request
URI
PUT
https://{opsmanager-installation}/api/v0/settings/pruning
COPY
Request Body
PruningConfig
of type(s)
application/json
Optional
{
"enabled": false,
"days_to_keep": 0
}
boolean
enabled
Optional
This determines whether or not pruning will occur.
integer
days_to_keep
Optional
Constraints:
default: 365
This is the number of days to retain installation records for; records older than this number of days will be removed.
Responses
200
OK
Returns
EmptyResponse
of type(s)
application/json
Operation doesn't return any data structure
400
Setup is not completed
Returns
RequireSetupCompleted
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
401
Unauthorized
Returns
UnauthorizedResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
403
Forbidden
Returns
ForbiddenResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
422
Unprocessable Content
Returns
NestedErrorsResponseVariant
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
object
errors
Optional
errors
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v0/settings/pruning