v1

latestSwagger 2.02026-07-178567199.3 KB
retention policies

Alter retention policy for a database

patch/sources/{id}/dbs/{db}/rps/{rp}

Path parameters

idstring required

ID of the data source

dbstring required

Name of the database

rpstring required

Name of the retention policy

Request body

namestring required

The identifying name of the retention policy

durationstring required

the duration of the retention policy

replicationinteger required

how many copies of the data are stored in the cluster

shardDurationstring

the interval spanned by each shard group

defaultboolean

Indicates whether this retention policy should be the default

Example request

{
  "name": "weekly",
  "duration": "7d",
  "replication": 1,
  "shardDuration": "7d",
  "default": true,
  "links": {
    "self": "/chronograf/v1/sources/1/dbs/NOAA_water_database/rps/liquid"
  }
}

Response

Retention Policy was altered

namestring required

The identifying name of the retention policy

durationstring required

the duration of the retention policy

replicationinteger required

how many copies of the data are stored in the cluster

shardDurationstring

the interval spanned by each shard group

defaultboolean

Indicates whether this retention policy should be the default

Example response

{
  "name": "weekly",
  "duration": "7d",
  "replication": 1,
  "shardDuration": "7d",
  "default": true,
  "links": {
    "self": "/chronograf/v1/sources/1/dbs/NOAA_water_database/rps/liquid"
  }
}