Boomi Platform API Reference (1.0.0) - RefreshSecretsManager

Toggle Pane

• RefreshSecretsManager
  • postRefreshes the secrets caching

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

RefreshSecretsManager

Your secrets are never stored in the file system and are constrained to an individual Java classloader. These cached secrets are only stored for one hour, and do not persist between restarts, the creation of a new execution worker, or the creation of a new forked process execution.

To coordinate the caching of secrets with your secret rotation practices, the refreshSecretsManager API allows you to reset the secret cache on all runtimes in an account. This ensures that the runtimes in your account directly retrieve secrets from the external secrets manager the next time the secret is referenced.

Refreshes the secrets caching

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

provider

string Enum: "AWS" "AZURE" "GCP"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

message

string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/refreshSecretsManager

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SecretsManagerRefreshRequest",
• "provider": "AWS"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "SecretsManagerRefreshResponse",
• "message": "AWS Secrets Manager refresh messages have been sent to all containers in <YOUR-ACCOUNT-ID>"

}