Skip to content

Commit 83471df

Browse files
committed
Update behavior for the ssh config/ca endpoint when a CA exists
- The docs mentioned that the values would be overwritten but we actually error out to the end user, telling them they must delete before the update will take place. Update our docs to match the code.
1 parent 1b08de5 commit 83471df

File tree

5 files changed

+30
-10
lines changed
  • content/vault
    • v1.16.x/content/api-docs/secret
    • v1.17.x/content/api-docs/secret
    • v1.18.x/content/api-docs/secret
    • v1.19.x/content/api-docs/secret
    • v1.20.x/content/api-docs/secret

5 files changed

+30
-10
lines changed

content/vault/v1.16.x/content/api-docs/secret/ssh.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -558,8 +558,12 @@ $ curl \
558558
## Submit CA information
559559

560560
This endpoint allows submitting the CA information for the secrets engine via an SSH
561-
key pair. _If you have already set a certificate and key, they will be
562-
overridden._
561+
key pair.
562+
563+
<Note>
564+
If a certificate or key are present, an error will be returned. To update the existing
565+
values, the Delete CA information API will need to be called first.
566+
</Note>
563567

564568
| Method | Path |
565569
| :----- | :--------------- | -------------------------- |

content/vault/v1.17.x/content/api-docs/secret/ssh.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,12 @@ $ curl \
562562
## Submit CA information
563563

564564
This endpoint allows submitting the CA information for the secrets engine via an SSH
565-
key pair. _If you have already set a certificate and key, they will be
566-
overridden._
565+
key pair.
566+
567+
<Note>
568+
If a certificate or key are present, an error will be returned. To update the existing
569+
values, the Delete CA information API will need to be called first.
570+
</Note>
567571

568572
| Method | Path |
569573
| :----- | :--------------- | -------------------------- |

content/vault/v1.18.x/content/api-docs/secret/ssh.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,12 @@ $ curl \
562562
## Submit CA information
563563

564564
This endpoint allows submitting the CA information for the secrets engine via an SSH
565-
key pair. _If you have already set a certificate and key, they will be
566-
overridden._
565+
key pair.
566+
567+
<Note>
568+
If a certificate or key are present, an error will be returned. To update the existing
569+
values, the Delete CA information API will need to be called first.
570+
</Note>
567571

568572
| Method | Path |
569573
| :----- | :--------------- | -------------------------- |

content/vault/v1.19.x/content/api-docs/secret/ssh.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -559,8 +559,12 @@ $ curl \
559559
## Submit CA information
560560

561561
This endpoint allows submitting the CA information for the secrets engine via an SSH
562-
key pair. _If you have already set a certificate and key, they will be
563-
overridden._
562+
key pair.
563+
564+
<Note>
565+
If a certificate or key are present, an error will be returned. To update the existing
566+
values, the Delete CA information API will need to be called first.
567+
</Note>
564568

565569
| Method | Path |
566570
| :----- | :--------------- | -------------------------- |

content/vault/v1.20.x/content/api-docs/secret/ssh.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -559,8 +559,12 @@ $ curl \
559559
## Submit CA information
560560

561561
This endpoint allows submitting the CA information for the secrets engine via an SSH
562-
key pair. _If you have already set a certificate and key, they will be
563-
overridden._
562+
key pair.
563+
564+
<Note>
565+
If a certificate or key are present, an error will be returned. To update the existing
566+
values, the Delete CA information API will need to be called first.
567+
</Note>
564568

565569
| Method | Path |
566570
| :----- | :--------------- | -------------------------- |

0 commit comments

Comments
 (0)