List

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/secret-syncs

{
  "secretSyncs": [
    {
      "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-parameter-store",
      "destinationConfig": {
        "region": "us-east-1",
        "path": "<string>"
      },
      "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"
    }
  ]
}

GET

api

secret-syncs

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/secret-syncs

{
  "secretSyncs": [
    {
      "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-parameter-store",
      "destinationConfig": {
        "region": "us-east-1",
        "path": "<string>"
      },
      "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"
    }
  ]
}

Query Parameters

projectId

string

required

The ID of the project to list Secret Syncs from.

Minimum string length: 1

Response

Default Response

secretSyncs

required

AWS Parameter Store
AWS Secrets Manager
GitHub
GCP Secret Manager
Azure Key Vault
Azure App Configuration
Azure DevOps
Databricks
Humanitec
Terraform Cloud
Camunda
Vercel
Windmill
Hashicorp Vault
TeamCity
OCI Vault
1Password
Heroku
Render
Fly.io
GitLab
Cloudflare Pages
Cloudflare Workers
Supabase
Zabbix
Railway
Checkly
Digital Ocean App Platform
Netlify
Northflank
Bitbucket
Laravel Forge
Chef

Show child attributes

secretSyncs.id

string<uuid>

required

secretSyncs.name

string

required

secretSyncs.projectId

string

required

secretSyncs.connectionId

string<uuid>

required

secretSyncs.createdAt

string<date-time>

required

secretSyncs.updatedAt

string<date-time>

required

secretSyncs.syncOptions

object

required

Optional parameters to modify how secrets are synced.

Show child attributes

secretSyncs.syncOptions.initialSyncBehavior

enum<string>

required

Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination.

Available options:

overwrite-destination,

import-prioritize-source,

import-prioritize-destination

secretSyncs.syncOptions.keySchema

string

Specify the format to use for structuring secret keys in the AWS Parameter Store destination.

secretSyncs.syncOptions.disableSecretDeletion

boolean

Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing.

secretSyncs.syncOptions.keyId

string

The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical.

Required string length: 1 - 256

secretSyncs.syncOptions.tags

object[]

Optional resource tags to add to parameters synced by Infisical.

Maximum array length: 50

Show child attributes

secretSyncs.syncOptions.tags.key

string

required

Required string length: 1 - 128

secretSyncs.syncOptions.tags.value

string

required

Maximum string length: 256

secretSyncs.syncOptions.syncSecretMetadataAsTags

boolean

Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical.

secretSyncs.connection

object

required

Show child attributes

secretSyncs.connection.app

enum<string>

required

Available options:

aws

secretSyncs.connection.name

string

required

secretSyncs.connection.id

string<uuid>

required

secretSyncs.environment

object

required

Show child attributes

secretSyncs.environment.slug

string

required

secretSyncs.environment.name

string

required

secretSyncs.environment.id

string<uuid>

required

secretSyncs.folder

object

required

Show child attributes

secretSyncs.folder.id

string

required

secretSyncs.folder.path

string

required

secretSyncs.destination

enum<string>

required

Available options:

aws-parameter-store

secretSyncs.destinationConfig

object

required

Show child attributes

secretSyncs.destinationConfig.region

enum<string>

required

The AWS region to sync secrets to.

Available options:

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

secretSyncs.destinationConfig.path

string

required

The Parameter Store path to sync secrets to.

Required string length: 1 - 2048

secretSyncs.description

string | null

secretSyncs.isAutoSyncEnabled

boolean

default:true

secretSyncs.version

number

default:1

secretSyncs.folderId

string<uuid> | null

secretSyncs.syncStatus

string | null

secretSyncs.lastSyncJobId

string | null

secretSyncs.lastSyncMessage

string | null

secretSyncs.lastSyncedAt

string<date-time> | null

secretSyncs.importStatus

string | null

secretSyncs.lastImportJobId

string | null

secretSyncs.lastImportMessage

string | null

secretSyncs.lastImportedAt

string<date-time> | null

secretSyncs.removeStatus

string | null

secretSyncs.lastRemoveJobId

string | null

secretSyncs.lastRemoveMessage

string | null

secretSyncs.lastRemovedAt

string<date-time> | null

Update Options

Overview

Organization

Project

Shared

Identity Auth

Secrets Management

Infisical PKI

Secret Scanning

Infisical SSH

Infisical KMS

Other

Query Parameters

Response