Getting the Pruning Config

Get the current pruning settings

Request

URI

GET

https://{opsmanager-installation}/api/v0/settings/pruning

COPY

Responses

200

Returns PruningConfig of type(s) application/json

{
    "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.

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"
        ]
    }
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/v0/settings/pruning

On This Page

Description

Request

Response

200 Response Body

Errors

Pruning Config Settings Operations