#8059 Improve Clarity on TTL docs (#8141)

pull/8150/head
Dexter Lowe 5 years ago committed by GitHub
parent af11169c26
commit 6e208a2120
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -57,13 +57,13 @@ The table below shows this endpoint's support for
- `release` - causes any locks that are held to be released
- `delete` - causes any locks that are held to be deleted
- `TTL` `(string: "")` - Specifies the number of seconds (between 10s and
- `TTL` `(string: "")` - Specifies the duration of a session (between 10s and
86400s). If provided, the session is invalidated if it is not renewed before
the TTL expires. The lowest practical TTL should be used to keep the number of
managed sessions low. When locks are forcibly expired, such as when following
the [leader election pattern](https://learn.hashicorp.com/consul/developer-configuration/elections) in an application,
sessions may not be reaped for up to double this TTL, so long TTL
values (> 1 hour) should be avoided.
values (> 1 hour) should be avoided. Valid time units include "s", "m" and "h".
### Sample Payload

Loading…
Cancel
Save