
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT settings/data/dataRetentionPeriods

Updates configuration of data retention periods.

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/settings/data/dataRetentionPeriods

## Request Payload Parameters

Attribute | Description
--- | ---
auditRetainDaily int | Network Audit Data Retain Period
deviceHealthRetainDaily int | Daily Device Health Data Retain Period
deviceHealthRetainHourly int | Hourly Device Health Data Retain Period
deviceHealthRetainWeekly int | Weekly Device Health Data Retain Period
performanceRetainLong int | Short Term Performance Data Retain Period
performanceRetainMedium int | Medium Term Performance Data Retain Period
performanceRetainShort int | Short Term Performance Data Retain Period
systemHealthRetainDaily int | Daily System Health Data Retain Period
systemHealthRetainHourly int | Hourly System Health Data Retain Period
systemHealthRetainWeekly int | Weekly System Health Data Retain Period
trendRetainDaily int | Daily Aggregated Trend Data Retain Period
trendRetainHourly int | Hourly Aggregated Trend Data Retain Period
trendRetainWeekly int | Weekly Aggregated Trend Data Retain Period

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://172.20.127.108/webacs/api/v1/op/settings/data/dataRetentionPeriods

    <?xml version="1.0" ?>
    <dataRetentionPeriodsDTO>
      <auditRetainDaily>1</auditRetainDaily>
      <deviceHealthRetainDaily>1</deviceHealthRetainDaily>
      <deviceHealthRetainHourly>1</deviceHealthRetainHourly>
      <deviceHealthRetainWeekly>1</deviceHealthRetainWeekly>
      <performanceRetainLong>1</performanceRetainLong>
      <performanceRetainMedium>1</performanceRetainMedium>
      <performanceRetainShort>1</performanceRetainShort>
      <systemHealthRetainDaily>1</systemHealthRetainDaily>
      <systemHealthRetainHourly>1</systemHealthRetainHourly>
      <systemHealthRetainWeekly>1</systemHealthRetainWeekly>
      <trendRetainDaily>1</trendRetainDaily>
      <trendRetainHourly>1</trendRetainHourly>
      <trendRetainWeekly>1</trendRetainWeekly>
    </dataRetentionPeriodsDTO>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v1/op/settings/data/dataRetentionPeriods.json

    {
      "dataRetentionPeriodsDTO" : {
        "auditRetainDaily" : 1,
        "deviceHealthRetainDaily" : 1,
        "deviceHealthRetainHourly" : 1,
        "deviceHealthRetainWeekly" : 1,
        "performanceRetainLong" : 1,
        "performanceRetainMedium" : 1,
        "performanceRetainShort" : 1,
        "systemHealthRetainDaily" : 1,
        "systemHealthRetainHourly" : 1,
        "systemHealthRetainWeekly" : 1,
        "trendRetainDaily" : 1,
        "trendRetainHourly" : 1,
        "trendRetainWeekly" : 1
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v2/op/settings/data/dataRetentionPeriods

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
auditRetainDaily int | Network Audit Data Retain Period
deviceHealthRetainDaily int | Daily Device Health Data Retain Period
deviceHealthRetainHourly int | Hourly Device Health Data Retain Period
deviceHealthRetainWeekly int | Weekly Device Health Data Retain Period
performanceRetainLong int | Short Term Performance Data Retain Period
performanceRetainMedium int | Medium Term Performance Data Retain Period
performanceRetainShort int | Short Term Performance Data Retain Period
systemHealthRetainDaily int | Daily System Health Data Retain Period
systemHealthRetainHourly int | Hourly System Health Data Retain Period
systemHealthRetainWeekly int | Weekly System Health Data Retain Period
trendRetainDaily int | Daily Aggregated Trend Data Retain Period
trendRetainHourly int | Hourly Aggregated Trend Data Retain Period
trendRetainWeekly int | Weekly Aggregated Trend Data Retain Period

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://172.20.127.108/webacs/api/v2/op/settings/data/dataRetentionPeriods

    <?xml version="1.0" ?>
    <dataRetentionPeriodsDTO>
      <auditRetainDaily>1</auditRetainDaily>
      <deviceHealthRetainDaily>1</deviceHealthRetainDaily>
      <deviceHealthRetainHourly>1</deviceHealthRetainHourly>
      <deviceHealthRetainWeekly>1</deviceHealthRetainWeekly>
      <performanceRetainLong>1</performanceRetainLong>
      <performanceRetainMedium>1</performanceRetainMedium>
      <performanceRetainShort>1</performanceRetainShort>
      <systemHealthRetainDaily>1</systemHealthRetainDaily>
      <systemHealthRetainHourly>1</systemHealthRetainHourly>
      <systemHealthRetainWeekly>1</systemHealthRetainWeekly>
      <trendRetainDaily>1</trendRetainDaily>
      <trendRetainHourly>1</trendRetainHourly>
      <trendRetainWeekly>1</trendRetainWeekly>
    </dataRetentionPeriodsDTO>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v2/op/settings/data/dataRetentionPeriods.json

    {
      "dataRetentionPeriodsDTO" : {
        "auditRetainDaily" : 1,
        "deviceHealthRetainDaily" : 1,
        "deviceHealthRetainHourly" : 1,
        "deviceHealthRetainWeekly" : 1,
        "performanceRetainLong" : 1,
        "performanceRetainMedium" : 1,
        "performanceRetainShort" : 1,
        "systemHealthRetainDaily" : 1,
        "systemHealthRetainHourly" : 1,
        "systemHealthRetainWeekly" : 1,
        "trendRetainDaily" : 1,
        "trendRetainHourly" : 1,
        "trendRetainWeekly" : 1
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v3/op/settings/data/dataRetentionPeriods

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
auditRetainDaily int | Network Audit Data Retain Period
deviceHealthRetainDaily int | Daily Device Health Data Retain Period
deviceHealthRetainHourly int | Hourly Device Health Data Retain Period
deviceHealthRetainWeekly int | Weekly Device Health Data Retain Period
performanceRetainLong int | Short Term Performance Data Retain Period
performanceRetainMedium int | Medium Term Performance Data Retain Period
performanceRetainShort int | Short Term Performance Data Retain Period
systemHealthRetainDaily int | Daily System Health Data Retain Period
systemHealthRetainHourly int | Hourly System Health Data Retain Period
systemHealthRetainWeekly int | Weekly System Health Data Retain Period
trendRetainDaily int | Daily Aggregated Trend Data Retain Period
trendRetainHourly int | Hourly Aggregated Trend Data Retain Period
trendRetainWeekly int | Weekly Aggregated Trend Data Retain Period

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://172.20.127.108/webacs/api/v3/op/settings/data/dataRetentionPeriods

    <?xml version="1.0" ?>
    <dataRetentionPeriodsDTO>
      <auditRetainDaily>1</auditRetainDaily>
      <deviceHealthRetainDaily>1</deviceHealthRetainDaily>
      <deviceHealthRetainHourly>1</deviceHealthRetainHourly>
      <deviceHealthRetainWeekly>1</deviceHealthRetainWeekly>
      <performanceRetainLong>1</performanceRetainLong>
      <performanceRetainMedium>1</performanceRetainMedium>
      <performanceRetainShort>1</performanceRetainShort>
      <systemHealthRetainDaily>1</systemHealthRetainDaily>
      <systemHealthRetainHourly>1</systemHealthRetainHourly>
      <systemHealthRetainWeekly>1</systemHealthRetainWeekly>
      <trendRetainDaily>1</trendRetainDaily>
      <trendRetainHourly>1</trendRetainHourly>
      <trendRetainWeekly>1</trendRetainWeekly>
    </dataRetentionPeriodsDTO>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v3/op/settings/data/dataRetentionPeriods.json

    {
      "dataRetentionPeriodsDTO" : {
        "auditRetainDaily" : 1,
        "deviceHealthRetainDaily" : 1,
        "deviceHealthRetainHourly" : 1,
        "deviceHealthRetainWeekly" : 1,
        "performanceRetainLong" : 1,
        "performanceRetainMedium" : 1,
        "performanceRetainShort" : 1,
        "systemHealthRetainDaily" : 1,
        "systemHealthRetainHourly" : 1,
        "systemHealthRetainWeekly" : 1,
        "trendRetainDaily" : 1,
        "trendRetainHourly" : 1,
        "trendRetainWeekly" : 1
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v4/op/settings/data/dataRetentionPeriods

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
auditRetainDaily int | Network Audit Data Retain Period
deviceHealthRetainDaily int | Daily Device Health Data Retain Period
deviceHealthRetainHourly int | Hourly Device Health Data Retain Period
deviceHealthRetainWeekly int | Weekly Device Health Data Retain Period
performanceRetainLong int | Short Term Performance Data Retain Period
performanceRetainMedium int | Medium Term Performance Data Retain Period
performanceRetainShort int | Short Term Performance Data Retain Period
systemHealthRetainDaily int | Daily System Health Data Retain Period
systemHealthRetainHourly int | Hourly System Health Data Retain Period
systemHealthRetainWeekly int | Weekly System Health Data Retain Period
trendRetainDaily int | Daily Aggregated Trend Data Retain Period
trendRetainHourly int | Hourly Aggregated Trend Data Retain Period
trendRetainWeekly int | Weekly Aggregated Trend Data Retain Period

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://172.20.127.108/webacs/api/v4/op/settings/data/dataRetentionPeriods

    <?xml version="1.0" ?>
    <dataRetentionPeriodsDTO>
      <auditRetainDaily>1</auditRetainDaily>
      <deviceHealthRetainDaily>1</deviceHealthRetainDaily>
      <deviceHealthRetainHourly>1</deviceHealthRetainHourly>
      <deviceHealthRetainWeekly>1</deviceHealthRetainWeekly>
      <performanceRetainLong>1</performanceRetainLong>
      <performanceRetainMedium>1</performanceRetainMedium>
      <performanceRetainShort>1</performanceRetainShort>
      <systemHealthRetainDaily>1</systemHealthRetainDaily>
      <systemHealthRetainHourly>1</systemHealthRetainHourly>
      <systemHealthRetainWeekly>1</systemHealthRetainWeekly>
      <trendRetainDaily>1</trendRetainDaily>
      <trendRetainHourly>1</trendRetainHourly>
      <trendRetainWeekly>1</trendRetainWeekly>
    </dataRetentionPeriodsDTO>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v4/op/settings/data/dataRetentionPeriods.json

    {
      "dataRetentionPeriodsDTO" : {
        "auditRetainDaily" : 1,
        "deviceHealthRetainDaily" : 1,
        "deviceHealthRetainHourly" : 1,
        "deviceHealthRetainWeekly" : 1,
        "performanceRetainLong" : 1,
        "performanceRetainMedium" : 1,
        "performanceRetainShort" : 1,
        "systemHealthRetainDaily" : 1,
        "systemHealthRetainHourly" : 1,
        "systemHealthRetainWeekly" : 1,
        "trendRetainDaily" : 1,
        "trendRetainHourly" : 1,
        "trendRetainWeekly" : 1
      }
    }