File tree Expand file tree Collapse file tree 1 file changed +63
-0
lines changed
content/vault/v1.21.x (rc)/content/api-docs/system Expand file tree Collapse file tree 1 file changed +63
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ layout : api
3+ page_title : /sys/billing/certificates - HTTP API
4+ description : >-
5+ Use the `/sys/billing/certificates` endpoint to fetch data about the number of PKI certificates issued by Vault.
6+ ---
7+
8+ ` # /sys/billing/certificates `
9+
10+ Use the ` /sys/billing/certificates ` endpoint to fetch data about the
11+ number of PKI certificates issued by Vault. for a cluster.
12+
13+ ## PKI Certificate Counts
14+
15+ The Certificate Counts endpoint returns the number of PKI certificates issued by Vault, or an error, for each month of the given time range.
16+ By default, the endpoint returns data for the current billing period.
17+
18+ | Method | Path |
19+ | :----- | :-------------------------- |
20+ | ` GET ` | ` /sys/billing/certificates ` |
21+
22+ ### Request parameters
23+
24+ - ` start_time ` ` (string: "") ` - The year and month indicating the first month of the
25+ query range in format ` YYYY-MM ` . The ` start_time ` is required if an ` end_time ` is provided.
26+
27+
28+ - ` end_time ` ` (string: "") ` - The year and month indicating the last month of the
29+ query range in format ` YYYY-MM ` . The ` end_time ` is required if a ` start_time `
30+ is provided.
31+
32+ ### Sample payload
33+
34+ ``` json
35+ {
36+ "start_time" : " 2025-01-01T00:00:00Z" ,
37+ "end_time" : " 2025-01-01T00:00:00Z"
38+ }
39+ ```
40+
41+ ### Sample request
42+
43+ ``` shell-session
44+ $ curl \
45+ --header "X-Vault-Token: ..." \
46+ --data @payload.json \
47+ http://127.0.0.1:8200/v1/sys/billing/certificates
48+ ```
49+
50+ ### Sample response
51+
52+ ``` json
53+ {
54+ "months" : [
55+ {
56+ "timestamp" : " 2025-01-01T00:00:00Z" ,
57+ "counts" : {
58+ "issued_certificates" : 123
59+ }
60+ }
61+ ]
62+ }
63+ ```
You can’t perform that action at this time.
0 commit comments