Update - Infisical

Overview

Endpoints

Identities
Token Auth
Universal Auth
GCP Auth
AWS Auth
Azure Auth
Kubernetes Auth
OIDC Auth
JWT Auth
Groups
Organizations
Projects
Project Users
Project Groups
Project Identities
Project Roles
Project Templates
Environments
Folders
Secret Tags
Secrets
Dynamic Secrets
Secret Imports
Identity Specific Privilege
Integrations
- POST
  Create Auth
- GET
  List Auth
- GET
  Get Auth By ID
- DEL
  Delete Auth
- DEL
  Delete Auth By ID
- POST
  Create
- PATCH
  Update
- DEL
  Delete
- GET
  List Project Integrations
Service Tokens
Audit Logs

Infisical PKI

Certificate Authorities
Certificates
Certificate Templates
Certificate Collections
PKI Alerting

Infisical SSH

Certificates
Certificate Authorities
Certificate Templates

Infisical KMS

Keys

PATCH

api

integration

{integrationId}

object

app

string

appId

string

isActive

boolean

secretPath

string

targetEnvironment

string

owner

string

environment

string

path

string

metadata

object

initialSyncBehavior

string

secretPrefix

string

secretSuffix

string

mappingBehavior

enum<string>

shouldAutoRedeploy

boolean

secretGCPLabel

object

labelName

string

labelValue

string

secretAWSTag

array

azureLabel

string

githubVisibility

Option 1 · enum<string>

githubVisibilityRepoIds

array

kmsKeyId

string

shouldDisableDelete

boolean

shouldEnableDelete

boolean

shouldMaskSecrets

boolean

shouldProtectSecrets

boolean

octopusDeployScopeValues

object

Environment

array

Action

array

Channel

array

Machine

array

ProcessOwner

array

Role

array

region

string

Authorizations

Authorization

string

headerrequired

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.

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

metadata.initialSyncBehavior

string

Type of syncing behavoir with the integration.

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

enum<string>

The mapping behavior of the integration.

Available options:

one-to-one,

many-to-one

metadata.shouldAutoRedeploy

boolean

Used by Render to trigger auto deploy.

metadata.secretGCPLabel

object

The label for GCP secrets.

metadata.secretAWSTag

object[]

The tags for AWS secrets.

metadata.azureLabel

string

Define which label to assign to secrets created in Azure App Configuration.

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

string

The ID of the encryption key from AWS KMS.

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

metadata.octopusDeployScopeValues

object

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

region

string

AWS region to sync secrets to.

Response

200 - application/json

integration

object

required

Was this page helpful?

Create Delete