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

​
Authorization
string
header
required

An access token in Infisical

Path Parameters

​
integrationId
string
required

The ID of the integration object.

Body

application/json
​
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.

​
isActive
boolean

Whether the integration should be active or disabled.

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

​
owner
string

External integration providers service entity owner. Used in Github.

​
environment
string

The environment to sync secrets from.

​
path
string

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

​
metadata
object
​
region
string

AWS region to sync secrets to.

Response

200
application/json
Default Response
​
integration
object
required

Was this page helpful?

Suggest editsRaise issue
CreateDelete