Skip to main content
POST
/
api
/
v1
/
secret-syncs
/
humanitec
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/secret-syncs/humanitec \
  --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
  },
  "destinationConfig": {
    "scope": "application",
    "org": "<string>",
    "app": "<string>"
  },
  "description": "<string>",
  "isAutoSyncEnabled": true
}
'
import requests

url = "https://us.infisical.com/api/v1/secret-syncs/humanitec"

payload = {
    "name": "<string>",
    "projectId": "<string>",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment": "<string>",
    "secretPath": "<string>",
    "syncOptions": {
        "initialSyncBehavior": "overwrite-destination",
        "keySchema": "<string>",
        "disableSecretDeletion": True
    },
    "destinationConfig": {
        "scope": "application",
        "org": "<string>",
        "app": "<string>"
    },
    "description": "<string>",
    "isAutoSyncEnabled": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    projectId: '<string>',
    connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    environment: '<string>',
    secretPath: '<string>',
    syncOptions: {
      initialSyncBehavior: 'overwrite-destination',
      keySchema: '<string>',
      disableSecretDeletion: true
    },
    destinationConfig: {scope: 'application', org: '<string>', app: '<string>'},
    description: '<string>',
    isAutoSyncEnabled: true
  })
};

fetch('https://us.infisical.com/api/v1/secret-syncs/humanitec', 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/secret-syncs/humanitec",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'projectId' => '<string>',
    'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'environment' => '<string>',
    'secretPath' => '<string>',
    'syncOptions' => [
        'initialSyncBehavior' => 'overwrite-destination',
        'keySchema' => '<string>',
        'disableSecretDeletion' => true
    ],
    'destinationConfig' => [
        'scope' => 'application',
        'org' => '<string>',
        'app' => '<string>'
    ],
    'description' => '<string>',
    'isAutoSyncEnabled' => true
  ]),
  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/secret-syncs/humanitec"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"syncOptions\": {\n    \"initialSyncBehavior\": \"overwrite-destination\",\n    \"keySchema\": \"<string>\",\n    \"disableSecretDeletion\": true\n  },\n  \"destinationConfig\": {\n    \"scope\": \"application\",\n    \"org\": \"<string>\",\n    \"app\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true\n}")

	req, _ := http.NewRequest("POST", 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.post("https://us.infisical.com/api/v1/secret-syncs/humanitec")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"syncOptions\": {\n    \"initialSyncBehavior\": \"overwrite-destination\",\n    \"keySchema\": \"<string>\",\n    \"disableSecretDeletion\": true\n  },\n  \"destinationConfig\": {\n    \"scope\": \"application\",\n    \"org\": \"<string>\",\n    \"app\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/secret-syncs/humanitec")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environment\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"syncOptions\": {\n    \"initialSyncBehavior\": \"overwrite-destination\",\n    \"keySchema\": \"<string>\",\n    \"disableSecretDeletion\": true\n  },\n  \"destinationConfig\": {\n    \"scope\": \"application\",\n    \"org\": \"<string>\",\n    \"app\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"isAutoSyncEnabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "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
    },
    "connection": {
      "app": "humanitec",
      "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": "humanitec",
    "destinationConfig": {
      "scope": "application",
      "org": "<string>",
      "app": "<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"
  }
}
{
  "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>"
}

Body

application/json
​
name
string
required

The name of the Humanitec Sync to create. Must be slug-friendly.

Required string length: 1 - 256
​
projectId
string
required

The ID of the project to create the sync in.

Minimum string length: 1
​
connectionId
string<uuid>
required

The ID of the Humanitec 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 string length: 1
​
syncOptions
object
required

Optional parameters to modify how secrets are synced.

​
destinationConfig
object
required
​
description
string | null

An optional description for the Humanitec Sync.

Maximum string length: 256
​
isAutoSyncEnabled
boolean
default:true

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

Response

Default Response

​
secretSync
Humanitec · object
required