POST
/
api
/
v1
/
secret-syncs
/
azure-key-vault
curl --request POST \
  --url https://us.infisical.com/api/v1/secret-syncs/azure-key-vault \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "projectId": "<string>",
  "description": "<string>",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment": "<string>",
  "secretPath": "<string>",
  "isAutoSyncEnabled": true,
  "syncOptions": {
    "initialSyncBehavior": "overwrite-destination",
    "disableSecretDeletion": true
  },
  "destinationConfig": {
    "vaultBaseUrl": "<string>"
  }
}'
{
  "secretSync": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "isAutoSyncEnabled": true,
    "version": 1,
    "projectId": "<string>",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "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",
    "syncOptions": {
      "initialSyncBehavior": "overwrite-destination",
      "disableSecretDeletion": true
    },
    "connection": {
      "app": "azure-key-vault",
      "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": "azure-key-vault",
    "destinationConfig": {
      "vaultBaseUrl": "<string>"
    }
  }
}

Body

application/json
name
string
required

The name of the Azure Key Vault Sync to create. Must be slug-friendly.

Required string length: 1 - 32
projectId
string
required

The ID of the project to create the sync in.

Minimum length: 1
connectionId
string
required

The ID of the Azure Key Vault Connection to use for syncing.

environment
string
required

The slug of the project environment to sync secrets from.

Required string length: 1 - 64
secretPath
string
required

The folder path to sync secrets from.

Minimum length: 1
syncOptions
object
required

Optional parameters to modify how secrets are synced.

destinationConfig
object
required
description
string | null

An optional description for the Azure Key Vault Sync.

Maximum length: 256
isAutoSyncEnabled
boolean
default:true

Whether secrets should be automatically synced when changes occur at the source location or not.

Response

200
application/json
Default Response
secretSync
object
required