Skip to content

Commit

Permalink
documentation changes for limit parameter (#16161)
Browse files Browse the repository at this point in the history
  • Loading branch information
akshya96 committed Jun 27, 2022
1 parent 7b88753 commit d0e35da
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions website/content/api-docs/system/internal-counters.mdx
Expand Up @@ -281,6 +281,10 @@ This endpoint was added in Vault 1.6.
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period
for which client counts will be reported. If no end time is specified, the end of the previous calendar
month will be used.
- `limit_namespaces` `(int, optional)` - Controls the total number of by_namespace data returned. This can
be used to return the client counts for the specified number of namespaces having highest activity.
If no `limit_namespaces` parameter is specified, client counts for all namespaces in specified usage period is returned.


### Sample Request

Expand Down Expand Up @@ -639,6 +643,15 @@ $ curl \
http://127.0.0.1:8200/v1/sys/internal/counters/activity?end_time=2020-06-30T00%3A00%3A00Z&start_time=2020-06-01T00%3A00%3A00Z
```

### Sample request to get client counts for top 2 namespaces with highest activity for a usage period

```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request GET \
http://127.0.0.1:8200/v1/sys/internal/counters/activity?end_time=2020-06-30T00%3A00%3A00Z&start_time=2020-06-01T00%3A00%3A00Z&limit_namespaces=2
```

## Partial Month Client Count

This endpoint returns the client activity in the current month. The response
Expand Down

0 comments on commit d0e35da

Please sign in to comment.