Create - 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

POST

api

integration

object

integrationAuthId

string

app

string

isActive

boolean

appId

string

secretPath

string

sourceEnvironment

string

targetEnvironment

string

targetEnvironmentId

string

targetService

string

targetServiceId

string

owner

string

url

string

path

string

region

string

scope

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

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

headerrequired

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

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.

Response

200 - application/json

integration

object

required

Was this page helpful?

Delete Auth By ID Update

Overview

Endpoints

Infisical PKI

Infisical SSH

Infisical KMS

​Integration Parameters

Authorizations

Body

Response

Integration Parameters