Update

Update an integration by integration id

Authorizations

Authorization

string

header

required

An access token in Infisical

Path Parameters

integrationId

string

required

The ID of the integration object.

Body

application/json

isActive

boolean

required

Whether the integration should be active or disabled.

app

string

The name of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations.

appId

string

The ID of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations.

environment

string

The environment to sync secrets from.

metadata

object

Show child attributes

metadata.githubVisibility

Define where the secrets from the Github Integration should be visible. Option 'selected' lets you directly define which repositories to sync secrets to.

Available options:

selected

metadata.githubVisibilityRepoIds

string[]

The repository IDs to sync secrets to when using the Github Integration. Only applicable when using Organization scope, and visibility is set to 'selected'.

metadata.initialSyncBehavior

string

Type of syncing behavoir with the integration.

metadata.kmsKeyId

string

The ID of the encryption key from AWS KMS.

metadata.mappingBehavior

enum<string>

The mapping behavior of the integration.

Available options:

one-to-one,

many-to-one

metadata.octopusDeployScopeValues

object

Specifies the scope values to set on synced secrets to Octopus Deploy.

Show child attributes

metadata.octopusDeployScopeValues.Action

string[]

metadata.octopusDeployScopeValues.Channel

string[]

metadata.octopusDeployScopeValues.Environment

string[]

metadata.octopusDeployScopeValues.Machine

string[]

metadata.octopusDeployScopeValues.ProcessOwner

string[]

metadata.octopusDeployScopeValues.Role

string[]

metadata.secretAWSTag

object[]

The tags for AWS secrets.

Show child attributes

metadata.secretAWSTag.key

string

required

metadata.secretAWSTag.value

string

required

metadata.secretGCPLabel

object

The label for GCP secrets.

Show child attributes

metadata.secretGCPLabel.labelName

string

required

metadata.secretGCPLabel.labelValue

string

required

metadata.secretPrefix

string

The prefix for the saved secret. Used by GCP.

metadata.secretSuffix

string

The suffix for the saved secret. Used by GCP.

metadata.shouldAutoRedeploy

boolean

Used by Render to trigger auto deploy.

metadata.shouldDisableDelete

boolean

The flag to disable deletion of secrets in AWS Parameter Store.

metadata.shouldEnableDelete

boolean

The flag to enable deletion of secrets.

metadata.shouldMaskSecrets

boolean

Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Masked'.

metadata.shouldProtectSecrets

boolean

Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Protected'.

owner

string

External integration providers service entity owner. Used in Github.

path

string

Path to save the synced secrets. Used by Gitlab, AWS Parameter Store, Vault.

region

string

AWS region to sync secrets to.

secretPath

string

default:

/

The path of the secrets to sync secrets from.

targetEnvironment

string

The target environment of the integration provider. Used in cloudflare pages, TeamCity, Gitlab integrations.

Response

200 - application/json

integration

object

required

Show child attributes

integration.createdAt

string

required

integration.envId

string

required

integration.environment

object

required

Show child attributes

integration.environment.id

string

required

integration.environment.name

string

required

integration.environment.slug

string

required

integration.id

string

required

integration.integration

string

required

integration.integrationAuthId

string

required

integration.isActive

boolean

required

integration.updatedAt

string

required

integration.app

string | null

integration.appId

string | null

integration.isSynced

boolean | null

integration.lastSyncJobId

string | null

integration.lastUsed

string | null

integration.metadata

any | null

integration.owner

string | null

integration.path

string | null

integration.region

string | null

integration.scope

string | null

integration.secretPath

string

default:

/

integration.syncMessage

string | null

integration.targetEnvironment

string | null

integration.targetEnvironmentId

string | null

integration.targetService

string | null

integration.targetServiceId

string | null

integration.url

string | null