Overview
- Introduction
- Authentication
- Examples
Endpoints
- Identities
- Token Auth
- Universal Auth
- GCP Auth
- AWS Auth
- Azure Auth
- Kubernetes Auth
- OIDC Auth
- JWT Auth
- LDAP Auth
- Groups
- Organizations
- Projects
- Project Users
- Project Groups
- Project Identities
- Project Roles
- Project Templates
- Environments
- Folders
- Secret Tags
- Secrets
- Dynamic Secrets
- Secret Imports
- Secret Rotations
- Identity Specific Privilege
- App Connections
- Secret Syncs
- Integrations
- Service Tokens
- Audit Logs
Infisical PKI
- Subscribers
- Certificate Authorities
- Certificates
- Certificate Templates
- Certificate Collections
- PKI Alerting
Infisical SSH
- Hosts
- Host Groups
- Certificates
- Certificate Authorities
- Certificate Templates
Infisical KMS
- Keys
- Encryption
- Signing
Integrations
Update
Update an integration by integration id
PATCH
/
api
/
v1
/
integration
/
{integrationId}
curl --request PATCH \
--url https://us.infisical.com/api/v1/integration/{integrationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"app": "<string>",
"appId": "<string>",
"isActive": true,
"secretPath": "/",
"targetEnvironment": "<string>",
"owner": "<string>",
"environment": "<string>",
"path": "<string>",
"metadata": {
"initialSyncBehavior": "<string>",
"secretPrefix": "<string>",
"secretSuffix": "<string>",
"mappingBehavior": "one-to-one",
"shouldAutoRedeploy": true,
"secretGCPLabel": {
"labelName": "<string>",
"labelValue": "<string>"
},
"secretAWSTag": [
{
"key": "<string>",
"value": "<string>"
}
],
"azureLabel": "<string>",
"githubVisibility": "selected",
"githubVisibilityRepoIds": [
"<string>"
],
"kmsKeyId": "<string>",
"shouldDisableDelete": true,
"shouldEnableDelete": true,
"shouldMaskSecrets": true,
"shouldProtectSecrets": true,
"metadataSyncMode": "custom",
"octopusDeployScopeValues": {
"Environment": [
"<string>"
],
"Action": [
"<string>"
],
"Channel": [
"<string>"
],
"Machine": [
"<string>"
],
"ProcessOwner": [
"<string>"
],
"Role": [
"<string>"
]
}
},
"region": "<string>"
}'
{
"integration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isActive": true,
"url": "<string>",
"app": "<string>",
"appId": "<string>",
"targetEnvironment": "<string>",
"targetEnvironmentId": "<string>",
"targetService": "<string>",
"targetServiceId": "<string>",
"owner": "<string>",
"path": "<string>",
"region": "<string>",
"scope": "<string>",
"integration": "<string>",
"metadata": "<any>",
"integrationAuthId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"envId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secretPath": "/",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastUsed": "2023-11-07T05:31:56Z",
"isSynced": true,
"syncMessage": "<string>",
"lastSyncJobId": "<string>",
"environment": {
"slug": "<string>",
"name": "<string>",
"id": "<string>"
}
}
}
Authorizations
An access token in Infisical
Path Parameters
The ID of the integration object.
Body
application/json
Response
200
application/json
Default Response
The response is of type object
.
Was this page helpful?
curl --request PATCH \
--url https://us.infisical.com/api/v1/integration/{integrationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"app": "<string>",
"appId": "<string>",
"isActive": true,
"secretPath": "/",
"targetEnvironment": "<string>",
"owner": "<string>",
"environment": "<string>",
"path": "<string>",
"metadata": {
"initialSyncBehavior": "<string>",
"secretPrefix": "<string>",
"secretSuffix": "<string>",
"mappingBehavior": "one-to-one",
"shouldAutoRedeploy": true,
"secretGCPLabel": {
"labelName": "<string>",
"labelValue": "<string>"
},
"secretAWSTag": [
{
"key": "<string>",
"value": "<string>"
}
],
"azureLabel": "<string>",
"githubVisibility": "selected",
"githubVisibilityRepoIds": [
"<string>"
],
"kmsKeyId": "<string>",
"shouldDisableDelete": true,
"shouldEnableDelete": true,
"shouldMaskSecrets": true,
"shouldProtectSecrets": true,
"metadataSyncMode": "custom",
"octopusDeployScopeValues": {
"Environment": [
"<string>"
],
"Action": [
"<string>"
],
"Channel": [
"<string>"
],
"Machine": [
"<string>"
],
"ProcessOwner": [
"<string>"
],
"Role": [
"<string>"
]
}
},
"region": "<string>"
}'
{
"integration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isActive": true,
"url": "<string>",
"app": "<string>",
"appId": "<string>",
"targetEnvironment": "<string>",
"targetEnvironmentId": "<string>",
"targetService": "<string>",
"targetServiceId": "<string>",
"owner": "<string>",
"path": "<string>",
"region": "<string>",
"scope": "<string>",
"integration": "<string>",
"metadata": "<any>",
"integrationAuthId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"envId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"secretPath": "/",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastUsed": "2023-11-07T05:31:56Z",
"isSynced": true,
"syncMessage": "<string>",
"lastSyncJobId": "<string>",
"environment": {
"slug": "<string>",
"name": "<string>",
"id": "<string>"
}
}
}