Integrations

Changed on

Create an integration to sync secrets. Deprecated: use Secret Syncs instead.

post/api/v1/integration

Request

  • Base URL
    https://us.infisical.com
  • URL
    https://us.infisical.com/api/v1/integration
  • Auth
    HTTP bearer

Request body

integrationAuthIdstring required

The ID of the integration auth object to link with integration.

appstring

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

isActiveboolean

Whether the integration should be active or disabled.

appIdstring

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

secretPathstring

The path of the secrets to sync secrets from.

sourceEnvironmentstring required

The environment to sync secret from.

targetEnvironmentstring

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

targetEnvironmentIdstring

The target environment ID of the integration provider. Used in cloudflare pages, teamcity, gitlab integrations.

targetServicestring

The service based grouping identifier of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank.

targetServiceIdstring

The service based grouping identifier ID of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank.

ownerstring

External integration providers service entity owner. Used in Github.

urlstring uri

The self-hosted URL of the platform to integrate with.

pathstring

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

regionstring

AWS region to sync secrets to.

scopestring

Scope of the provider. Used by Github, Qovery.

Response

Default Response

Changes