Update AWS Certificate Manager PKI Sync

Update the specified AWS Certificate Manager PKI Sync.

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

cURL

cURL

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

import requests

url = "https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "isAutoSyncEnabled": True,
    "syncOptions": {
        "canImportCertificates": False,
        "canRemoveCertificates": True,
        "includeRootCa": False,
        "preserveArn": True,
        "certificateNameSchema": "<string>"
    },
    "subscriberId": "<string>",
    "connectionId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    isAutoSyncEnabled: true,
    syncOptions: {
      canImportCertificates: false,
      canRemoveCertificates: true,
      includeRootCa: false,
      preserveArn: true,
      certificateNameSchema: '<string>'
    },
    subscriberId: '<string>',
    connectionId: '<string>'
  })
};

fetch('https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'isAutoSyncEnabled' => true,
    'syncOptions' => [
        'canImportCertificates' => false,
        'canRemoveCertificates' => true,
        'includeRootCa' => false,
        'preserveArn' => true,
        'certificateNameSchema' => '<string>'
    ],
    'subscriberId' => '<string>',
    'connectionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true,\n  \"syncOptions\": {\n    \"canImportCertificates\": false,\n    \"canRemoveCertificates\": true,\n    \"includeRootCa\": false,\n    \"preserveArn\": true,\n    \"certificateNameSchema\": \"<string>\"\n  },\n  \"subscriberId\": \"<string>\",\n  \"connectionId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true,\n  \"syncOptions\": {\n    \"canImportCertificates\": false,\n    \"canRemoveCertificates\": true,\n    \"includeRootCa\": false,\n    \"preserveArn\": true,\n    \"certificateNameSchema\": \"<string>\"\n  },\n  \"subscriberId\": \"<string>\",\n  \"connectionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true,\n  \"syncOptions\": {\n    \"canImportCertificates\": false,\n    \"canRemoveCertificates\": true,\n    \"includeRootCa\": false,\n    \"preserveArn\": true,\n    \"certificateNameSchema\": \"<string>\"\n  },\n  \"subscriberId\": \"<string>\",\n  \"connectionId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "destination": "aws-certificate-manager",
  "isAutoSyncEnabled": true,
  "destinationConfig": {},
  "syncOptions": {
    "canImportCertificates": false,
    "canRemoveCertificates": true,
    "includeRootCa": false,
    "preserveArn": true,
    "certificateNameSchema": "<string>"
  },
  "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"
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

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-certificate-manager

isAutoSyncEnabled · boolean · required

destinationConfig · object · required

Show child attributes

syncOptions · object · required

Show child attributes

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