Sign in

v1

latestSwagger 2.02026-07-178567199.3 KB
retention policies

Create new retention policy for a database

post/sources/{id}/dbs/{db}/rps

Path parameters

idstring required

ID of the data source

dbstring required

Name of the database

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 successfully created.

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