Overview
- Introduction
- Authentication
- Examples
Endpoints
- Identities
- Token Auth
- Universal Auth
- GCP Auth
- AWS Auth
- Azure Auth
- Kubernetes Auth
- OIDC Auth
- JWT Auth
- Groups
- Organizations
- Projects
- Project Users
- Project Groups
- Project Identities
- Project Roles
- Project Templates
- Environments
- Folders
- Secret Tags
- Secrets
- Dynamic Secrets
- Secret Imports
- Identity Specific Privilege
- App Connections
- Secret Syncs
- GETList
- GETOptions
- AWS Parameter Store
- AWS Secrets Manager
- Azure App Configuration
- Azure Key Vault
- Databricks
- GCP Secret Manager
- GitHub
- GET
- Integrations
- Service Tokens
- Audit Logs
Infisical PKI
- Certificate Authorities
- Certificates
- Certificate Templates
- Certificate Collections
- PKI Alerting
Infisical SSH
- Certificates
- Certificate Authorities
- Certificate Templates
Infisical KMS
- Keys
GitHub
Get by ID
Get the specified GitHub Sync by ID.
GET
/
api
/
v1
/
secret-syncs
/
github
/
{syncId}
curl --request GET \
--url https://us.infisical.com/api/v1/secret-syncs/github/{syncId}
{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isAutoSyncEnabled": true,
"version": 1,
"projectId": "<string>",
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"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",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination"
},
"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
]
}
}
}
Path Parameters
The ID of the GitHub Sync to retrieve.
Response
200
application/json
Default Response
Specify how Infisical should resolve the initial sync to the GitHub destination.
Available options:
overwrite-destination
Available options:
github
The GitHub scope that secrets should be synced to
Available options:
organization
The name of the GitHub organization.
Minimum length:
1
Available options:
all
, private
, selected
Was this page helpful?
curl --request GET \
--url https://us.infisical.com/api/v1/secret-syncs/github/{syncId}
{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isAutoSyncEnabled": true,
"version": 1,
"projectId": "<string>",
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"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",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination"
},
"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
]
}
}
}