Rotate an active or disabled secret, replacing its value and incrementing its value version.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/secrets/example/rotate"), Content = new StringContent("{ \"Value\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/secrets/example/rotate';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Value":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/secrets/example/rotate \ --header 'Content-Type: application/json' \ --data '{ "Value": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Replace a managed-secret value and increment its value version.
object
Replacement value, limited to 64 KiB in UTF-8. It is stored without transformation and never returned.
Expected concurrency token.
Examplegenerated
{ "Value": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Replace a managed-secret value and increment its value version.
object
Replacement value, limited to 64 KiB in UTF-8. It is stored without transformation and never returned.
Expected concurrency token.
Examplegenerated
{ "Value": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Replace a managed-secret value and increment its value version.
object
Replacement value, limited to 64 KiB in UTF-8. It is stored without transformation and never returned.
Expected concurrency token.
Examplegenerated
{ "Value": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “Responses”OK
object
Write-only managed-secret metadata. No value, ciphertext, hash, length, or hint is exposed.
object
Secret identifier.
Immutable lookup key.
Value version.
Whether trusted C# may resolve the secret.
Terminal retirement timestamp.
Creation timestamp.
Last modification timestamp.
Creating actor identifier.
Last modifying actor identifier.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Write-only managed-secret metadata. No value, ciphertext, hash, length, or hint is exposed.
object
Secret identifier.
Immutable lookup key.
Value version.
Whether trusted C# may resolve the secret.
Terminal retirement timestamp.
Creation timestamp.
Last modification timestamp.
Creating actor identifier.
Last modifying actor identifier.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Write-only managed-secret metadata. No value, ciphertext, hash, length, or hint is exposed.
object
Secret identifier.
Immutable lookup key.
Value version.
Whether trusted C# may resolve the secret.
Terminal retirement timestamp.
Creation timestamp.
Last modification timestamp.
Creating actor identifier.
Last modifying actor identifier.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Write-only managed-secret metadata. No value, ciphertext, hash, length, or hint is exposed.
object
Secret identifier.
Immutable lookup key.
Value version.
Whether trusted C# may resolve the secret.
Terminal retirement timestamp.
Creation timestamp.
Last modification timestamp.
Creating actor identifier.
Last modifying actor identifier.
Optimistic concurrency token.
object
object
object
object
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Content Too Large
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}