Skip to content

Commit 6802640

Browse files
Update behavior for the ssh config/ca endpoint when a CA exists (#684)
The docs mentioned that the values would be overwritten on the SSH config/ca endpoint 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.
2 parents 315f7d2 + 309f075 commit 6802640

File tree

5 files changed

+16
-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

+16
-10
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -558,8 +558,10 @@ $ 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. If you call submit CA with an existing certificate or key, the
562+
endpoint returns an error. To update existing values, call the delete CA
563+
information endpoint before calling the submit endpoint.
564+
563565

564566
| Method | Path |
565567
| :----- | :--------------- | -------------------------- |

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,9 @@ $ 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. If you call submit CA with an existing certificate or key, the
566+
endpoint returns an error. To update existing values, call the delete CA
567+
information endpoint before calling the submit endpoint.
567568

568569
| Method | Path |
569570
| :----- | :--------------- | -------------------------- |

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,9 @@ $ 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. If you call submit CA with an existing certificate or key, the
566+
endpoint returns an error. To update existing values, call the delete CA
567+
information endpoint before calling the submit endpoint.
567568

568569
| Method | Path |
569570
| :----- | :--------------- | -------------------------- |

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -559,8 +559,9 @@ $ 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. If you call submit CA with an existing certificate or key, the
563+
endpoint returns an error. To update existing values, call the delete CA
564+
information endpoint before calling the submit endpoint.
564565

565566
| Method | Path |
566567
| :----- | :--------------- | -------------------------- |

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -559,8 +559,9 @@ $ 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. If you call submit CA with an existing certificate or key, the
563+
endpoint returns an error. To update existing values, call the delete CA
564+
information endpoint before calling the submit endpoint.
564565

565566
| Method | Path |
566567
| :----- | :--------------- | -------------------------- |

0 commit comments

Comments
 (0)