v1

latestOpenAPI 3.1.0proprietary2026-07-24156175241.3 KB

AWS Secrets Manager Accounts

Test AWS Secrets Manager Connection

Test that OneSchema can authenticate via the configured IAM role and retrieve a specific secret. The secret value is not returned.

post/v0/aws-secrets-manager/accounts/{account-id}/test

Path parameters

account-idinteger required

The ID of the AWS Secrets Manager account

Request body

secret_identifierstring required

The identifier of the secret to test retrieval for

regionstring required

The AWS region where the secret is stored

secret_versionstring nullable

A specific version ID or stage label

version_kind'id' | 'stage'

Selects whether secret_version is treated as a VersionId or VersionStage for AWS GetSecretValue

Response

Test result (check the success field)

successboolean

error_codestring

Present when success is false

error_category'account' | 'secret' | 'provider'

Broad classification of the failure. "account" means the account credentials or permissions are wrong; "secret" means the secret identifier or version could not be found; "provider" means a transient infrastructure issue. Present when success is false.

error_messagestring

Present when success is false

request_idstring

transaction_idstring