Overview
Organization
Project
Shared
Identity Auth
Secrets Management
Infisical PKI
Secret Scanning
Infisical SSH
Infisical KMS
Other
curl --request POST \
--url https://us.infisical.com/api/v1/secret-syncs/aws-secrets-manager \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"projectId": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "<string>",
"secretPath": "<string>",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"keySchema": "<string>",
"disableSecretDeletion": true,
"keyId": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"syncSecretMetadataAsTags": true
},
"destinationConfig": {
"mappingBehavior": "one-to-one",
"region": "us-east-1"
},
"description": "<string>",
"isAutoSyncEnabled": true
}
'{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"projectId": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"keySchema": "<string>",
"disableSecretDeletion": true,
"keyId": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"syncSecretMetadataAsTags": true
},
"connection": {
"app": "aws",
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"slug": "<string>",
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"folder": {
"id": "<string>",
"path": "<string>"
},
"destination": "aws-secrets-manager",
"destinationConfig": {
"mappingBehavior": "one-to-one",
"region": "us-east-1"
},
"description": "<string>",
"isAutoSyncEnabled": true,
"version": 1,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"syncStatus": "<string>",
"lastSyncJobId": "<string>",
"lastSyncMessage": "<string>",
"lastSyncedAt": "2023-11-07T05:31:56Z",
"importStatus": "<string>",
"lastImportJobId": "<string>",
"lastImportMessage": "<string>",
"lastImportedAt": "2023-11-07T05:31:56Z",
"removeStatus": "<string>",
"lastRemoveJobId": "<string>",
"lastRemoveMessage": "<string>",
"lastRemovedAt": "2023-11-07T05:31:56Z"
}
}Create
Create an AWS Secrets Manager Sync for the specified project environment.
curl --request POST \
--url https://us.infisical.com/api/v1/secret-syncs/aws-secrets-manager \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"projectId": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "<string>",
"secretPath": "<string>",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"keySchema": "<string>",
"disableSecretDeletion": true,
"keyId": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"syncSecretMetadataAsTags": true
},
"destinationConfig": {
"mappingBehavior": "one-to-one",
"region": "us-east-1"
},
"description": "<string>",
"isAutoSyncEnabled": true
}
'{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"projectId": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"keySchema": "<string>",
"disableSecretDeletion": true,
"keyId": "<string>",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"syncSecretMetadataAsTags": true
},
"connection": {
"app": "aws",
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"slug": "<string>",
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"folder": {
"id": "<string>",
"path": "<string>"
},
"destination": "aws-secrets-manager",
"destinationConfig": {
"mappingBehavior": "one-to-one",
"region": "us-east-1"
},
"description": "<string>",
"isAutoSyncEnabled": true,
"version": 1,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"syncStatus": "<string>",
"lastSyncJobId": "<string>",
"lastSyncMessage": "<string>",
"lastSyncedAt": "2023-11-07T05:31:56Z",
"importStatus": "<string>",
"lastImportJobId": "<string>",
"lastImportMessage": "<string>",
"lastImportedAt": "2023-11-07T05:31:56Z",
"removeStatus": "<string>",
"lastRemoveJobId": "<string>",
"lastRemoveMessage": "<string>",
"lastRemovedAt": "2023-11-07T05:31:56Z"
}
}Body
The name of the AWS Secrets Manager Sync to create. Must be slug-friendly.
1 - 64The ID of the project to create the sync in.
1The ID of the AWS Connection to use for syncing.
The slug of the project environment to sync secrets from.
1 - 64The folder path to sync secrets from.
1Optional parameters to modify how secrets are synced.
Show child attributes
Show child attributes
Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination.
overwrite-destination, import-prioritize-source, import-prioritize-destination Specify the format to use for structuring secret keys in the AWS Secrets Manager destination.
Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing.
The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical.
1 - 256Whether Infisical secret metadata should be added as tags to secrets synced by Infisical.
- Option 1
- Option 2
Show child attributes
Show child attributes
How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one.
one-to-one The AWS region to sync secrets to.
us-east-1, us-east-2, us-west-1, us-west-2, us-gov-east-1, us-gov-west-1, af-south-1, ap-east-1, ap-south-1, ap-south-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-south-1, eu-south-2, eu-north-1, me-south-1, me-central-1, sa-east-1 An optional description for the AWS Secrets Manager Sync.
256Whether secrets should be automatically synced when changes occur at the source location or not.
Response
Default Response
Show child attributes
Show child attributes
Optional parameters to modify how secrets are synced.
Show child attributes
Show child attributes
Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination.
overwrite-destination, import-prioritize-source, import-prioritize-destination Specify the format to use for structuring secret keys in the AWS Secrets Manager destination.
Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing.
The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical.
1 - 256Whether Infisical secret metadata should be added as tags to secrets synced by Infisical.
aws-secrets-manager - Option 1
- Option 2
Show child attributes
Show child attributes
How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one.
one-to-one The AWS region to sync secrets to.
us-east-1, us-east-2, us-west-1, us-west-2, us-gov-east-1, us-gov-west-1, af-south-1, ap-east-1, ap-south-1, ap-south-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-south-1, eu-south-2, eu-north-1, me-south-1, me-central-1, sa-east-1 Was this page helpful?