AWS Secrets Manager
Amazon Web Services Secrets Manager Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets. This guide…
Identity & security#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services Secrets Manager
Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this
service, see the Amazon Web Services Secrets Manager User Guide .
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
For a list of endpoints, see Amazon Web Services Secrets Manager
endpoints .
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com , or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum . For more
information about the Amazon Web Services Discussion Forums, see Forums
Help .
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
account and delivers log files to an Amazon S3 bucket. By using information that's collected
by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
CloudTrail, see Logging
Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide .
To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide .
Endpoints 26
- POSTAssociate cross account replica
/#X-Amz-Target=secretsmanager.AssociateCrossAccountReplicaLinks a primary secret in your account to a replica secret in a different Amazon Web Services account and starts replication to this replica. The replica… - POSTBatch get secret value
/#X-Amz-Target=secretsmanager.BatchGetSecretValueRetrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue . To choose… - POSTCancel rotate secret
/#X-Amz-Target=secretsmanager.CancelRotateSecretTurns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. If you cancel a rotation in progress, it can leave the… - POSTCreate secret
/#X-Amz-Target=secretsmanager.CreateSecretCreates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you… - POSTDelete resource policy
/#X-Amz-Target=secretsmanager.DeleteResourcePolicyDeletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy . Secrets Manager generates a… - POSTDelete secret
/#X-Amz-Target=secretsmanager.DeleteSecretDeletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days.… - POSTDescribe secret
/#X-Amz-Target=secretsmanager.DescribeSecretRetrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response. The… - POSTDisassociate cross account replica
/#X-Amz-Target=secretsmanager.DisassociateCrossAccountReplicaRemoves the link between a primary secret in your account and a cross-account replica secret, and stops replication to the replica secret. Call this operation… - POSTGet random password
/#X-Amz-Target=secretsmanager.GetRandomPasswordGenerates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password… - POSTGet resource policy
/#X-Amz-Target=secretsmanager.GetResourcePolicyRetrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret,… - POSTGet secret value
/#X-Amz-Target=secretsmanager.GetSecretValueRetrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. To retrieve… - POSTList resource policies
/#X-Amz-Target=secretsmanager.ListResourcePoliciesLists the resource-based policies attached to a secret. The response contains only the names of the policies, not their contents. Secrets Manager lists… - POSTList secret version ids
/#X-Amz-Target=secretsmanager.ListSecretVersionIdsLists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager… - POSTList secrets
/#X-Amz-Target=secretsmanager.ListSecretsLists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets… - POSTPut resource policy
/#X-Amz-Target=secretsmanager.PutResourcePolicyAttaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for… - POSTPut secret value
/#X-Amz-Target=secretsmanager.PutSecretValueCreates a new version of your secret by creating a new encrypted value and attaching it to the secret. version can contain a new SecretString value or a new… - POSTRemove regions from replication
/#X-Amz-Target=secretsmanager.RemoveRegionsFromReplicationFor a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. Secrets Manager generates a CloudTrail log entry… - POSTReplicate secret to regions
/#X-Amz-Target=secretsmanager.ReplicateSecretToRegionsReplicates the secret to a new Regions. See Multi-Region secrets . Secrets Manager generates a CloudTrail log entry when you call this action. Do not include… - POSTRestore secret
/#X-Amz-Target=secretsmanager.RestoreSecretCancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored. Secrets Manager… - POSTRotate secret
/#X-Amz-Target=secretsmanager.RotateSecretConfigures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide .… - POSTStop replication to replica
/#X-Amz-Target=secretsmanager.StopReplicationToReplicaRemoves the link between a replica secret and its primary secret, and stops replication to the replica. You call this operation from the replica account or… - POSTTag resource
/#X-Amz-Target=secretsmanager.TagResourceAttaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of… - POSTUntag resource
/#X-Amz-Target=secretsmanager.UntagResourceRemoves specific tags from a secret. This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret… - POSTUpdate secret
/#X-Amz-Target=secretsmanager.UpdateSecretModifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue . To change the… - POSTUpdate secret version stage
/#X-Amz-Target=secretsmanager.UpdateSecretVersionStageModifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret… - POSTValidate resource policy
/#X-Amz-Target=secretsmanager.ValidateResourcePolicyValidates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets. The API…
API details
- Base URL
https://secretsmanager.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 26 operations on 26 pathsPOST 26
- Description format
- AWS Smithy model, API version
2017-10-17 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Secrets Manager in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Secrets Manager collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate cross account replica” (POST /#X-Amz-Target=secretsmanager.AssociateCrossAccountReplica), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Secrets Manager?
Amazon Web Services Secrets Manager Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets. This guide… It is listed under Identity & security and has 26 endpoints.
Who publishes the AWS Secrets Manager?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Secrets Manager?
Requests go to https://secretsmanager.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Secrets Manager?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Secrets Manager have?
26 operations on 26 paths (26 POST).
Is forking the AWS Secrets Manager free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.