Skip to main content
POST
/
api
/
v1
/
secret-syncs
/
github
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/secret-syncs/github \
  --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": "organization",
    "org": "<string>",
    "visibility": "all",
    "selectedRepositoryIds": [
      123
    ]
  },
  "description": "<string>",
  "isAutoSyncEnabled": true
}
'
{
  "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": "github",
      "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": "github",
    "destinationConfig": {
      "scope": "organization",
      "org": "<string>",
      "visibility": "all",
      "selectedRepositoryIds": [
        123
      ]
    },
    "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"
  }
}

Body

application/json
​
name
string
required

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

Required string length: 1 - 64
​
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 GitHub 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
  • Option 1
  • Option 2
  • Option 3
​
description
string | null

An optional description for the GitHub 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
GitHub · object
required