POST /retentionpolicy

POST /retentionpolicy

/retentionpolicy

Request
URI
POST
https://{api_host}/api/retentionpolicy
COPY
Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

RetentionPolicy object creation

RetentionPolicy of type(s) application/json
Optional

Show optional properties

{
    "policy": {}
}
{
    "_last_modified": "string",
    "enabled": false,
    "history": [
        {
            "duration": 0,
            "end_time": "string",
            "messages": [
                "string"
            ],
            "start_time": "string",
            "status": "string"
        }
    ],
    "name": "string",
    "policy": {
        "disk": {
            "action": {
                "args": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ],
                "path": "string",
                "type": "string"
            },
            "filepath": "string",
            "max_disk_percent": 0,
            "min_free_disk_percent": 0,
            "retain": 0
        },
        "object": {
            "action": {
                "args": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ],
                "path": "string",
                "type": "string"
            },
            "limit": 0,
            "model_name": "string"
        },
        "periodic": {
            "action": {
                "args": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ],
                "path": "string",
                "type": "string"
            },
            "interval": 0
        }
    },
    "summary": {
        "duration": 0,
        "end_time": "string",
        "messages": [
            "string"
        ],
        "start_time": "string",
        "status": "string"
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RetentionPolicy of type(s) application/json 
"RetentionPolicy Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

boolean
enabled
Optional
Constraints: default: true

Enables the policy. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of object
history
Optional

History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Optional

Name of the policy. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
policy
Required

policy

object
summary
Optional

summary

string
tenant_ref
Optional

Tenant UUID associated with the Object. It is a reference to an object of type Tenant. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID Identifier for the policy. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"policy:"object"}' https://{api_host}/api/retentionpolicy
On This Page
Retention Policy Operations
GET
GET /retentionpolicy
POST
POST /retentionpolicy
GET
GET /retentionpolicy/{uuid}
PUT
PUT /retentionpolicy/{uuid}
PATCH
PATCH /retentionpolicy/{uuid}
DELETE
DELETE /retentionpolicy/{uuid}