curl --request GET \
--url https://us.infisical.com/api/v1/secret-syncs/github/sync-name/{syncName}{
"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"
}
}Get the specified GitHub Sync by name and project ID.
curl --request GET \
--url https://us.infisical.com/api/v1/secret-syncs/github/sync-name/{syncName}{
"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"
}
}The name of the GitHub Sync to retrieve.
1The ID of the project the GitHub Sync is associated with.
1Default Response
Show child attributes
Optional parameters to modify how secrets are synced.
Show child attributes
Specify how Infisical should resolve the initial sync to the GitHub destination.
overwrite-destination Specify the format to use for structuring secret keys in the GitHub destination.
Enable this flag to prevent removal of secrets from the GitHub destination when syncing.
github Show child attributes
The GitHub scope that secrets should be synced to
organization The name of the GitHub organization.
1all, private, selected Was this page helpful?