Clarify origin of ID parameter for path filter creation (hashicorp#20415

) * Clarify origin of ID parameter for path filter creation * add additional note * add additional info
fopina · May 1, 2023 · cf2f527 · cf2f527
1 parent 89e5808
commit cf2f527
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/website/content/api-docs/system/replication/replication-performance.mdx b/website/content/api-docs/system/replication/replication-performance.mdx
@@ -266,7 +266,12 @@ selected secondary. In deny mode, the mount and namespace paths are excluded.
 
 ### Parameters
 
-- `id` `(string: <required>)` – Specifies the unique performance secondary identifier.
+- `id` `(string: <required>)` – Specifies the unique performance secondary identifier. Note that this identifier is
+  not arbitrary. This should be the secondary cluster ID as reported by the `cluster_id` field of the [replication status](/vault/api-docs/system/replication#check-status) API
+  endpoint. If, for example, a new performance secondary token
+  [is created](/vault/api-docs/system/replication/replication-performance#generate-performance-secondary-token), and used to call
+  [update-primary](/vault/api-docs/system/replication/replication-performance#update-performance-secondary-s-primary), then path filters will need
+  to be re-created via this API endpoint.
 
 - `mode` `(string: "allow")` – Specifies the filtering mode. Available values
   are "allow" and "deny".
@@ -297,7 +302,7 @@ $ curl \
 This endpoint is used to read the mode and the mount/namespace paths that are filtered
 for a secondary.
 
-| Method | Path                                                    |
+| Method | Path                                                    | |
 | :----- | :------------------------------------------------------ | ------------------ |
 | `GET`  | `/sys/replication/performance/primary/paths-filter/:id` | `200 (empty body)` |
 
@@ -348,7 +353,7 @@ $ curl \
 This endpoint is used to read the namespace and the mount paths that are dynamically
 filtered for a secondary on the primary.
 
-| Method | Path                                                      |
+| Method | Path                                                      | |
 | :----- | :-------------------------------------------------------- | ------------------ |
 | `GET`  | `/sys/replication/performance/primary/dynamic-filter/:id` | `200 (empty body)` |
 
@@ -378,7 +383,7 @@ $ curl \
 This endpoint is used to read the namespace and the mount paths that are dynamically
 filtered for a secondary on the secondary.
 
-| Method | Path                                                        |
+| Method | Path                                                        | |
 | :----- | :---------------------------------------------------------- | ------------------ |
 | `GET`  | `/sys/replication/performance/secondary/dynamic-filter/:id` | `200 (empty body)` |