POST
/
api
/
v1
/
integration
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/integration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "integrationAuthId": "<string>",
  "app": "<string>",
  "isActive": true,
  "appId": "<string>",
  "secretPath": "/",
  "sourceEnvironment": "<string>",
  "targetEnvironment": "<string>",
  "targetEnvironmentId": "<string>",
  "targetService": "<string>",
  "targetServiceId": "<string>",
  "owner": "<string>",
  "url": "<string>",
  "path": "<string>",
  "region": "<string>",
  "scope": "<string>",
  "metadata": {}
}'
{
  "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>"
    }
  }
}

​
Integration Parameters

The integration creation endpoint is generic and can be used for all native integrations. For specific integration parameters for a given service, please review the respective documentation below.
​
integrationAuthId
string
required
The ID of the integration auth object for authentication with AWS. Refer Create Integration Auth for more info
​
isActive
boolean
Whether the integration should be active or inactive
​
app
string
required
The secret name used when saving secret in AWS SSM. Used for naming and can be arbitrary.
​
region
string
required
The AWS region of the SSM. Example: us-east-1
​
sourceEnvironment
string
required
The Infisical environment slug from where secrets will be synced from. Example: dev
​
secretPath
string
required
The Infisical folder path from where secrets will be synced from. Example: /some/path. The root of the environment is /.

Authorizations

​
Authorization
string
header
required

An access token in Infisical

Body

application/json
​
integrationAuthId
string
required

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

​
sourceEnvironment
string
required

The environment to sync secret from.

​
app
string

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

​
isActive
boolean
default:true

Whether the integration should be active or disabled.

​
appId
string

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

​
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.

​
targetEnvironmentId
string

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

​
targetService
string

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

​
targetServiceId
string

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

​
owner
string

External integration providers service entity owner. Used in Github.

​
url
string

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

​
path
string

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

​
region
string

AWS region to sync secrets to.

​
scope
string

Scope of the provider. Used by Github, Qovery.

​
metadata
object

Response

Default Response

​
integration
object
required