Update AWS Secrets Manager PKI Sync

Update the specified AWS Secrets Manager PKI Sync.

PATCH /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}

cURL

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isAutoSyncEnabled": true,
  "syncOptions": {
    "canImportCertificates": false,
    "canRemoveCertificates": true,
    "includeRootCa": false,
    "preserveSecretOnRenewal": true,
    "updateExistingCertificates": true,
    "certificateNameSchema": "<string>",
    "fieldMappings": {
      "certificate": "certificate",
      "privateKey": "private_key",
      "certificateChain": "certificate_chain",
      "caCertificate": "ca_certificate"
    }
  },
  "subscriberId": "<string>",
  "connectionId": "<string>"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "isAutoSyncEnabled": true,
  "destinationConfig": {
    "keyId": "<string>"
  },
  "syncOptions": {
    "canImportCertificates": false,
    "canRemoveCertificates": true,
    "includeRootCa": false,
    "preserveSecretOnRenewal": true,
    "updateExistingCertificates": true,
    "certificateNameSchema": "<string>",
    "fieldMappings": {
      "certificate": "certificate",
      "privateKey": "private_key",
      "certificateChain": "certificate_chain",
      "caCertificate": "ca_certificate"
    }
  },
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "subscriberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "syncStatus": "<string>",
  "lastSyncedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

pkiSyncId · string · required

Body

application/json

name · string

Required string length: 1 - 256

description · string

isAutoSyncEnabled · boolean

destinationConfig · object

Show child attributes

syncOptions · object

Show child attributes

subscriberId · string | null

connectionId · string

Response

200

application/json

Default Response

id · string<uuid> · required

name · string · required

Maximum string length: 256

destination · enum<string> · required

Available options: aws-secrets-manager

isAutoSyncEnabled · boolean · required

destinationConfig · object · required

Show child attributes

syncOptions · object · required

Show child attributes

projectId · string<uuid> · required

connectionId · string<uuid> · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

description · string | null

subscriberId · string<uuid> | null

syncStatus · string | null

lastSyncedAt · string<date-time> | null